WoW:API IsInInstance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated to match the current API boilerplate.)
m (Added a remark.)
Line 19: Line 19:
:;:* "party" when in a 5-man instance
:;:* "party" when in a 5-man instance
:;:* "raid" when in a raid instance
:;:* "raid" when in a raid instance
== Details ==
This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.

Revision as of 02:38, 24 June 2008

WoW API < IsInInstance

Checks whether the player is in an instance and the type of instance.

inInstance, instanceType = IsInInstance()

Arguments

none


Returns

inInstance, instanceType
inInstance
Boolean - Whether the player is in an instance
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

Details

This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.