API GetSavedInstanceInfo

From Wowpedia
Jump to: navigation, search

Returns information about an instance for which the player has saved lockout data.

name, id, reset, difficulty, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress = GetSavedInstanceInfo(index)

Parameters

index 
Number - index of the saved instance, 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().
  • The difficulty returned can be further queried by GetDifficultyInfo(); that page has further information about the possible values.

Patch History

Cataclysm Patch 4.0.1 (2010-10-12): Added numEncounters and encounterProgress


Wrath of the Lich King Patch 3.2.0 (2009-08-04): Added locked, extended, instanceIDMostSig, isRaid, maxPlayers and difficultyName


Wrath of the Lich King Patch 3.0.2 (2008-10-14): Added instance difficulty. Difficulty > 1 indicates a heroic raid (25-man version)


WoW Icon update.png Patch 1.11.0 (2006-06-20): Added.

See also