Difference between revisions of "Weather Script"
Jump to navigation
Jump to search
imported>CraftySentinel m (Updated SKSE functions.) |
imported>Enter 77 |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Script for the manipulation of the weather. | |||
== Definition == | == Definition == | ||
Line 9: | Line 8: | ||
ScriptName Weather extends Form Hidden | ScriptName Weather extends Form Hidden | ||
</source> | </source> | ||
== Global Functions == | == Global Functions == | ||
:'''Weather [[FindWeather - Weather|FindWeather]](Int ''auiType'')''' | |||
:*Finds a weather from the currently occupied region or climate by the specified type. | |||
:'''Weather [[GetCurrentWeather - Weather|GetCurrentWeather]]()''' | |||
:*Gets the current weather. | |||
:'''Float [[GetCurrentWeatherTransition - Weather|GetCurrentWeatherTransition]]()''' | |||
:*Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned. | |||
:'''Weather [[GetOutgoingWeather - Weather|GetOutgoingWeather]]()''' | |||
:*Gets the weather which is currently transitioning out. | |||
:'''Int [[GetSkyMode - Weather|GetSkyMode]]()''' | |||
:*Gets a code representing the mode the sky is currently in. | |||
:'''[[ReleaseOverride - Weather|ReleaseOverride()]] | |||
:*Tells the sky to release its overriding weather. | |||
== Member Functions == | == Member Functions == | ||
:'''[[ForceActive - Weather|ForceActive]](Bool ''abOverride'')''' | |||
:*Forces this to be the active weather immediately, without transition. | |||
:'''Int [[GetClassification - Weather|GetClassification]]()''' | |||
:*Gets the classification code for this weather object. | |||
:'''[[SetActive - Weather|SetActive]](Bool ''abOverride'', Bool ''abAccelerate'')''' | |||
:*Sets the active weather on the sky to be this weather. | |||
== SKSE Member Functions == | == SKSE Member Functions == | ||
:'''Float [[GetSunGlare - Weather|GetSunGlare]]()''' | |||
:*Gets the sun glare percentage. | |||
:'''Float [[GetSunDamage - Weather|GetSunDamage]]()''' | |||
:*Gets the sun damage percentage. | |||
:'''Float [[GetWindDirection - Weather|GetWindDirection]]()''' | |||
:*Gets the wind direction in degrees. | |||
:'''Float [[GetWindDirectionRange - Weather|GetWindDirectionRange]]()''' | |||
:*Gets the wind direction range in degrees. | |||
| | :'''Float [[GetFogDistance - Weather|GetFogDistance]](Bool ''day'', Int ''type'')''' | ||
:*Gets the fog distance of the specified type. | |||
Latest revision as of 03:58, 30 December 2014
Extends: Form Script
Script for the manipulation of the weather.
Definition[edit | edit source]
ScriptName Weather extends Form Hidden
Global Functions[edit | edit source]
- Weather FindWeather(Int auiType)
- 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[edit | edit source]
- ForceActive(Bool abOverride)
- Forces this to be the active weather immediately, without transition.
- Int GetClassification()
- Gets the classification code for this weather object.
- SetActive(Bool abOverride, Bool abAccelerate)
- Sets the active weather on the sky to be this weather.
SKSE Member Functions[edit | edit source]
- 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 day, Int type)
- Gets the fog distance of the specified type.