Difference between revisions of "GetSunGlare - Weather"
Jump to navigation
Jump to search
imported>CraftySentinel m (Minor formatting change) |
imported>CraftySentinel m (Minor formatting change) |
||
| Line 6: | Line 6: | ||
Returns the sun glare percentage of the weather object. | Returns the sun glare percentage of the weather object. | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus">float Function GetSunGlare() native</source> | <source lang="papyrus">float Function GetSunGlare() native</source> | ||
Revision as of 05:34, 27 August 2013
Requires: SKSE 1.06.00 or above.
Member of: Weather Script
Returns the sun glare percentage of the weather object.
Syntax
float Function GetSunGlare() nativeReturn Value
The Sun glare percentage as specified by the weather form field.
Examples
Weather property SkyrimCO Auto ;Filled by SkyrimCO weather form.
float sunGlare = SkyrimCO.GetSunGlare()
Debug.Trace("The sun glare of SkyrimCO is " + (sunGlare * 100) + "%.")
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.