WoW:API GetRestState: Difference between revisions

Revision as of 14:11, 2 November 2005

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()

None.

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

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.

@@ Line 3: / Line 3: @@
 Returns whether the player is in a [[Rest|rested]] (earning double XP for kills) or normal state.
-<pre>GetRestState()</pre>
+<pre>id, name, mult = GetRestState()</pre>
-'''''Arguments'''''
+== Parameters ==
+=== Arguments ===
 :None.
-----
+=== Returns ===
+;''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.
-:* '''1''' if the player is in a rested state.
+:;name - rest state name, localised (i.e. "Normal", "Rested", ...)
-:* '''2''' if the player is in a normal state.
+:;mult - rest state XP multiplier.
 ----