m
Move page script moved page API GetCompanionInfo to WoW:API GetCompanionInfo without leaving a redirect
m (Move page script moved page API GetCompanionInfo to WoW:API GetCompanionInfo without leaving a redirect) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| 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. | ||
== | == 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: | |||
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 | 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 | ||
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 | ||
| Line 54: | 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. | |||