WoW:API IsInInstance: Difference between revisions

WoW:API IsInInstance (source)

109 bytes added , 15 August 2023

m

Move page script moved page API IsInInstance to WoW:API IsInInstance without leaving a redirect

Anonymous user

@@ 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
-:: "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.