ForceActive - Weather | Fallout 4

Found in:

Vanilla

voidfunctionForceActive(boolabOverride=false)Native

Description

Wiki Description

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.

Documentation Comment

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

Caveats

CK Wiki - Notes

If you're setting a weather as you load in, be sure you call this AFTER the load is started, or else it'll get bashed. (for example: I move the player to a spot to start CharGen, make sure this call happens after the MoveTo and after a short Wait so it happens after the loadscreen starts).

Parameters

boolabOverride=false

CK Wiki Description

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

Default:False

Examples

; Force the good weather to be active
GoodWeather.ForceActive()

; Force the windy weather to be active until released
WindyWeather.ForceActive(true)

Auto-Generated Example

bool myBool__abOverride

myWeather__toCallFunctionOn.ForceActive(myBool__abOverride)

Weather
Weather.SetActive(...)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki