WoW:API IsInInstance - Revision history

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

2023-08-15T04:46:44Z

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

← Older revision

Revision as of 04:46, 15 August 2023

WoWWiki>Anonyma1: /* Returns */

2012-10-31T15:51:09Z

Returns

← Older revision		Revision as of 15:51, 31 October 2012
Line 11:		Line 11:
	;:* "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
			;:* nil when in an unknown kind of instance, eg. in a scenario

	== Details ==		== Details ==
	This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.		This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.

WoWWiki>Starlightblunder at 22:22, 30 July 2009

2009-07-30T22:22:09Z

← Older revision		Revision as of 22:22, 30 July 2009
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()

	~~== Arguments ==~~
	~~:none~~


	== Returns ==		== Returns ==
	~~:inInstance, instanceType~~		;inInstance : Boolean - Whether the player is in an instance; nil otherwise.
			;instanceType : String - The instance type:
	:;inInstance : [[Boolean]] - Whether the player is in an instance		;:* "none" when outside an instance
	:;instanceType : String - The instance type		;:* "pvp" when in a battleground
	:;:* "none" when outside an instance		;:* "arena" when in an arena
	:;:* "pvp" when in a battleground		;:* "party" when in a 5-man instance
	:;:* "arena" when in an arena		;:* "raid" when in a raid instance
	:;:* "party" when in a 5-man instance
	:;:* "raid" when in a raid instance

	== Details ==		== Details ==
	This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.		This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.

WoWWiki>Valana: Added a remark.

2008-06-24T02:38:32Z

Added a remark.

← Older revision		Revision as of 02:38, 24 June 2008
Line 19:		Line 19:
	:;:* "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

			== Details ==
			This functon returns correct results immediately upon PLAYER_ENTERING_WORLD.

WoWWiki>Ravas: Updated to match the current API boilerplate.

2007-06-25T18:27:49Z

Updated to match the current API boilerplate.

← Older revision		Revision as of 18:27, 25 June 2007
Line 1:		Line 1:
	~~{{Stub/API}}~~		{{wowapi}} __NOTOC__
	{{wowapi}}

	~~Returns 1 if~~ 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()

	== ~~Parameters~~ ==		== Arguments ==
			:none

	~~<big>'''~~Returns~~'''</big>~~
			== Returns ==
	:inInstance, instanceType		:inInstance, instanceType

	:;inInstance : Boolean - ~~nil or 1~~		:;inInstance : [[Boolean]] - Whether the player is in an instance
	:;instanceType : String - ~~see below~~		:;instanceType : String - The instance type
			:;:* "none" when outside an instance
			:;:* "pvp" when in a battleground
	~~==Details==~~		:;:* "arena" when in an arena
			:;:* "party" when in a 5-man instance
	:; ~~instanceType~~		:;:* "raid" when in a raid instance
	:: "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.~~

WoWWiki>Gnarfoz: Added "arena" return

2007-06-17T00:10:41Z

Added "arena" return

← Older revision		Revision as of 00:10, 17 June 2007
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.

WoWWiki>Hobinheim: upgraded code block

2007-05-16T16:03:00Z

upgraded code block

← Older revision		Revision as of 16:03, 16 May 2007
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 ==

WoWWiki>Kaelten at 16:31, 25 April 2007

2007-04-25T16:31:49Z

← Older revision		Revision as of 16:31, 25 April 2007
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.

WoWWiki>Fandyllic at 01:17, 27 December 2006

2006-12-27T01:17:00Z

← Older revision		Revision as of 01:17, 27 December 2006
Line 1:		Line 1:
			{{Stub/API}}
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__

Line 22:		Line 23:

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

	~~{{Stub/API}}~~

WoWWiki>Arrowmaster at 10:16, 20 December 2006

2006-12-20T10:16:20Z

New page

{{wowapi}} __NOTOC__

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

== Parameters ==

<big>'''Returns'''</big>
:inInstance, instanceType

:;inInstance : Boolean - nil or 1
:;instanceType : String - see below

==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.

: Needs more testing and documentation.

{{Stub/API}}