GetCurrentWeatherTransition - Weather

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: Weather Script

Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned. If no transition is occurring, this function returns 1.0 and GetOutgoingWeather returns none. If this function returns any other value, GetOutgoingWeather returns the weather which is transitioning out and GetCurrentWeather returns the weather which is transitioning in.

Syntax[edit | edit source]

float Function GetCurrentWeatherTransition() native global

Parameters[edit | edit source]

None.

Return Value[edit | edit source]

A number from 0.0 to 1.0 representing the completion percentage of the current weather transition.

Examples[edit | edit source]

float curTransition = Weather.GetCurrentWeatherTransition()
if (curTransition == 1.0)
  Debug.Trace("Weather is not transitioning!")
else
  Debug.Trace("Weather is transitioning and is " + (curTransition * 100) + "% done")
endIf

See Also[edit | edit source]