 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns information about a battle pet.
speciesID, customName, level, xp, maxXp, displayID, isFavorite, name, icon, petType, creatureID, sourceText, description, isWild, canBattle, tradable, unique, obtainable = C_PetJournal.GetPetInfoByPetID("petID")
Arguments
- petID
- String - Unique identifier for this specific pet
Returns
- speciesID
- Number - Identifier for the pet species
- customName
- String - Name assigned by the player or nil if unnamed
- level
- Number - The pet's current battle level
- xp
- Number - The pet's current xp
- maxXp
- Number - The pet's maximum xp
- displayID
- Number - The display ID of the pet
- isFavorite
- Boolean - Whether the pet is marked as a favorite
- name
- String - Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.)
- icon
- String - Full path for the species' icon
- petType
- Number - Index of the species' pet type
- creatureID
- Number - NPC ID for the summoned companion pet
- sourceText
- String - Section of the tooltip that provides location information
- description
- String - Section of the tooltip that provides pet description ("flavor text")
- isWild
- Boolean - For pets in the player's possession, true if the pet was caught in the wild. For pets not in the player's possession, true if the pet can be caught in the wild.
- canBattle
- Boolean - True if this pet can be used in battles, false otherwise.
- tradable
- Boolean - True if this pet can be traded, false otherwise.
- unique
- Boolean - True if this pet is unique, false otherwise.
- obtainable
- Boolean - True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets).
Patch history
Patch 5.2.0 (2013-03-05): Added 18th return value, "obtainable".
Patch 5.1.0 (2012-11-27): Added isFavorite return value.
Patch 5.0.4 (2012-08-28): Added.