WoW API: GetSavedInstanceInfo

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

→ WoW API

← 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

index

Number - index of the saved instance, ranges from 1 to 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

• 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