Difference between revisions of "Weather Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
imported>CraftySentinel
m (Updated SKSE functions.)
Line 1: Line 1:
[[Category:Scripting]]
__NOTOC__ __NOEDITSECTION__
[[Category:Papyrus]]
'''Extends:''' [[Form Script]]
[[Category:Script Objects]]


'''Extends:''' [[Form Script]]


Script for the manipulation of the weather.
Script for the manipulation of the weather.
Line 9: Line 7:
== Definition ==
== Definition ==
<source lang="papyrus">
<source lang="papyrus">
ScriptName Weather extends Form
ScriptName Weather extends Form Hidden
</source>
</source>


== Properties ==
== Global Functions ==
None
 
{|class="wikitable" width =100%
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-


== Global Functions ==
|[[FindWeather - Weather|Weather '''FindWeather'''(''Int'')]]
'''Weather Function [[FindWeather - Weather|FindWeather]](int auiType)'''
|Finds a weather from the currently occupied region or climate by the specified type.
*Finds a weather from the currently occupied region or climate by the specified type.
|-


'''Weather Function [[GetCurrentWeather - Weather|GetCurrentWeather]]()'''
|[[GetCurrentWeather - Weather|Weather '''GetCurrentWeather'''()]]
*Gets the current weather.
|Gets the current weather.
|-


'''float Function [[GetCurrentWeatherTransition - Weather|GetCurrentWeatherTransition]]()'''
|[[GetCurrentWeatherTransition - Weather|Float '''GetCurrentWeatherTransition'''()]]
*Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned.
|Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned.
|-


'''Weather Function [[GetOutgoingWeather - Weather|GetOutgoingWeather]]()'''
|[[GetOutgoingWeather - Weather|Weather '''GetOutgoingWeather'''()]]
*Gets the weather which is currently transitioning out.
|Gets the weather which is currently transitioning out.
|-


'''int Function [[GetSkyMode - Weather|GetSkyMode]]()'''
|[[GetSkyMode - Weather|Int '''GetSkyMode'''()]]
*Gets a code representing the mode the sky is currently in.
|Gets a code representing the mode the sky is currently in.
|-


'''Function [[ReleaseOverride - Weather|ReleaseOverride]]()'''
|[[ReleaseOverride - Weather|'''ReleaseOverride'''()]]
*Tells the sky to release its overriding weather.
|Tells the sky to release its overriding weather.


|}
== Member Functions ==
== Member Functions ==
'''Function [[ForceActive - Weather|ForceActive]](bool abOverride)'''
*Forces this to be the active weather immediately, without transition.


'''int function [[GetClassification - Weather|GetClassification]]()'''
{|class="wikitable" width =100%
*Gets the classification code for this weather object.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
 
|[[ForceActive - Weather|'''ForceActive'''(''Bool'')]]
|Forces this to be the active weather immediately, without transition.
|-
 
|[[GetClassification - Weather|Int '''GetClassification'''()]]
|Gets the classification code for this weather object.
|-


'''Function [[SetActive - Weather|SetActive]](bool abOverride, bool abAccelerate)'''
|[[SetActive - Weather|'''SetActive'''(''Bool, Bool'')]]
*Sets the active weather on the sky to be this weather.
|Sets the active weather on the sky to be this weather.
 
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
'''float Function [[GetSunGlare - Weather|GetSunGlare]]()'''
*Returns the sun glare percentage.


'''float Function [[GetSunDamage - Weather|GetSunDamage]]()'''
{|class="wikitable" width =100%
*Returns the sun damage percentage.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-
|[[GetSunGlare - Weather|Float '''GetSunGlare'''()]]
|Gets the sun glare percentage.
|-


'''float Function [[GetWindDirection - Weather|GetWindDirection]]()'''
|[[GetSunDamage - Weather|Float '''GetSunDamage'''()]]
*Returns the wind direction in degrees.
|Gets the sun damage percentage.
|-


'''float Function [[GetWindDirectionRange - Weather|GetWindDirectionRange]]()'''
|[[GetWindDirection - Weather|Float '''GetWindDirection'''()]]
*Returns the wind direction range in degrees.
|Gets the wind direction in degrees.
|-


'''float Function [[GetFogDistance - Weather|GetFogDistance]](bool day, int type)'''
|[[GetWindDirectionRange - Weather|Float '''GetWindDirectionRange'''()]]
*Returns the fog distance of the specified type.
|Gets the wind direction range in degrees.
|-
 
|[[GetFogDistance - Weather|Float '''GetFogDistance'''(''Bool, Int'')]]
|Gets the fog distance of the specified type.
 
|}
 
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

Revision as of 05:20, 28 August 2013

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.
Retrieved from "https://ck.uesp.net/w/index.php?title=Weather_Script&oldid=17981"