Difference between revisions of "Weather Script"

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


Script for the manipulation of the weather.


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 ==


{|class="wikitable" width =100%
:'''Weather [[FindWeather - Weather|FindWeather]](Int ''auiType'')'''
!style="text-align:left;" width=25%|Function
:*Finds a weather from the currently occupied region or climate by the specified type.
!style="text-align:left;"|Description
|-


|[[FindWeather - Weather|Weather '''FindWeather'''(''Int'')]]
:'''Weather [[GetCurrentWeather - Weather|GetCurrentWeather]]()'''
|Finds a weather from the currently occupied region or climate by the specified type.
:*Gets the current weather.
|-


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


|[[GetCurrentWeatherTransition - Weather|Float '''GetCurrentWeatherTransition'''()]]
:'''Weather [[GetOutgoingWeather - Weather|GetOutgoingWeather]]()'''
|Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned.
:*Gets the weather which is currently transitioning out.
|-


|[[GetOutgoingWeather - Weather|Weather '''GetOutgoingWeather'''()]]
:'''Int [[GetSkyMode - Weather|GetSkyMode]]()'''
|Gets the weather which is currently transitioning out.
:*Gets a code representing the mode the sky is currently in.
|-


|[[GetSkyMode - Weather|Int '''GetSkyMode'''()]]
:'''[[ReleaseOverride - Weather|ReleaseOverride()]]
|Gets a code representing the mode the sky is currently in.
:*Tells the sky to release its overriding weather.
|-


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


|}
== Member Functions ==
== Member Functions ==


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


|[[ForceActive - Weather|'''ForceActive'''(''Bool'')]]
:'''Int [[GetClassification - Weather|GetClassification]]()'''
|Forces this to be the active weather immediately, without transition.
:*Gets the classification code for this weather object.
|-


|[[GetClassification - Weather|Int '''GetClassification'''()]]
:'''[[SetActive - Weather|SetActive]](Bool ''abOverride'', Bool''abAccelerate'')'''
|Gets the classification code for this weather object.
:*Sets the active weather on the sky to be this weather.
|-


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


== SKSE Member Functions ==
== SKSE Member Functions ==


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


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


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


|[[GetFogDistance - Weather|Float '''GetFogDistance'''(''Bool, Int'')]]
:'''Float [[GetWindDirectionRange - Weather|GetWindDirectionRange]]()'''
|Gets the fog distance of the specified type.
:*Gets the wind direction range in degrees.


|}
:'''Float [[GetFogDistance - Weather|GetFogDistance]](Bool ''day'', Int ''type'')'''
:*Gets the fog distance of the specified type.




Revision as of 22:32, 2 February 2014

Extends: Form Script

Script for the manipulation of the weather.


Definition

ScriptName Weather extends Form Hidden


Global Functions

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

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, BoolabAccelerate)
  • Sets the active weather on the sky to be this weather.


SKSE Member Functions

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