WoW:API GetRestState - Revision history

Move page script: Move page script moved page API GetRestState to WoW:API GetRestState without leaving a redirect

2023-08-15T04:46:25Z

Move page script moved page API GetRestState to API GetRestState without leaving a redirect

← Older revision	Revision as of 04:46, 15 August 2023
(No difference)

2010-03-27T23:59:24Z

boilerplate

@@ Line 1: / Line 1: @@
-<center>'''''GetRestState''''' - ''Documentation by [[User:EDG|EDG]] (original by [[User:Dga|Dga]])''</center>
+{{wowapi}} __NOTOC__
 Returns whether the player is in a [[Rest|rested]] (earning double XP for kills) or normal state.
-<pre>id, name, mult = GetRestState()</pre>
+== Returns ==
+; id : Number - Rest state index; observed values are '''1''' if the player is "Rested", '''2''' if the player is in a normal state.
-== Parameters ==
+; name : String - Name of the current rest state; observed: "Rested" or "Normal".
-=== Arguments ===
+; mult : Number - XP multiplier applied to experience gain from killing monsters in the current rest state.
-----
+==Example==
-{{WoW API}}
+ rested = GetRestState();

2006-01-04T04:51:55Z

← Older revision		Revision as of 04:51, 4 January 2006
Line 31:		Line 31:
	''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]]~~		----
			{{WoW API}}

2005-11-02T14:11:01Z

← Older revision		Revision as of 14:11, 2 November 2005
Line 3:		Line 3:
	Returns whether the player is in a [[Rest\|rested]] (earning double XP for kills) or normal state.		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.		: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.

	----		----

2005-08-27T18:55:59Z

← Older revision		Revision as of 18:55, 27 August 2005
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]]

2005-08-14T15:06:25Z

@@ 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>

2005-02-11T16:05:36Z

New page

Returns 1 if rested.

Dont know if its 0 or nil for not rested.

RestState is the state where your toon gets added XP for killing mobs.