Fandom

WoWWiki

API GetInstanceInfo

104,632pages on
this wiki
Add New Page
Talk0 Share

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.

WoW API < GetInstanceInfo

Returns information about the current instances the player is in.

name, type, difficultyIndex, difficultyName, maxPlayers, dynamicDifficulty,
    isDynamic, mapID = GetInstanceInfo()

Returns Edit

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. Many of the following result values will be nil or otherwise useless in the case of "none".
difficultyIndex 
Number - the difficulty of the instance (see Details)
difficultyName 
String - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)
maxPlayers 
Number - maximum number of players permitted inside
dynamicDifficulty 
Number - For dynamic instances: 0=Normal 1=Heroic
isDynamic 
boolean - If the instance difficulty can be changed while zoned in
mapID 
Number - the map id for the instance InstanceMapID. not the same as MapID.

Details Edit

NotesEdit

  • difficultyIndex "difficulty level" is the difficulty mode like 10 / 25 player and described in GetInstanceDifficulty()
  • Is isDynamic is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly.
  • mapID allows absolute identification of current instance without using localized names or other more complex means.

PatchesEdit

  • Added in 3.2, additional return values added in 3.3
  • In dynamic instances, difficultyIndex will only be 1 for 10man, or 2 25man.
  • In 5.0.4 dynamicDifficulty and difficultyIndex have changed. difficultyIndex is now used to determine a dynamic instance like heroic as well as 10 / 25 modes. dynamicDifficulty returns 0.
  • With 5.0.4 continents are considered 'instances', so when not inside an instance you are in a continent 'instance'.
  • mapID added in Patch 5.0.4

Also on Fandom

Random Wiki