Difference between revisions of "Weather Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(→‎SKSE Member Functions: Added GetSunDamage)
imported>Enter 77
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Script for the manipulation of the weather.
Script for the manipulation of the weather.


== Definition ==
== Definition ==
<source lang="papyrus">
<source lang="papyrus">
ScriptName Weather extends Form
ScriptName Weather extends Form Hidden
</source>
</source>


== Properties ==
None


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


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


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


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


'''int Function [[GetSkyMode - Weather|GetSkyMode]]()'''
:'''Weather [[GetOutgoingWeather - Weather|GetOutgoingWeather]]()'''
*Gets a code representing the mode the sky is currently in.
:*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.


'''Function [[ReleaseOverride - Weather|ReleaseOverride]]()'''
*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]]()'''
:'''[[ForceActive - Weather|ForceActive]](Bool ''abOverride'')'''
*Gets the classification code for this weather object.
:*Forces this to be the active weather immediately, without transition.
 
:'''Int [[GetClassification - Weather|GetClassification]]()'''
:*Gets the classification code for this weather object.


'''Function [[SetActive - Weather|SetActive]](bool abOverride, bool abAccelerate)'''
:'''[[SetActive - Weather|SetActive]](Bool ''abOverride'', Bool ''abAccelerate'')'''
*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]]()'''
:'''Float [[GetSunGlare - Weather|GetSunGlare]]()'''
*Returns the sun damage percentage.
:*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.
 
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

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