🌅 Sky

Interact with built-in Sky & Weather system.

---

🗿Static Class

This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.

💂Authority

This static class can be accessed only on 🟧 Client side.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

nanos world natively integrates Ultra Dynamic Sky, one of best Unreal Marketplace Asset Packs, it provides a dynamic sky and weather solution for games!

Through the Sky class, we expose it's methods to allow customizing it's parameters in real time!

🎒 Examples

Client/Index.lua

-- Spawns a new Ultra Dynamic Sky actor
Sky.Spawn()

-- Sets the time to 16:30
Sky.SetTimeOfDay(16, 30)

🗿 Static Functions

	Returns	Name	Description
		ChangeWeather	Changes the Weather
		DestroyAllSky	Destroys all Directional Lights, Sky Lights, Exponential Height Fogs, Volumetric Clouds, Sky Atmosphere, Ultra Dynamic Sky Actors and all Actors with the Sun Actor Tag from the Level
	integer, integer, integer	GetTimeOfDay	Gets the current time
	WeatherType	GetWeather	Gets the current weather
	boolean	IsSpawned	Returns if the Ultra Dynamic Sky was spawned
		Reconstruct	Reconstruct the Ultra Dynamic Sky Actor, forces most of the changes to be applied
		SetAnimateTimeOfDay	Sets whether or not to animate the time of day
		SetCloudCoverage	The amount of coverage for the cloud layer, from a clear sky to overcast
		SetContrast	A simple contrast boost for the sky material. Cannot affect volumetric clouds
		SetFog	The fogginess of the scene. The impact this has on fog density is scaled from the Fog Density category
		SetMoonAngle	Sets the Moon Angle
		SetMoonGlowIntensity	Sets the Moon Glow Intensity
		SetMoonLightIntensity	Sets the Moon Light Intensity
		SetMoonPhase	Sets the Moon Phase
		SetMoonScale	Sets the Moon Scale
		SetMoonTexture	Sets the Moon Texture
		SetMoonTextureRotation	Sets the Moon Texture Rotation
		SetMoonVerticalOffset	Sets the Moon Vertical Offset
		SetNightBrightness	Can be used to scale the brightness of the sky and lighting, at night
		SetOverallIntensity	The overall brightness of the shader
		SetSkyMode	Sets the Sky Mode
		SetSunAngle	Sets the Sun Angle
		SetSunLightIntensity	Sets the Sun Light Intensity
		SetSunScale	Sets the Sun Scale
		SetTimeOfDay	Sets the current time
		SetVolumetricCloudColor	Sets the Volumetric Cloud Color
		Spawn	Replaces all Sky/Sun actors with the Ultra Dynamic Sky Actor, to be able to use the functions from this page

---

ChangeWeather

Changes the Weather

Sky.ChangeWeather(weather, transition_time)

Type	Parameter	Default	Description
WeatherType	weather	Required parameter	weather to change
float	transition_time	Required parameter	fade time to completely change to new weather

---

DestroyAllSky

Destroys all Directional Lights, Sky Lights, Exponential Height Fogs, Volumetric Clouds, Sky Atmosphere, Ultra Dynamic Sky Actors and all Actors with the Sun Actor Tag from the Level

Sky.DestroyAllSky()

---

GetTimeOfDay

Gets the current time

— Returns integer, integer, integer (hours, minutes, seconds).

local ret_01, ret_02, ret_03 = Sky.GetTimeOfDay()

See also SetTimeOfDay.

---

GetWeather

Gets the current weather

— Returns WeatherType.

local ret = Sky.GetWeather()

---

IsSpawned

Returns if the Ultra Dynamic Sky was spawned

— Returns boolean.

local ret = Sky.IsSpawned(including_weather)

Type	Parameter	Default	Description
boolean	including_weather	Required parameter	if to check for Weather Actor too

---

Reconstruct

Reconstruct the Ultra Dynamic Sky Actor, forces most of the changes to be applied

Sky.Reconstruct()

---

SetAnimateTimeOfDay

Sets whether or not to animate the time of day

Sky.SetAnimateTimeOfDay(animate, day_length?, night_length?)

Type	Parameter	Default	Description
boolean	animate	Required parameter	Whether or not to animate the time of day
float or nil	day_length?	30.0	The time (in minutes) from sunrise to sunset
float or nil	night_length?	15.0	The time (in minutes) from sunset to sunrise

---

SetCloudCoverage

The amount of coverage for the cloud layer, from a clear sky to overcast

Sky.SetCloudCoverage(cloud_coverage)

Type	Parameter	Default	Description
float	cloud_coverage	Required parameter	No description provided

---

SetContrast

A simple contrast boost for the sky material. Cannot affect volumetric clouds

Sky.SetContrast(contrast)

Type	Parameter	Default	Description
float	contrast	Required parameter	No description provided

---

SetFog

The fogginess of the scene. The impact this has on fog density is scaled from the Fog Density category

Sky.SetFog(fog_percentage)

Type	Parameter	Default	Description
float	fog_percentage	Required parameter	No description provided

---

SetMoonAngle

Sets the Moon Angle

Sky.SetMoonAngle(yaw, pitch)

Type	Parameter	Default	Description
float	yaw	Required parameter	No description provided
float	pitch	Required parameter	No description provided

---

SetMoonGlowIntensity

Sets the Moon Glow Intensity

Sky.SetMoonGlowIntensity(glow_intensity)

Type	Parameter	Default	Description
float	glow_intensity	Required parameter	No description provided

---

SetMoonLightIntensity

Sets the Moon Light Intensity

Sky.SetMoonLightIntensity(intensity)

Type	Parameter	Default	Description
float	intensity	Required parameter	No description provided

---

SetMoonPhase

Sets the Moon Phase

Sky.SetMoonPhase(phase)

Type	Parameter	Default	Description
float	phase	Required parameter	Ranges from 0-30

---

SetMoonScale

Sets the Moon Scale

Sky.SetMoonScale(scale)

Type	Parameter	Default	Description
float	scale	Required parameter	No description provided

---

SetMoonTexture

Sets the Moon Texture

Set it to empty to restore the default. After setting it, you must call Sky.Reconstruct() to have it applied properly

Sky.SetMoonTexture(texture)

Type	Parameter	Default	Description
Image Path	texture	Required parameter	No description provided

---

SetMoonTextureRotation

Sets the Moon Texture Rotation

Sky.SetMoonTextureRotation(rotation)

Type	Parameter	Default	Description
float	rotation	Required parameter	No description provided

---

SetMoonVerticalOffset

Sets the Moon Vertical Offset

Sky.SetMoonVerticalOffset(offset)

Type	Parameter	Default	Description
float	offset	Required parameter	No description provided

---

SetNightBrightness

Can be used to scale the brightness of the sky and lighting, at night

Sky.SetNightBrightness(brightness)

Type	Parameter	Default	Description
float	brightness	Required parameter	No description provided

---

SetOverallIntensity

The overall brightness of the shader

Sky.SetOverallIntensity(intensity)

Type	Parameter	Default	Description
float	intensity	Required parameter	No description provided

---

SetSkyMode

Sets the Sky Mode

After setting it, you must call Sky.Reconstruct() to have it applied properly

Sky.SetSkyMode(sky_mode)

Type	Parameter	Default	Description
SkyMode	sky_mode	Required parameter	No description provided

---

SetSunAngle

Sets the Sun Angle

Sky.SetSunAngle(yaw, pitch)

Type	Parameter	Default	Description
float	yaw	Required parameter	No description provided
float	pitch	Required parameter	No description provided

---

SetSunLightIntensity

Sets the Sun Light Intensity

Sky.SetSunLightIntensity(intensity)

Type	Parameter	Default	Description
float	intensity	Required parameter	No description provided

---

SetSunScale

Sets the Sun Scale

Sky.SetSunScale(radius)

Type	Parameter	Default	Description
float	radius	Required parameter	No description provided

---

SetTimeOfDay

Sets the current time

Sky.SetTimeOfDay(hours, minutes)

Type	Parameter	Default	Description
integer	hours	Required parameter	No description provided
integer	minutes	Required parameter	No description provided

See also GetTimeOfDay.

---

SetVolumetricCloudColor

Sets the Volumetric Cloud Color

This is only applied if SetSkyMode(SkyMode.VolumetricClouds) is set

Sky.SetVolumetricCloudColor(color)

Type	Parameter	Default	Description
Color	color	Required parameter	No description provided

---

Spawn

Replaces all Sky/Sun actors with the Ultra Dynamic Sky Actor, to be able to use the functions from this page. Internally this calls Sky.DestroyAllSky() automatically

Sky.Spawn(spawn_weather?, find_existing?)

Type	Parameter	Default	Description
boolean	spawn_weather?	false	Whether or not to spawn the Weather Actor (to be able to use Weather related methods)
boolean	find_existing?	true	Whether or not to try to find existing Sky & Weather Actors spawned in the map, using their references instead

🚀 Events

This class doesn't have own events.