Weather

Found in:

Vanilla

Inheritance Tree

No indexed scripts extend this script.

Structs

Properties

Events

Functions

Found in:

Vanilla

voidfunctionEnableAmbientParticles(boolabEnable=true)NativeGlobal

Enables or disables ambient particle effects coming from the weather.

Found in:

Vanilla

WeatherfunctionFindWeather(intauiType)NativeGlobal

Finds a weather of the given type for the currently occupied region (if applicable) or climate.

Found in:

Vanilla

voidfunctionForceActive(boolabOverride=false)Native

Forces the active weather on the sky to be this weather. Weather will become fully transitioned immediately. To have the weather transition in normally, use Weather.SetActive(...) instead.

Found in:

Vanilla

intfunctionGetClassification()Native

Gets this weather's classification, as specified in the editor.

Found in:

Vanilla

WeatherfunctionGetCurrentWeather()NativeGlobal

Gets the current weather.

Found in:

Vanilla

floatfunctionGetCurrentWeatherTransition()NativeGlobal

Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned. If no transition is occurring, this function returns 1.0 and Weather.GetOutgoingWeather() returns none. If this function returns any other value, Weather.GetOutgoingWeather() returns the weather which is transitioning out and Weather.GetCurrentWeather() returns the weather which is transitioning in.

[DEV SERVER] Loading description...

Found in:

Vanilla

WeatherfunctionGetOutgoingWeather()NativeGlobal

Gets the weather which is currently transitioning out.

Found in:

Vanilla

intfunctionGetSkyMode()NativeGlobal

Gets the mode under which the sky is currently operating.

Found in:

Vanilla

voidfunctionReleaseOverride()NativeGlobal

Tells the sky to release its overriding weather.

Found in:

Vanilla

voidfunctionSetActive(boolabOverride=false, boolabAccelerate=false)Native

Sets the active weather on the sky to be this weather. Weather will transition in normally, according to its data. To force the weather to become fully transitioned immediately, use Weather.ForceActive(...) instead.