API GetMirrorTimerInfo

Returns info for the mirror timer, e.g. fatigue, breath and feign death. timer, initial, maxvalue, scale, paused, label = GetMirrorTimerInfo(id)

• id: - timer index, from 1 to MIRRORTIMER_NUMTIMERS (3 as of 3.2). In general, the following correspondence holds: 1 = Fatigue, 2 = Breath, 3 = Feign Death.

• timer: - A string identifying timer type; "EXHAUSTION", "BREATH", and "FEIGNDEATH", or "UNKNOWN" indicating that the timer corresponding to that index is not currently active, and other return values are invalid.
• initial: - Value of the timer when the it started.
• maxvalue: - Maximum value of the timer.
• scale: - Change in timer value per second.
• paused: - 0 if the timer is currently running, a value greater than zero if it is not.
• label: - Localized timer name.

• Calling the function with an out-of-range index results in an error. The syntax specification in the error text is invalid; this function may not be called with "BREATH", "EXHAUSTION" etc as arguments.
• The current value of the timer may be retrieved using ("timer"). Most timers tend to count down to zero, at which point something bad happens.

• is fired when a timer becomes active.
• is fired when a timer becomes inactive.
• is fired when a timer is paused.