GetSavedInstanceInfo

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 1.11.0 / 1.13.2

Returns instance lock info.

name, lockoutId, reset, difficultyId, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress, extendDisabled, instanceId = GetSavedInstanceInfo(index)

Arguments

index

number - index of the saved instance, from 1 to GetNumSavedInstances()

Returns

1. name

string - the name of the instance

2. lockoutId

number - the ID of the instance lockout

3. reset

number - the number of seconds remaining until the instance resets

4. difficultyId

number : DifficultyID

5. locked

boolean - true if the instance is currently locked, false for a historic entry

6. extended

boolean - shows true if the ID has been extended

7. instanceIDMostSig

number - unknown

8. isRaid

boolean - shows true if it is a raid

9. maxPlayers

number - shows the max players

10. difficultyName

string - shows a localized string i.e. 10 Player (Heroic)

11. numEncounters

number - number of boss encounters in this instance

12. encounterProgress

number - farthest boss encounter in this instance for player

13. extendDisabled

boolean - returns whether this instance cannot be disabled

14. instanceId

number : InstanceID

Patch changes

Patch 10.0.5 (2023-01-24): Added instanceId
Patch 4.0.1 (2010-10-12): Added numEncounters and encounterProgress
Patch 3.2.0 (2009-08-04): Added locked, extended, instanceIDMostSig, isRaid, maxPlayers and difficultyName
Patch 3.0.2 (2008-10-14): Added instance difficulty. Difficulty > 1 indicates a heroic raid (25-man version)
Patch 1.11.0 (2006-06-19): Added.

See also

• GetInstanceLockTimeRemaining - Older, more limited version of this function
• GetNumSavedInstances - Counts number of instances this function applies to
• GetSavedInstanceEncounterInfo - A more specific function; this lets you check up on the individual encounters within a given saved instance
• GetSavedWorldBossInfo - A similar function to this, except for the player's saved world boss lockout data
• GetLFGDungeonInfo - A moderately similar function to this function, except it works off of dungeon IDs instead of saved instance indexes. It can also return Raid Finder instance info, unlike this function.
• GetRFDungeonInfo - Nearly identical to GetLFGDungeonInfo, except it uses Raid Finder indexes instead of dungeon IDs