WoW:API IsInInstance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(upgraded code block)
Line 1: Line 1:
{{Stub/API}}
{{Stub/API}}
{{wowapi}} __NOTOC__
{{wowapi}}
 


Returns 1 if 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.
{{Code/Begin}}
inInstance, instanceType = IsInInstance()
{{Code/End}}


inInstance, instanceType = IsInInstance()


== Parameters ==
== Parameters ==

Revision as of 16:03, 16 May 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
"party" when in a 5-man instance
"raid" when in a raid instance
Needs more testing and documentation.