API GetInstanceInfo

Returns information about the current instances the player is in.

name, instanceType, difficultyIndex, difficultyName, maxPlayers, dynamicDifficulty, isDynamic = GetInstanceInfo

Returns

 * name : String - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
 * instanceType : 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

Details

 * Added in 3.2, additional return values added in 3.3
 * "difficulty of the instance" is described in GetInstanceDifficulty
 * isDynamic is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly.
 * In dynamic instances, difficultyIndex will only be 1 for 10man, or 2 25man.