WoW:API GetInstanceInfo - Revision history

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

2023-08-15T04:46:00Z

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

← Older revision

Revision as of 04:46, 15 August 2023

WoWWiki>NightnessDev at 05:06, 20 December 2018

2018-12-20T05:06:57Z

← Older revision		Revision as of 05:06, 20 December 2018
Line 8:		Line 8:
	== Returns ==		== Returns ==
	# name (string) - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)		# name (string) - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
	# type (string) - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for ~~battleground~~. Many of following result values will be nil or otherwise useless in the case of "none".		# type (string) - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battlegrounds, "arena" for arenas. Many of following result values will be nil or otherwise useless in the case of "none".
	# difficultyIndex (number) - the difficulty of the instance (see Details)		# difficultyIndex (number) - the difficulty of the instance (see Details)
	# difficultyName (string) - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)		# difficultyName (string) - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)

103.93.70.168 at 10:53, 20 February 2018

2018-02-20T10:53:56Z

← Older revision		Revision as of 10:53, 20 February 2018
Line 4:		Line 4:

	name, type, difficultyIndex, difficultyName, maxPlayers,		name, type, difficultyIndex, difficultyName, maxPlayers,
	dynamicDifficulty, isDynamic, instanceMapId = GetInstanceInfo()		dynamicDifficulty, isDynamic, instanceMapId, lfgID = GetInstanceInfo()

	== Returns ==		== Returns ==
	# name (string) - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)		# name (string) - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
	# type (string) - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of following result values will be nil or otherwise useless in the case of "none".		# type (string) - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of following result values will be nil or otherwise useless in the case of "none".
	# difficultyIndex (number) - the difficulty of the instance (see Details)		# difficultyIndex (number) - the difficulty of the instance (see Details)
	# difficultyName (string) - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)		# difficultyName (string) - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)
Line 15:		Line 15:
	# isDynamic (Boolean) - If the instance difficulty can be changed while zoned in		# isDynamic (Boolean) - If the instance difficulty can be changed while zoned in
	# instanceMapID (number) - [[InstanceMapID]] for the instance. not the same as [[MapID]].		# instanceMapID (number) - [[InstanceMapID]] for the instance. not the same as [[MapID]].
			# lfgID (number)

	== Details ==		== Details ==

Bear at 21:20, 15 August 2017

2017-08-15T21:20:19Z

← Older revision		Revision as of 21:20, 15 August 2017
Line 3:		Line 3:
	Returns information about the current instances the player is in.		Returns information about the current instances the player is in.

	name, type, difficultyIndex, difficultyName, maxPlayers, dynamicDifficulty, isDynamic = GetInstanceInfo()		name, type, difficultyIndex, difficultyName, maxPlayers,
			dynamicDifficulty, isDynamic, instanceMapId = GetInstanceInfo()

	=== Returns ===		== Returns ==
	:;name ~~: String~~ - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)		# name (string) - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
	:;type ~~: String~~ - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of ~~the~~ following result values will be nil or otherwise useless in the case of "none".		# type (string) - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of following result values will be nil or otherwise useless in the case of "none".
	:;difficultyIndex ~~: Number~~ - the difficulty of the instance (see Details)		# difficultyIndex (number) - the difficulty of the instance (see Details)
	:;difficultyName ~~: String~~ - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)		# difficultyName (string) - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)
	:;maxPlayers ~~: Number~~ - maximum number of players permitted inside		# maxPlayers (number) - maximum number of players permitted inside
	:;dynamicDifficulty ~~: Number~~ - For dynamic instances: 0=Normal 1=Heroic		# dynamicDifficulty (number) - For dynamic instances: 0=Normal 1=Heroic
	:;isDynamic ~~: boolean~~ - If the instance difficulty can be changed while zoned in		# isDynamic (Boolean) - If the instance difficulty can be changed while zoned in
			# instanceMapID (number) - [[InstanceMapID]] for the instance. not the same as [[MapID]].

	==Details==		== Details ==

			== Notes ==
			* difficultyIndex "difficulty level" is the difficulty mode like 10 / 25 player and described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]
			* Is isDynamic is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly.
			* mapID allows absolute identification of current instance without using localized names or other more complex means.

			== Patches ==
	* Added in 3.2, additional return values added in 3.3		* Added in 3.2, additional return values added in 3.3
	* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]
	* isDynamic is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly.
	* In dynamic instances, difficultyIndex will only be 1 for 10man, or 2 25man.		* In dynamic instances, difficultyIndex will only be 1 for 10man, or 2 25man.
			* In 5.0.4 dynamicDifficulty and difficultyIndex have changed. difficultyIndex is now used to determine a dynamic instance like heroic as well as 10 / 25 modes. dynamicDifficulty returns 0.
			* With 5.0.4 continents are considered 'instances', so when not inside an instance you are in a continent 'instance'.
			* mapID added in [[Patch 5.0.4]]

WoWWiki>WoWWiki-Waldo at 19:23, 24 March 2010

2010-03-24T19:23:13Z

← Older revision		Revision as of 19:23, 24 March 2010
Line 3:		Line 3:
	Returns information about the current instances the player is in.		Returns information about the current instances the player is in.

	name, type, difficultyIndex, difficultyName, maxPlayers, ~~playerDifficulty~~, isDynamic = GetInstanceInfo()		name, type, difficultyIndex, difficultyName, maxPlayers, dynamicDifficulty, isDynamic = GetInstanceInfo()

	=== Returns ===		=== Returns ===
Line 9:		Line 9:
	:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of the following result values will be nil or otherwise useless in the case of "none".		:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of the following result values will be nil or otherwise useless in the case of "none".
	:;difficultyIndex : Number - the difficulty of the instance (see Details)		:;difficultyIndex : Number - the difficulty of the instance (see Details)
	:;difficultyName : String - the difficulty of the instance		:;difficultyName : String - the difficulty of the instance ("10 Player", "25 Player (Heroic)", etc)
	:;maxPlayers : Number - maximum number of players permitted inside		:;maxPlayers : Number - maximum number of players permitted inside
	:;~~playerDifficulty~~ : ? - ?		:;dynamicDifficulty : Number - For dynamic instances: 0=Normal 1=Heroic
	:;isDynamic : ? - ?		:;isDynamic : boolean - If the instance difficulty can be changed while zoned in

	==Details==		==Details==
Line 18:		Line 18:
	* Added in 3.2, additional return values added in 3.3		* Added in 3.2, additional return values added in 3.3
	* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]		* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]
	* isDynamic ~~(presumably a boolean value)~~ is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly. ~~As of this writing~~, ~~none of those modes are unlocked yet~~.		* isDynamic is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly.
			* In dynamic instances, difficultyIndex will only be 1 for 10man, or 2 25man.

WoWWiki>Farmbuyer: updated for 3.3, removed silly "patch changes" section (why would those not be the normal description now?)

2009-12-26T22:02:04Z

updated for 3.3, removed silly "patch changes" section (why would those not be the normal description now?)

← Older revision		Revision as of 22:02, 26 December 2009
Line 3:		Line 3:
	Returns information about the current instances the player is in.		Returns information about the current instances the player is in.

	name, type, ~~difficulty~~, difficultyName = GetInstanceInfo()		name, type, difficultyIndex, difficultyName, maxPlayers, playerDifficulty, isDynamic = GetInstanceInfo()

	=== Returns ===		=== Returns ===
	:;name : String - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)		:;name : String - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
	:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground		:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground. Many of the following result values will be nil or otherwise useless in the case of "none".
	:;~~difficulty~~ : Number - the difficulty of the instance		:;difficultyIndex : Number - the difficulty of the instance (see Details)
	:;difficultyName : String - the difficulty of the instance		:;difficultyName : String - the difficulty of the instance
			:;maxPlayers : Number - maximum number of players permitted inside
			:;playerDifficulty : ? - ?
			:;isDynamic : ? - ?

	==Details==		==Details==

	* Added in 3.2		* Added in 3.2, additional return values added in 3.3
	* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]		* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]
			* isDynamic (presumably a boolean value) is only useful in places like Icecrown Citadel where the difficulty mode can be changed on the fly. As of this writing, none of those modes are unlocked yet.
	~~==Patch changes==~~
	~~In 3.3, the returns were changed to:~~

	~~instanceName, instanceType, difficultyIndex, difficultyName, maxNumberOfPlayers, ?, dynamicInstance = GetInstanceInfo~~()

	~~dynamicInstance~~ is only ~~true~~ in ~~cases~~ like Icecrown Citadel where the difficulty mode can be changed on-the-fly.

WoWWiki>Kaydeethree: /* Patch changes */

2009-11-24T02:07:09Z

Patch changes

← Older revision		Revision as of 02:07, 24 November 2009
Line 15:		Line 15:
	* Added in 3.2		* Added in 3.2
	* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]		* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]

			==Patch changes==
			In 3.3, the returns were changed to:

			instanceName, instanceType, difficultyIndex, difficultyName, maxNumberOfPlayers, ?, dynamicInstance = GetInstanceInfo()

			dynamicInstance is only true in cases like Icecrown Citadel where the difficulty mode can be changed on-the-fly.

WoWWiki>Shakar: /* Returns */

2009-10-23T03:56:22Z

Returns

← Older revision		Revision as of 03:56, 23 October 2009
Line 6:		Line 6:

	=== Returns ===		=== Returns ===
	:;name : String - the name of the instance (localized)		:;name : String - the name of the instance (localized), otherwise the continent name (eg: Eastern Kingdoms, Kalimdor, Northrend, Outland)
	:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground		:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground
	:;difficulty : Number - the difficulty of the instance		:;difficulty : Number - the difficulty of the instance

WoWWiki>Angelike: /* Returns */

2009-09-11T15:13:02Z

Returns

← Older revision		Revision as of 15:13, 11 September 2009
Line 7:		Line 7:
	=== Returns ===		=== Returns ===
	:;name : String - the name of the instance (localized)		:;name : String - the name of the instance (localized)
	:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid		:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid, "pvp" for battleground
	:;difficulty : Number - the difficulty of the instance		:;difficulty : Number - the difficulty of the instance
	:;difficultyName : String - the difficulty of the instance		:;difficultyName : String - the difficulty of the instance

WoWWiki>Farmbuyer: link to getinstancedifficulty

2009-08-11T05:39:58Z

link to getinstancedifficulty

← Older revision		Revision as of 05:39, 11 August 2009
Line 7:		Line 7:
	=== Returns ===		=== Returns ===
	:;name : String - the name of the instance (localized)		:;name : String - the name of the instance (localized)
	:;type : String - "none" if the player is not in an instance, "party" if in party,		:;type : String - "none" if the player is not in an instance, "party" if in party, "raid" if in a raid
	:;difficulty : Number - the difficulty of the ~~raid~~ instance		:;difficulty : Number - the difficulty of the instance
	:;difficultyName : String - the difficulty of the ~~raid~~ instance		:;difficultyName : String - the difficulty of the instance

	==Details==		==Details==

	* Added in 3.2		* Added in 3.2
			* "difficulty of the instance" is described in [[API_GetInstanceDifficulty\|GetInstanceDifficulty()]]