Editing ForceActive - Weather

[[Category:Scripting]]
[[Category:Papyrus]]
'''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 - Weather|SetActive]] instead.

== Syntax ==
<syntaxhighlight lang="papyrus">
Function ForceActive(bool abOverride = false) native
</syntaxhighlight>

== Parameters ==
*abOverride: If true, this weather remain active until released using [[ReleaseOverride - Weather|ReleaseOverride]].
**'''Default''': False

== Return Value ==
None

== Examples ==
<syntaxhighlight lang="papyrus">
; Force the good weather to be active
GoodWeather.ForceActive()
</syntaxhighlight>
<br>
<syntaxhighlight lang="papyrus">
; Force the windy weather to be active until released
WindyWeather.ForceActive(true)
</syntaxhighlight>

== See Also ==
*[[Weather Script]]
*[[SetActive - Weather]]