Returns instance information about the current area


See also Instance functions.

Signature:

name, type, difficulty, difficultyName, maxPlayers, playerDifficulty, isDynamicInstance, mapID, instanceGroupSize = GetInstanceInfo()

Returns:

  • name - Name of the instance or world area (string)

  • type - Type of the instance (string)

    • arena - A PvP Arena instance
    • none - Normal world area (e.g. Northrend, Kalimdor, Deeprun Tram)
    • party - An instance for 5-man groups
    • pvp - A PvP battleground instance
    • raid - An instance for raid groups
    • scenario - A scenario instance

  • difficulty - Difficulty setting of the instance (number)

    • 0 - None; not in an Instance.
    • 1 - 5-player Instance.
    • 2 - 5-player Heroic Instance.
    • 3 - 10-player Raid Instance.
    • 4 - 25-player Raid Instance.
    • 5 - 10-player Heroic Raid Instance.
    • 6 - 25-player Heroic Raid Instance.
    • 7 - Raid Finder Instance.
    • 8 - Challenge Mode Instance.
    • 9 - 40-player Raid Instance.
    • 10 - Not used.
    • 11 - Heroic Scenario Instance.
    • 12 - Scenario Instance.
    • 13 - Not used.
    • 14 - Flexible Raid.

  • difficultyName - String representing the difficulty of the instance. E.g. "10 Player" (string)

  • maxPlayers - Maximum number of players allowed in the instance (number)

  • playerDifficulty - Unknown (number)

  • isDynamicInstance - True for raid instances that can support multiple maxPlayers values (10 and 25) - eg. ToC, DS, ICC, etc (boolean)

  • mapID - (number)

  • instanceGroupSize - maxPlayers for fixed size raids, holds the actual raid size for the new flexible raid (between (8?)10 and 25) (number)