Weather Script

Extends: Form Script

Script for the manipulation of the weather.

Definition

ScriptName Weather extends Form Native Hidden

Properties

None

Global Functions

• Function EnableAmbientParticles(bool abEnable)
  • Enables/disables ambient weather particles in the game
• 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.