WoW:API IsInInstance: Difference between revisions

Latest revision as of 04:46, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

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

inInstance, instanceType = IsInInstance()

"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

This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.

@@ Line 1: / Line 1: @@
-{{Stub/API}}
+{{wowapi}} __NOTOC__
-{{wowapi}}
+Checks whether the player is in an instance and the type of instance.
-Returns 1 if the player is in an instance and the type of instance.
   inInstance, instanceType = IsInInstance()
-== Parameters ==
+== Returns ==
+;inInstance : Boolean - Whether the player is in an instance; nil otherwise.
-<big>'''Returns'''</big>
+;instanceType : String - The instance type:
-:inInstance, instanceType
+;:* "none" when outside an instance
+;:* "pvp" when in a battleground
-:;inInstance : Boolean - nil or 1
+;:* "arena" when in an arena
-:;instanceType : String - see below
+;:* "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==
-:; instanceType
-:: "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
-: Needs more testing and documentation.
+== Details ==
+This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.