Difference between revisions of "Weather Script"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Jog |
||
| Line 16: | Line 16: | ||
== Global Functions == | == Global Functions == | ||
'''Weather Function [[FindWeather - Weather|FindWeather]](int auiType)''' | |||
*Finds a weather from the currently occupied region or climate by the specified type. | |||
'''Weather Function [[GetCurrentWeather - Weather|GetCurrentWeather]]()''' | |||
*Gets the current weather. | |||
'''float Function [[GetCurrentWeatherTransition - Weather|GetCurrentWeatherTransition]]()''' | |||
*Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned. | |||
'''Weather Function [[GetOutgoingWeather - Weather|GetOutgoingWeather]]()''' | |||
*Gets the weather which is currently transitioning out. | |||
'''int Function [[GetSkyMode - Weather|GetSkyMode]]()''' | |||
*Gets a code representing the mode the sky is currently in. | |||
'''Function [[ReleaseOverride - Weather|ReleaseOverride]]()''' | |||
*Tells the sky to release its overriding weather. | |||
== Member Functions == | == Member Functions == | ||
Revision as of 13:09, 20 February 2012
Extends: Form Script
Script for the manipulation of the weather.
Definition
ScriptName Weather extends FormProperties
None
Global Functions
Weather Function FindWeather(int auiType)
- Finds a weather from the currently occupied region or climate by the specified type.
Weather Function GetCurrentWeather()
- Gets the current weather.
float Function GetCurrentWeatherTransition()
- Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned.
Weather Function GetOutgoingWeather()
- Gets the weather which is currently transitioning out.
int Function GetSkyMode()
- Gets a code representing the mode the sky is currently in.
Function ReleaseOverride()
- Tells the sky to release its overriding weather.
Member Functions
- Function ForceActive(bool abOverride)
- Forces this to be the active weather immediately, without transition.
- int function GetClassification()
- Gets the classification code for this weather object.
- Function SetActive(bool abOverride, bool abAccelerate)
- Sets the active weather on the sky to be this weather.