ForceActive - Weather

From Creation Kit
Jump to: navigation, search

Member of: Weather Script

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

Syntax

Function ForceActive(bool abOverride = false) native

Parameters

  • abOverride: If true, this weather remain active until released using ReleaseOverride.
    • Default: False

Return Value

None

Examples

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


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

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).

See Also