WoW API: IsInInstance

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

Checks whether 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
• nil when in an unknown kind of instance, eg. in a scenario

Details

This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.