GetSunGlare - Weather

From the CreationKit Wiki
Revision as of 04:10, 28 August 2013 by imported>CraftySentinel (Minor Formatting Change)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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