WoW:API IsInInstance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(upgraded code block)
(Added "arena" return)
Line 17: Line 17:
==Details==
==Details==


: instanceType
:; instanceType
:: "none" when outside an instance
:: "none" when outside an instance
:: "pvp" when in a battleground
:: "pvp" when in a battleground
:: "arena" when in an arena
:: "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


: Needs more testing and documentation.
: Needs more testing and documentation.

Revision as of 00:10, 17 June 2007

WoW API < IsInInstance

Returns 1 if the player is in an instance and the type of instance.

inInstance, instanceType = IsInInstance()

Parameters

Returns

inInstance, instanceType
inInstance
Boolean - nil or 1
instanceType
String - see below


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.