WoW:API GetCompanionInfo - Revision history

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

2023-08-15T04:45:49Z

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

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Draewind: /* Notes */

2014-08-21T03:33:10Z

Notes

← Older revision		Revision as of 03:33, 21 August 2014
Line 52:		Line 52:
	* If called before the client updates the creature cache, GetCompanionInfo returns companions in the order in which they were learned by the current character (this can be observed during the first log-on after a patch or by removing the client's cache files). Once the cache is updated, however, it returns companions in alphabetical order; a COMPANION_UPDATE event is fired to notify of this update (however, multiple COMPANION_UPDATE events may be fired prior to the update as well). This was last verified in [[Patch 3.3.0a]].		* If called before the client updates the creature cache, GetCompanionInfo returns companions in the order in which they were learned by the current character (this can be observed during the first log-on after a patch or by removing the client's cache files). Once the cache is updated, however, it returns companions in alphabetical order; a COMPANION_UPDATE event is fired to notify of this update (however, multiple COMPANION_UPDATE events may be fired prior to the update as well). This was last verified in [[Patch 3.3.0a]].
	* This function was introduced in [[Patch 3.0]].		* This function was introduced in [[Patch 3.0]].

			;This command will be removed in the WoD 6.0 API and replaced with:
			:mountName, spellID, icon, active, mountFlags = '''C_MountJournal.GetMountInfo'''(index)
			:creatureID no longer is given at the beginning of the return list.

			:There are many new '''C_PetJournal''' functions and I am unable to document them at this time.

Bear: /* Examples */

2014-03-18T06:16:18Z

Examples

← Older revision		Revision as of 06:16, 18 March 2014
Line 23:		Line 23:
	: Integer - 15 and 31 (0x0f and 0x1f) for flying mounts, 29 (0x1d) for ground mounts, 12 (0x0c) for water mounts and nil for companions. Difference between flying mount values unknown.		: Integer - 15 and 31 (0x0f and 0x1f) for flying mounts, 29 (0x1d) for ground mounts, 12 (0x0c) for water mounts and nil for companions. Difference between flying mount values unknown.

	== ~~Example~~ ==		== Examples ==
			;Example 1
	for i=1,GetNumCompanions("CRITTER") do		for i=1,GetNumCompanions("CRITTER") do
	local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);		local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
	print(creatureID, creatureSpellID, creatureName, icon, issummoned)		print(creatureID, creatureSpellID, creatureName, icon, issummoned)
	end		end
			Prints all the information regarding your pets to the chat frame:
	~~===Result===~~
	:Prints all the information regarding your pets to the chat frame.
	7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1		7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1
	7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil		7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil

	== Example 2 ==		;Example 2
	for i = 1, GetNumCompanions("MOUNT") do		for i = 1, GetNumCompanions("MOUNT") do
	local _,name,_,_,_,typeID,typeString = GetCompanionInfo("mount", i)		local _,name,_,_,_,typeID,typeString = GetCompanionInfo("mount", i)
Line 45:		Line 44:
	end		end

	~~===Result===~~		Prints the name of all of your mounts, followed by their mount type:
	:Prints the name of all of your mounts, followed by their mount type.
	Abyssal Seahorse Water		Abyssal Seahorse Water
	Black Drake Mount Flying		Black Drake Mount Flying

86.27.152.121: /* Example 2 */

2014-03-02T17:53:22Z

Example 2

← Older revision		Revision as of 17:53, 2 March 2014
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns information about the companions you have.		Returns information about the companions you have.
	creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("type", id)		creatureID, creatureName, creatureSpellID, icon, issummoned, mountTypeID = GetCompanionInfo("type", id)

	== Arguments ==		== Arguments ==
	;type : String ([[companionType]]) - Companion type to query: "CRITTER" or "MOUNT".		;type
	;id : Integer - The slot id to query (starts at 1).		: String ([[companionType]]) - Companion type to query: "CRITTER" or "MOUNT".
			;id
			: Integer - The slot id to query (starts at 1).

	== Returns ==		== Returns ==
	;creatureID: Integer - The NPC ID of the companion.		;creatureID
	;creatureName: String - The name of the companion.		: Integer - The NPC ID of the companion.
	;creatureSpellID: Integer - The spell ID to cast the companion. This is not passed to [[API CallCompanion\|CallCompanion]], but can be used with, e.g., [[API GetSpellInfo\|GetSpellInfo]].		;creatureName
	;icon: String - The texture of the icon for the companion.		: String - The name of the companion.
	;issummoned: Flag - 1 if the companion is summoned, nil if it's not		;creatureSpellID
			: Integer - The spell ID to cast the companion. This is not passed to [[API CallCompanion\|CallCompanion]], but can be used with, e.g., [[API GetSpellInfo\|GetSpellInfo]].
			;icon
			: String - The texture of the icon for the companion.
			;issummoned
			: Flag - 1 if the companion is summoned, nil if it's not
			;mountTypeID
			: Integer - 15 and 31 (0x0f and 0x1f) for flying mounts, 29 (0x1d) for ground mounts, 12 (0x0c) for water mounts and nil for companions. Difference between flying mount values unknown.

	== Example ==		== Example ==
Line 23:		Line 32:
	:Prints all the information regarding your pets to the chat frame.		:Prints all the information regarding your pets to the chat frame.
	7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1		7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1
	7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil		7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil

			== Example 2 ==
			for i = 1, GetNumCompanions("MOUNT") do
			local _,name,_,_,_,typeID,typeString = GetCompanionInfo("mount", i)
			-- Assign local vars name and typeID from GetCompanionInfo(). Create unnasigned local var typeString.
			typeID = bit.band(3, typeID)
			-- Bitwise AND operator sets typeID to 0 for water, 1 for ground and 3 for flying mounts.
			typeString = typeID == 0 and "Water" or typeID == 1 and "Ground" or "Flying"
			-- Nested and..or operator to set typeString according to typeID.
			print(name, typeString)
			end

			===Result===
			:Prints the name of all of your mounts, followed by their mount type.
			Abyssal Seahorse Water
			Black Drake Mount Flying
			Ochre Skeletal Warhorse Ground

	== Notes ==		== Notes ==
	* If called before the client updates the creature cache, GetCompanionInfo returns companions in the order in which they were learned by the current character (this can be observed during the first log-on after a patch or by removing the client's cache files). Once the cache is updated, however, it returns companions in alphabetical order; a COMPANION_UPDATE event is fired to notify of this update (however, multiple COMPANION_UPDATE events may be fired prior to the update as well). This was last verified in [[Patch 3.3.0a]].		* If called before the client updates the creature cache, GetCompanionInfo returns companions in the order in which they were learned by the current character (this can be observed during the first log-on after a patch or by removing the client's cache files). Once the cache is updated, however, it returns companions in alphabetical order; a COMPANION_UPDATE event is fired to notify of this update (however, multiple COMPANION_UPDATE events may be fired prior to the update as well). This was last verified in [[Patch 3.3.0a]].
	* This function was introduced in [[Patch 3.0]].		* This function was introduced in [[Patch 3.0]].

WoWWiki>Starlightblunder at 23:40, 5 June 2010

2010-06-05T23:40:25Z

← Older revision		Revision as of 23:40, 5 June 2010
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
			Returns information about the companions you have.

	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~
	Returns information about the companions you have. ~~New in [[Patch 3.0]]~~

	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("type", id)		creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("type", id)

	~~== Parameters ==~~		== Arguments ==
	=== Arguments ===		;type : String ([[companionType]]) - Companion type to query: "CRITTER" or "MOUNT".
	<!-~~- List each argument, together with its~~ type ~~-->~~		;id : Integer - The slot id to query (starts at 1).
	:(~~"type"~~)

	~~:;type : String - The [[API TYPE TypeId\|TypeID]] to query (e.g. "CRITTER", or "MOUNT")~~		== Returns ==
	~~:;id : Integer - The slot id to query (starts at 1).~~		;creatureID: Integer - The NPC ID of the companion.
			;creatureName: String - The name of the companion.
	=== Returns ===		;creatureSpellID: Integer - The spell ID to cast the companion. This is not passed to [[API CallCompanion\|CallCompanion]], but can be used with, e.g., [[API GetSpellInfo\|GetSpellInfo]].
	~~<!-- List each return value, together with its type -->~~		;icon: String - The texture of the icon for the companion.
	:;creatureID: Integer - The NPC ID of the companion.		;issummoned: Flag - 1 if the companion is summoned, nil if it's not
	:;creatureName: String - The name of the companion.
	:;creatureSpellID: Integer - The spell ID to cast the companion. This is not passed to [[API CallCompanion\|CallCompanion]], but can be used with, e.g., [[API GetSpellInfo\|GetSpellInfo]].
	:;icon: String - The texture of the icon for the companion.
	:;issummoned: ~~integer~~ - 1 if the companion is summoned, nil if it's not

	~~== Known Issues ==~~

	If called early in the loading process, before [[Events/Companion\|COMPANION_UPDATE]] fires, GetCompanionInfo returns companions in the order that they were learned by the current character. After COMPANION_UPDATE has fired at least once, GetCompanionInfo returns companions in alphabetical order. This information is accurate as of WoW 3.1.2.

	== Example ==		== Example ==
	~~<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->~~
	~~<!-- begin code -->~~
	for i=1,GetNumCompanions("CRITTER") do		for i=1,GetNumCompanions("CRITTER") do
	local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);		local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
	print(creatureID, creatureSpellID, creatureName, icon, issummoned)		print(creatureID, creatureSpellID, creatureName, icon, issummoned)
	end		end
	~~<!-- end code -->~~

	====Result====		===Result===
	~~<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->~~
	:Prints all the information regarding your pets to the chat frame.		:Prints all the information regarding your pets to the chat frame.
	~~<!-- begin code -->~~
	7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1		7555 Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1
	7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil		7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil
	<!-~~- end code -->~~
	[[~~Category:World of Warcraft API~~]]		== Notes ==
			* If called before the client updates the creature cache, GetCompanionInfo returns companions in the order in which they were learned by the current character (this can be observed during the first log-on after a patch or by removing the client's cache files). Once the cache is updated, however, it returns companions in alphabetical order; a COMPANION_UPDATE event is fired to notify of this update (however, multiple COMPANION_UPDATE events may be fired prior to the update as well). This was last verified in [[Patch 3.3.0a]].
			* This function was introduced in [[Patch 3.0]].

WoWWiki>Egingell: /* Example */ There's no second argument for GetNumCompanions()

2009-08-27T00:27:08Z

Example: There's no second argument for GetNumCompanions()

← Older revision		Revision as of 00:27, 27 August 2009
Line 31:		Line 31:
	<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->		<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
	<!-- begin code -->		<!-- begin code -->
	for i=1,GetNumCompanions("CRITTER",1) do		for i=1,GetNumCompanions("CRITTER") do
	local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);		local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
	~~ChatFrame1:AddMessage~~(creatureID ~~.. " " ..~~ creatureSpellID ~~.. " " ..~~ creatureName ~~.. " " ..~~ icon ~~.. " " ..~~ issummoned) end		print(creatureID, creatureSpellID, creatureName, icon, issummoned)
			end
	<!-- end code -->		<!-- end code -->

WoWWiki>Hazara Khan: Fixed typo in example code.

2009-06-15T16:24:50Z

Fixed typo in example code.

← Older revision		Revision as of 16:24, 15 June 2009
Line 31:		Line 31:
	<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->		<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
	<!-- begin code -->		<!-- begin code -->
	for i=1,GetNumCompanions("CRITTER"),1 do		for i=1,GetNumCompanions("CRITTER",1) do
	local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);		local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
	ChatFrame1:AddMessage(creatureID .. " " .. creatureSpellID .. " " .. creatureName .. " " .. icon .. " " .. issummoned) end		ChatFrame1:AddMessage(creatureID .. " " .. creatureSpellID .. " " .. creatureName .. " " .. icon .. " " .. issummoned) end

WoWWiki>Jamash: add known issue

2009-05-20T10:00:06Z

add known issue

← Older revision		Revision as of 10:00, 20 May 2009
Line 23:		Line 23:
	:;icon: String - The texture of the icon for the companion.		:;icon: String - The texture of the icon for the companion.
	:;issummoned: integer - 1 if the companion is summoned, nil if it's not		:;issummoned: integer - 1 if the companion is summoned, nil if it's not

			== Known Issues ==

			If called early in the loading process, before [[Events/Companion\|COMPANION_UPDATE]] fires, GetCompanionInfo returns companions in the order that they were learned by the current character. After COMPANION_UPDATE has fired at least once, GetCompanionInfo returns companions in alphabetical order. This information is accurate as of WoW 3.1.2.

	== Example ==		== Example ==
Line 39:		Line 43:
	7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil		7553 Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil
	<!-- end code -->		<!-- end code -->

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Farmbuyer: Clarify spell ID return value

2009-02-20T04:12:58Z

Clarify spell ID return value

← Older revision		Revision as of 04:12, 20 February 2009
Line 20:		Line 20:
	:;creatureID: Integer - The NPC ID of the companion.		:;creatureID: Integer - The NPC ID of the companion.
	:;creatureName: String - The name of the companion.		:;creatureName: String - The name of the companion.
	:;creatureSpellID: Integer - The ~~Spell~~ ID to cast the companion.		:;creatureSpellID: Integer - The spell ID to cast the companion. This is not passed to [[API CallCompanion\|CallCompanion]], but can be used with, e.g., [[API GetSpellInfo\|GetSpellInfo]].
	:;icon: String - The texture of the icon for the companion.		:;icon: String - The texture of the icon for the companion.
	:;issummoned: integer - 1 if the companion is summoned, nil if it's not		:;issummoned: integer - 1 if the companion is summoned, nil if it's not

WoWWiki>ECaine: /* Example */ : Fixed code to match result

2009-02-15T06:50:13Z

Example: : Fixed code to match result

← Older revision		Revision as of 06:50, 15 February 2009
Line 29:		Line 29:
	for i=1,GetNumCompanions("CRITTER"),1 do		for i=1,GetNumCompanions("CRITTER"),1 do
	local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);		local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
	ChatFrame1:AddMessage(creatureID .. " " .. creatureSpellID .. " " .. creatureName .. " " .. icon) end		ChatFrame1:AddMessage(creatureID .. " " .. creatureSpellID .. " " .. creatureName .. " " .. icon .. " " .. issummoned) end
	<!-- end code -->		<!-- end code -->