Weather Script

From the CreationKit Wiki
Revision as of 05:49, 27 August 2013 by imported>CraftySentinel (→‎SKSE Member Functions: Added remaining SKSE functions)
Jump to navigation Jump to search


Extends: Form Script

Script for the manipulation of the weather.

Definition

ScriptName Weather extends Form

Properties

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.

SKSE Member Functions

float Function GetSunGlare()

  • Returns the sun glare percentage.

float Function GetSunDamage()

  • Returns the sun damage percentage.

float Function GetWindDirection()

  • Returns the wind direction in degrees.

float Function GetWindDirectionRange()

  • Returns the wind direction range in degrees.

float Function GetWindDirectionRange(bool day, int type)

  • Returns the fog distance of the specified type.