Difference between revisions of "GetSunGlare - Weather"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Minor formatting change)
imported>CraftySentinel
m (Minor Formatting Change)
 
Line 1: Line 1:
__NOTOC__ __NOEDITSECTION__
__NOTOC__ __NOEDITSECTION__
'''Requires:''' [[:Category:SKSE|SKSE]] 1.06.00 or above.
'''Source:''' [[:Category:SKSE|SKSE]] 1.06.00


'''Member of:''' [[Weather Script]]  
'''Member of:''' [[Weather Script]]  
Line 13: Line 13:


The Sun glare percentage as specified by the [[Weather#Sun Glare|weather form field]].
The Sun glare percentage as specified by the [[Weather#Sun Glare|weather form field]].
== Notes ==
*The value returned will always be between 0.0 and 1.0, with 0.0 being no Sun glare and 1.0 being maximum Sun glare.


== Examples ==
== Examples ==
Line 19: Line 23:
float sunGlare = SkyrimCO.GetSunGlare()
float sunGlare = SkyrimCO.GetSunGlare()
Debug.Trace("The sun glare of SkyrimCO is " + (sunGlare * 100) + "%.")</source>
Debug.Trace("The sun glare of SkyrimCO is " + (sunGlare * 100) + "%.")</source>
== Notes ==
*The value returned will always be between 0.0 and 1.0, with 0.0 being no Sun glare and 1.0 being maximum Sun glare.





Latest revision as of 04:10, 28 August 2013

Source: SKSE 1.06.00

Member of: Weather Script


Returns the sun glare percentage of the weather object.

Syntax

float Function GetSunGlare() native

Return Value

The Sun glare percentage as specified by the weather form field.

Notes

  • The value returned will always be between 0.0 and 1.0, with 0.0 being no Sun glare and 1.0 being maximum Sun glare.


Examples

Weather property SkyrimCO Auto ;Filled by SkyrimCO weather form.

float sunGlare = SkyrimCO.GetSunGlare()
Debug.Trace("The sun glare of SkyrimCO is " + (sunGlare * 100) + "%.")


See Also