WoW:API GetRestState

GetRestState - Documentation by EDG (original by Dga)

Returns whether the player is in a rested (earning double XP for kills) or normal state.

id, name, mult = GetRestState()

Parameters

Arguments

None.

Returns

Returns

id - rest state Id

• 1 if the player is in a rested state.
• 2 if the player is in a normal state.

Blizzard code indicates that there may be state up to 5.

name - rest state name, localised (i.e. "Normal", "Rested", ...)

mult - rest state XP multiplier.

---

Example

rested = GetRestState();

Result

rested is assigned a value of 1 if the player is rested, or a value of 2 if the player is earning normal XP.