WoW:API IsInInstance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 20: Line 20:
==Details==
==Details==


: instanceType is normally "none" when outside of an instance or inside an Arena (in 2.0.1) but is "pvp" when inside a battleground and "party" when inside a 5-man instance, have not tested with raid instances yet.
: 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.
: Needs more testing and documentation.

Revision as of 16:31, 25 April 2007

WoW API < IsInInstance


Returns 1 if the player is in an instance and the type of instance. Template:Code/Begin inInstance, instanceType = IsInInstance() Template:Code/End


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
"party" when in a 5-man instance
"raid" when in a raid instance
Needs more testing and documentation.