SetActive - Weather

From Creation Kit
Jump to: navigation, search

Member of: Weather Script

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 ForceActive instead.

Syntax

Function SetActive(bool abOverride = false, bool abAccelerate = false) native

Parameters

  • abOverride: If true, this weather remains active until released using ReleaseOverride.
    • Default: False
  • abAccelerate: If true, accelerate any existing transition when the call is made by a factor determined by game setting value fWeatherTransAccel.
    • Default: False

Return Value

None

Examples

; Set the cool weather as active
CoolWeather.SetActive()


; Set the bad weather as active, overriding until released
BadWeather.SetActive(true)

See Also