WoW:API IsInInstance: Difference between revisions
Jump to navigation
Jump to search
(Updated to match the current API boilerplate.) |
m (Move page script moved page API IsInInstance to API IsInInstance without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Checks whether the player is in an instance and the type of instance. | Checks whether the player is in an instance and the type of instance. | ||
inInstance, instanceType = IsInInstance() | inInstance, instanceType = IsInInstance() | ||
== Returns == | == 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. | |||
Latest revision as of 04:46, 15 August 2023
← WoW API < IsInInstance
Checks whether the player is in an instance and the type of instance.
inInstance, instanceType = IsInInstance()
Returns[edit]
- 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[edit]
This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.