Skip to main content
Version: bleeding-edge 🩸

🌅 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

ReturnsNameDescription
ChangeWeatherChanges the Weather
DestroyAllSkyDestroys 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, integerGetTimeOfDayGets the current time
WeatherTypeGetWeatherGets the current weather
booleanIsSpawnedReturns if the Ultra Dynamic Sky was spawned
ReconstructReconstruct the Ultra Dynamic Sky Actor, forces most of the changes to be applied
SetAnimateTimeOfDaySets whether or not to animate the time of day
SetCloudCoverageThe amount of coverage for the cloud layer, from a clear sky to overcast
SetContrastA simple contrast boost for the sky material. Cannot affect volumetric clouds
SetFogThe fogginess of the scene. The impact this has on fog density is scaled from the Fog Density category
SetMoonAngleSets the Moon Angle
SetMoonGlowIntensitySets the Moon Glow Intensity
SetMoonLightIntensitySets the Moon Light Intensity
SetMoonPhaseSets the Moon Phase
SetMoonScaleSets the Moon Scale
SetMoonTextureSets the Moon Texture
SetMoonTextureRotationSets the Moon Texture Rotation
SetMoonVerticalOffsetSets the Moon Vertical Offset
SetNightBrightnessCan be used to scale the brightness of the sky and lighting, at night
SetOverallIntensityThe overall brightness of the shader
SetSkyModeSets the Sky Mode
SetSunAngleSets the Sun Angle
SetSunLightIntensitySets the Sun Light Intensity
SetSunScaleSets the Sun Scale
SetTimeOfDaySets the current time
SetVolumetricCloudColorSets the Volumetric Cloud Color
SpawnReplaces 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)
TypeParameterDefaultDescription
WeatherTypeweather Required parameter weather to change
floattransition_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)
TypeParameterDefaultDescription
booleanincluding_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?)
TypeParameterDefaultDescription
booleananimate Required parameter Whether or not to animate the time of day
float or nilday_length?30.0The time (in minutes) from sunrise to sunset
float or nilnight_length?15.0The 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)
TypeParameterDefaultDescription
floatcloud_coverage Required parameter No description provided

SetContrast

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

Sky.SetContrast(contrast)
TypeParameterDefaultDescription
floatcontrast 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)
TypeParameterDefaultDescription
floatfog_percentage Required parameter No description provided

SetMoonAngle

Sets the Moon Angle

Sky.SetMoonAngle(yaw, pitch)
TypeParameterDefaultDescription
floatyaw Required parameter No description provided
floatpitch Required parameter No description provided

SetMoonGlowIntensity

Sets the Moon Glow Intensity

Sky.SetMoonGlowIntensity(glow_intensity)
TypeParameterDefaultDescription
floatglow_intensity Required parameter No description provided

SetMoonLightIntensity

Sets the Moon Light Intensity

Sky.SetMoonLightIntensity(intensity)
TypeParameterDefaultDescription
floatintensity Required parameter No description provided

SetMoonPhase

Sets the Moon Phase

Sky.SetMoonPhase(phase)
TypeParameterDefaultDescription
floatphase Required parameter Ranges from 0-30

SetMoonScale

Sets the Moon Scale

Sky.SetMoonScale(scale)
TypeParameterDefaultDescription
floatscale 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)
TypeParameterDefaultDescription
Image Pathtexture Required parameter No description provided

SetMoonTextureRotation

Sets the Moon Texture Rotation

Sky.SetMoonTextureRotation(rotation)
TypeParameterDefaultDescription
floatrotation Required parameter No description provided

SetMoonVerticalOffset

Sets the Moon Vertical Offset

Sky.SetMoonVerticalOffset(offset)
TypeParameterDefaultDescription
floatoffset Required parameter No description provided

SetNightBrightness

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

Sky.SetNightBrightness(brightness)
TypeParameterDefaultDescription
floatbrightness Required parameter No description provided

SetOverallIntensity

The overall brightness of the shader

Sky.SetOverallIntensity(intensity)
TypeParameterDefaultDescription
floatintensity 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)
TypeParameterDefaultDescription
SkyModesky_mode Required parameter No description provided

SetSunAngle

Sets the Sun Angle

Sky.SetSunAngle(yaw, pitch)
TypeParameterDefaultDescription
floatyaw Required parameter No description provided
floatpitch Required parameter No description provided

SetSunLightIntensity

Sets the Sun Light Intensity

Sky.SetSunLightIntensity(intensity)
TypeParameterDefaultDescription
floatintensity Required parameter No description provided

SetSunScale

Sets the Sun Scale

Sky.SetSunScale(radius)
TypeParameterDefaultDescription
floatradius Required parameter No description provided

SetTimeOfDay

Sets the current time

Sky.SetTimeOfDay(hours, minutes)
TypeParameterDefaultDescription
integerhours Required parameter No description provided
integerminutes 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)
TypeParameterDefaultDescription
Colorcolor 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?)
TypeParameterDefaultDescription
booleanspawn_weather?falseWhether or not to spawn the Weather Actor (to be able to use Weather related methods)
booleanfind_existing?trueWhether 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.