Background for Skyrim SE
Member of the Weather script
voidfunctionSetActive(boolabOverride=false, boolabAccelerate=false)Native

Description

Wiki Description

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.

Documentation Comment

Sets the active weather on the sky to be this weather.


Parameters

  1. boolabOverride=false

    CK Wiki Description

    If true, this weather remains active until released using Weather.ReleaseOverride().

    • Default:False
  2. boolabAccelerate=false

    CK Wiki Description

    If true, accelerate any existing transition when the call is made by a factor determined by game setting value fWeatherTransAccel.

    • Default:False

Examples

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

Auto-Generated Example

bool myBool__abOverride
bool myBool__abAccelerate

myWeather__toCallFunctionOn.SetActive(myBool__abOverride, myBool__abAccelerate)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.