GetMirrorTimerInfo

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  Wowprogramming  GitHub Search
Info
Added in 2.0.1 / 1.13.2

Returns info for the mirror timer, e.g. fatigue, breath and feign death.

timer, initial, maxvalue, scale, paused, label = GetMirrorTimerInfo(id)

Arguments

id

number - 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.

Returns

timer

string - 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

number - Value of the timer when the it started.

maxvalue

number - Maximum value of the timer.

scale

number - Change in timer value per second.

paused

boolean - 0 if the timer is currently running, a value greater than zero if it is not.

label

string - Localized timer name.

Details

• 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 GetMirrorTimerProgress("timer"). Most timers tend to count down to zero, at which point something bad happens.

Related events

• MIRROR_TIMER_START is fired when a timer becomes active.
• MIRROR_TIMER_STOP is fired when a timer becomes inactive.
• MIRROR_TIMER_PAUSE is fired when a timer is paused.