WoW:API GetInstanceLockTimeRemaining: Difference between revisions

Revision as of 22:58, 29 March 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns information about the instance lock timer for the current instance.

lockTimeleft, isPreviousInstance, encountersTotal, encountersComplete = GetInstanceLockTimeRemaining();

lockTimeLeft: Number - Seconds until lock period ends
isPreviousInstance: Boolean - Whether this instance has yet to be entered since last lockout expired (allowing for lock extension options)
encountersTotal: Number - Total number of bosses in the instance.
encountersComplete: Number - Number of bosses already dead in the instance.

@@ Line 1: / Line 1: @@
-{{wowapi}} __NOTOC__
+{{wowapi}}
-{{stub/API}}
+Returns information about the instance lock timer for the current instance.
+ lockTimeleft, isPreviousInstance, encountersTotal, encountersComplete = GetInstanceLockTimeRemaining();
- local lockTimeleft, isPreviousInstance = GetInstanceLockTimeRemaining();
+== Returns ==
+;lockTimeLeft : Number - Seconds until lock period ends
+;isPreviousInstance : Boolean - Whether this instance has yet to be entered since last lockout expired (allowing for lock extension options)
+;encountersTotal : Number - Total number of bosses in the instance.
+;encountersComplete : Number - Number of bosses already dead in the instance.
-== Parameters ==
+== History ==
-=== Arguments ===
+* isPreviousInstance argument added in [[Patch 3.2]]
-: void
-=== Returns ===
+== See also ==
-:;lockTimeLeft : Number - Seconds until lock period ends
+* {{api|GetInstanceLockTimeRemainingEncounter}}()
-:;isPreviousInstance : Boolean - Whether this instance has yet to be entered since last lockout expired (allowing for lock extension options)
-== Example ==
-== Details ==
-* Patch 3.2, this was noted as being updated in 3.2 with isPreviousInstance being the change, but this funciton was not even listed in wowwiki, so not sure if it's just totally new [http://forums.worldofwarcraft.com/thread.html?topicId=18031134556&postId=180295297941#180295297941 source]