WoW:API GetSavedInstanceInfo: Difference between revisions
Jump to navigation
Jump to search
m (Move page script moved page API GetSavedInstanceInfo to API GetSavedInstanceInfo without leaving a redirect) |
|||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 3: | Line 3: | ||
Returns information about the instances the player is saved to. | Returns information about the instances the player is saved to. | ||
name, | name, id, reset, difficulty, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress | ||
= GetSavedInstanceInfo(index) | |||
== Parameters == | == Parameters == | ||
;index : Number - index of the saved instance, ranges from 1 to [[API_GetNumSavedInstances|GetNumSavedInstances]]() | |||
== Returns == | |||
;name : String - the name of the instance | |||
;id : Number - the ID of the instance | |||
;reset : 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) | |||
;numEncounters : Number - number of boss encounters in this instance | |||
;encounterProgress : Number - farthest boss encounter in this instance for player | |||
==Details== | ==Details== | ||
* 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 | ||
* 3.0.2: added instance difficulty. Difficulty > 1 indicates a heroic raid (25-man version) | |||
* 3.0.2: added instance difficulty. Difficulty > 1 indicates a heroic raid ( | * 3.2.0: added locked, extended, instanceIDMostSig, isRaid, maxPlayers and difficultyName | ||
* 4.0.1: added numEncounters and encounterProgress | |||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetSavedInstanceInfo
Returns information about the instances the player is saved to.
name, id, reset, difficulty, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress = GetSavedInstanceInfo(index)
Parameters[edit]
- index
- Number - index of the saved instance, ranges from 1 to GetNumSavedInstances()
Returns[edit]
- name
- String - the name of the instance
- id
- Number - the ID of the instance
- reset
- 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)
- numEncounters
- Number - number of boss encounters in this instance
- encounterProgress
- Number - farthest boss encounter in this instance for player
Details[edit]
- 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 (25-man version)
- 3.2.0: added locked, extended, instanceIDMostSig, isRaid, maxPlayers and difficultyName
- 4.0.1: added numEncounters and encounterProgress