Editing SetActive - Weather

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

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

== Parameters ==
*abOverride: If true, this weather remains active until released using [[ReleaseOverride - Weather|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 ==
<syntaxhighlight lang="papyrus">
; Set the cool weather as active
CoolWeather.SetActive()
</syntaxhighlight>
<br>
<syntaxhighlight lang="papyrus">
; Set the bad weather as active, overriding until released
BadWeather.SetActive(true)
</syntaxhighlight>

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