WoW:API GetSavedInstanceInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
== Parameters == | == Parameters == | ||
:;index : Number - index of the instance, ranges from 1 to GetNumSavedInstances() | :;index : Number - index of the instance, ranges from 1 to [[API_GetNumSavedInstances|GetNumSavedInstances]]() | ||
=== Returns === | === Returns === | ||
| Line 13: | Line 13: | ||
:;remaining : Number - the number of seconds remaining until the instance resets | :;remaining : Number - the number of seconds remaining until the instance resets | ||
:;difficulty : Number - the difficulty of the raid instance | :;difficulty : Number - the difficulty of the raid instance | ||
:;locked : Boolean - | :;locked : Boolean - true if the instance is currently locked, false for a historic entry | ||
:;extended : Boolean - shows true if the ID has been extended | :;extended : Boolean - shows true if the ID has been extended | ||
:;instanceIDMostSig : Number - unknown | :;instanceIDMostSig : Number - unknown | ||
| Line 23: | Line 23: | ||
* Exact returned instance names (English): Onyxia's Lair, Blackwing Lair, Molten Core, Zul'Gurub, Ruins of Ahn'Qiraj, Naxxramas and Ahn'Qiraj | * Exact returned instance names (English): Onyxia's Lair, Blackwing Lair, Molten Core, Zul'Gurub, Ruins of Ahn'Qiraj, Naxxramas and Ahn'Qiraj | ||
* Caveat: The instance names are ''not'' necessarily identical with the names returned from GetLFGTypeEntries(). | |||
* Added in 1.11 | * Added in 1.11 | ||
Revision as of 21:15, 21 October 2009
← WoW API < GetSavedInstanceInfo
Returns information about the instances the player is saved to.
instanceName, instanceID, instanceReset, instanceDifficulty, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName = GetSavedInstanceInfo(index)
Parameters
- index
- Number - index of the instance, ranges from 1 to GetNumSavedInstances()
Returns
- name
- String - the name of the instance
- ID
- Number - the ID of the instance
- remaining
- Number - the number of seconds remaining until the instance resets
- difficulty
- Number - the difficulty of the raid instance
- locked
- Boolean - true if the instance is currently locked, false for a historic entry
- extended
- Boolean - shows true if the ID has been extended
- instanceIDMostSig
- Number - unknown
- isRaid
- Boolean - shows true if it is a raid
- maxPlayers
- Number - shows the max players
- difficultyName
- String - shows a localized string i.e. 10 Player (Heroic)
Details
- Exact returned instance names (English): Onyxia's Lair, Blackwing Lair, Molten Core, Zul'Gurub, Ruins of Ahn'Qiraj, Naxxramas and Ahn'Qiraj
- Caveat: The instance names are not necessarily identical with the names returned from GetLFGTypeEntries().
- Added in 1.11
- 3.0.2: added instance difficulty. Difficulty > 1 indicates a heroic raid (25man version)
- 3.2.0: added locked, extended, instanceIDMostSig, isRaid, maxPlayers and difficultyName