IsInInstance

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
Blizzard Docs  Townlong Yak  Offline /api  Wowprogramming  GitHub Search
Info
Added in 1.11.0 / 1.13.2

Returns true if the player is in an instance, and the type of instance.

inInstance, instanceType = IsInInstance()

Returns

inInstance

boolean - Whether the player is in an instance; nil otherwise.

instanceType

string - The instance type:

• "none" when outside an instance
• "pvp" when in a battleground
• "arena" when in an arena
• "party" when in a 5-man instance
• "raid" when in a raid instance
• "scenario" when in a scenario

Details

This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.