WoW:API GetRestState: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 24: Line 24:


''rested'' is assigned a value of '''1''' if the player is rested, or a value of '''2''' if the player is earning normal XP.
''rested'' is assigned a value of '''1''' if the player is rested, or a value of '''2''' if the player is earning normal XP.
[[Category:API Functions|GetRestState]]
[[Category:API Character Functions|GetRestState]]

Revision as of 18:55, 27 August 2005

GetRestState - Documentation by EDG (original by Dga)

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

GetRestState()

Arguments

None.

Returns

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

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.