GetSunDamage - Weather

From the CreationKit Wiki
Revision as of 04:09, 28 August 2013 by imported>CraftySentinel (Final Minor 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 damage percentage of the weather object.

Syntax

float Function GetSunDamage() native

Return Value

The Sun damage 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 damage and 1.0 being maximum Sun damage.
  • Sun damage is the damage that vampires receive during daylight hours (5am - 7pm).


Examples

Weather property SkyrimCO Auto ;Filled by SkyrimCO weather form.

float sunDamage = SkyrimCO.GetSunDamage()
Debug.Trace("SkyrimCO has a Sun damage factor of " + (sunDamage ")


See Also