WoW:API GetCompanionInfo: Difference between revisions

← Older edit

WoW:API GetCompanionInfo (source)

Revision as of 04:45, 15 August 2023

702 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
+Returns information about the companions you have.
+ creatureID, creatureName, creatureSpellID, icon, issummoned, mountTypeID = GetCompanionInfo("type", id)
+== Arguments ==
+;type
+: String ([[companionType]]) - Companion type to query: "CRITTER" or "MOUNT".
+;id
+: Integer - The slot id to query (starts at 1).
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
+== Returns ==
-Returns information about the companions you have.  New in [[Patch 3.0]]
+;creatureID
+: Integer - The NPC ID of the companion.
+;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
+: 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.
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+== Examples ==
- creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("type", id)
+;Example 1
+ for i=1,GetNumCompanions("CRITTER") do
+     local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
+     print(creatureID, creatureSpellID, creatureName, icon, issummoned)
+ end
+Prints all the information regarding your pets to the chat frame:
+Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1
+Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil
-== Parameters ==
+;Example 2
-=== Arguments ===
+ for i = 1, GetNumCompanions("MOUNT") do
-<!-- List each argument, together with its type -->
+     local _,name,_,_,_,typeID,typeString = GetCompanionInfo("mount", i)
-:("type")
+     -- 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
-:;type : String - The [[API TYPE TypeId|TypeID]] to query (e.g. "CRITTER", or "MOUNT")
+Prints the name of all of your mounts, followed by their mount type:
-:;id : Integer - The slot id to query (starts at 1).
+ Abyssal Seahorse Water
+ Black Drake Mount Flying
+ Ochre Skeletal Warhorse Ground
-=== Returns ===
+== Notes ==
-<!-- List each return value, together with its type -->
+* 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]].
-:;creatureID: Integer - The NPC ID of the companion.
+* This function was introduced in [[Patch 3.0]].
-:;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 ==
+;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.
-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.
+:There are many new '''C_PetJournal''' functions and I am unable to document them at this time.
-== 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
-     local creatureID, creatureName, creatureSpellID, icon, issummoned = GetCompanionInfo("CRITTER", i);
-     print(creatureID, creatureSpellID, creatureName, icon, issummoned)
- end
-<!-- end code -->
-====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.
-<!-- begin code -->
-Hawk Owl 10706 Interface\Icons\Ability_EyeOfTheOwl 1
-Great Horned Owl 10707 Interface\Icons\Ability_EyeOfTheOwl nil
-<!-- end code -->
-[[Category:World of Warcraft API]]