WoW:API GetRestState: Difference between revisions

Revision as of 15:06, 14 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

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 1: / Line 1: @@
-Returns 1 if rested.
+<center>'''''GetRestState''''' - ''Documentation by [[User:EDG|EDG]] (original by [[User:Dga|Dga]])''</center>
-Dont know if its 0 or nil for not rested.
+Returns whether the player is in a [[Rest|rested]] (earning double XP for kills) or normal state.
-RestState is the state where your toon gets added XP for killing mobs.
+<pre>GetRestState()</pre>
+'''''Arguments'''''
+:None.
+----
+'''''Returns'''''
+:* '''1''' if the player is in a rested state.
+:* '''2''' if the player is in a normal state.
+----
+'''''Example'''''
+<pre>rested = GetRestState();</pre>
+'''''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.