WoW API: GetInstanceInfo

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 < GetInstanceInfo

Returns information about the current instances the player is in.

name, type, difficulty, difficultyName = GetInstanceInfo()

Returns

name

String - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)

type

String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground

difficulty

Number - the difficulty of the instance

difficultyName

String - the difficulty of the instance

Details

• Added in 3.2
• "difficulty of the instance" is described in GetInstanceDifficulty()

Patch changes

In 3.3, the returns were changed to:

instanceName, instanceType, difficultyIndex, difficultyName, maxNumberOfPlayers, ?, dynamicInstance = GetInstanceInfo()

dynamicInstance is only true in cases like Icecrown Citadel where the difficulty mode can be changed on-the-fly.