v0.13.8

GetRestState

functionimplementedavailable in: camelot

Returns if the character is in a rested or normal state.

signaturewowlua
function GetRestState(): (number?, string?, number?)

Returns

#nametypedescription
1exhaustionIDnumber?Rest state index; observed values are 1 if the player is "Rested", 2 if the player is in a normal state.
2namestring?Name of the current rest state; observed: "Rested" or "Normal".
3factornumber?XP multiplier applied to experience gain from killing monsters in the current rest state.

Blizzard's documentation says it may return nothing.

In wowlua's emulated client

implementedwowlua models the system behind it. what the statuses mean

sources

Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PlayerScript system, camelot 1.60.1). Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.