Weather Script

From the CreationKit Wiki
Revision as of 05:20, 28 August 2013 by imported>CraftySentinel (Updated SKSE functions.)
Jump to navigation Jump to search

Extends: Form Script


Script for the manipulation of the weather.

Definition

ScriptName Weather extends Form Hidden

Global Functions

Function Description
Weather FindWeather(Int) Finds a weather from the currently occupied region or climate by the specified type.
Weather GetCurrentWeather() Gets the current weather.
Float GetCurrentWeatherTransition() Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned.
Weather GetOutgoingWeather() Gets the weather which is currently transitioning out.
Int GetSkyMode() Gets a code representing the mode the sky is currently in.
ReleaseOverride() Tells the sky to release its overriding weather.

Member Functions

Function Description
ForceActive(Bool) Forces this to be the active weather immediately, without transition.
Int GetClassification() Gets the classification code for this weather object.
SetActive(Bool, Bool) Sets the active weather on the sky to be this weather.

SKSE Member Functions

Function Description
Float GetSunGlare() Gets the sun glare percentage.
Float GetSunDamage() Gets the sun damage percentage.
Float GetWindDirection() Gets the wind direction in degrees.
Float GetWindDirectionRange() Gets the wind direction range in degrees.
Float GetFogDistance(Bool, Int) Gets the fog distance of the specified type.