API C_PetJournal.GetPetInfoBySpeciesID

From Wowpedia
Jump to: navigation, search

Returns information about a pet species.

speciesName, speciesIcon, petType, companionID, tooltipSource, tooltipDescription, isWild, canBattle, isTradeable, isUnique, obtainable, creatureDisplayID = C_PetJournal.GetPetInfoBySpeciesID(speciesID)

Arguments

speciesID 
Number - identifier for the pet species

Returns

Index Value Type Details
1 speciesName String Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.)
2 speciesIcon String Full path for the species' icon
3 petType Number Index of the species' pet type.
4 companionID Number NPC ID for the summoned companion pet.
5 tooltipSource String Section of the species tooltip that provides location information
6 tooltipDescription String Section of the species tooltip that provides pet description ("flavor text")
7 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.
8 canBattle Boolean True if this pet can be used in battles, false otherwise.
9 isTradeable Boolean True if this pet can be traded, false otherwise.
10 isUnique Boolean True if this pet is unique, false otherwise.
11 obtainable Boolean True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets).
12 creatureDisplayID Number Creature display ID of the species.

Patch history

Warlords of Draenor Patch 6.0.2 (2014-10-14): Added 12th return value, "creatureDisplayID".
Mists of Pandaria Patch 5.2.0 (2013-03-05): Added 11th return value, "obtainable".
Mists of Pandaria Patch 5.0.4 (2012-08-28): Added.

See also