Get an Epic Experience with Premium

LibPetJournal-2.0

See All
Libraries Login to Add Favorites
  • 0 Likes
  • World of Warcraft
  • 1,047 Monthly Downloads
  • Supports: 5.2.0
  • 7,627 Total Downloads
  • Updated 05/04/2013
  • Created 09/03/2012
  • 5 Favorites
  • Project Site
  • Release Type: Release
  • License: MIT License
  • Newest File: 2.0.26
or

About LibPetJournal-2.0

Requires: LibStub, CallbackHandler-1.0

With 5.0 a new C_PetJournal API was introduced, and unfortunately the old GetCompanionInfo API no longer works properly (it does not, for example, know anything about non-combat pets obtained before the account-wide merge, and you also can no longer summon non-combat pets using it).

This library provides the list of player owned pet ids and all species ids, which can be used with C_PetJournal.GetPetInfoByPetID() and C_PetJournal.GetPetInfoBySpeciesID().

It primarily deals with two problems with scanning the pet journal:

  • Filters: The Pet Journal filters are cleared and then restored, as they affect the return values given from C_PetJournal.GetPetInfoByIndex()
  • Updating in response to event: Manipulating the Pet Journal filters causes PET_JOURNAL_LIST_UPDATE to fire, which is also the only event that always fires when you lose or gain a pet. Filter manipulation is detected and we never try to rescan pets in response. When this is not the case, a CallbackHandler event is fired which can be used to safely detect changes to the pet list.

Getting Started
API Documentation
WoWAce Thread

Example

local LibPetJournal = LibStub("LibPetJournal-2.0")
local function ScanPets()
    for _,petid in LibPetJournal:IteratePetIDs() do 
        local speciesID, customName, level, xp, maxXp, displayID, isFavorite, 
               name, icon, petType, creatureID, sourceText, description, isWild,
               canBattle, tradable, unique = C_PetJournal.GetPetInfoByPetID(petid)
        if name == "Feline Familiar" then
            print("Player has a cat in a hat.")
        end
    end
end
ScanPets()

If you wanted to automatically scan for little cats in hats when the pet list changes, you could register a callback, such as:

LibPetJournal.RegisterCallback(addon, "PetListUpdated", ScanPets)

Obviously you would normally use the speciesID or creatureID return values from C_PetJournal.GetPetInfoByPetID() to find a particular pet, but this is just a silly example.

2013-05-04  Robin Schoonover  <robin@cornhooves.org>

[b741c809b7bd] [2.0.26]
* LibPetJournal-2.0.lua

Bump minor.

First Previous Next Last
File Name Release Type Game Version Downloads Date
2.0.26 Release5.2.090505/04/2013
2.0.25 Release5.2.01,36503/05/2013
2.0.24.1 Release5.1.01,20612/30/2012
2.0.24 Release5.0.51,32510/26/2012
2.0.23 Release5.0.538110/25/2012
2.0.22 Release5.0.573910/10/2012
2.0.21 Release5.0.560509/28/2012
2.0.20 Release5.0.538609/23/2012
2.0.19 Release5.0.5409/23/2012
2.0.18 Release5.0.58109/19/2012
2.0.17 Release5.0.51309/19/2012
2.0.16 Release5.0.56509/16/2012
2.0.15 Release5.0.56409/13/2012
2.0.14 Release5.0.46609/11/2012
First Previous Next Last

Get a head start with Addon Packs

Browse now

Top Downloads

  1. Deadly Boss Mods
    Combat, PvP, and Boss Encounters
    999,752 Monthly Downloads
  2. Bagnon
    Bags & Inventory
    466,028 Monthly Downloads
  3. Auctioneer
    Mail, Tooltip, Bags & Inventory, Professions, and Auction & Economy
    340,607 Monthly Downloads
  4. Recount
    Combat
    314,809 Monthly Downloads
  5. HealBot Continued
    Healer and Unit Frames
    293,027 Monthly Downloads
See More
Login to Curse

Don't have an account? Create One.

Get an epic experience with Curse Premium
  • Faster addon downloads
  • Premium-Only Beta Giveaways
  • Ad-Free Curse experience
  • Premium Curse Client
  • and many More Features
  • Learn More »

Infinite Crisis NA

Get Your Preferred Access Code!