-- PokeHuntLog: notices tames, pet levels, renames and stabled pets. -- -- Tame detection: -- * With SuperWoW, UNIT_CASTEVENT tells us the player cast Tame Beast (spell 1515) and on which creature. -- * Without it, SPELLCAST_START / SPELLCAST_CHANNEL_START with the spell name "Tame Beast" does, and the -- current target is the beast. -- Either way the beast's details are remembered, and when a pet of that family and level appears soon -- after (UNIT_PET, or its name arriving), it counts as a new tame. The pet's own name is no help: here a -- new pet is named after its family, not the beast. local HPL = PokeHuntLog local pending = nil -- beast being tamed: { name, family, ctype, level, zone, npcIds, time } local lastBeast = nil -- last beast targeted, in case the cast event arrives after the target changed local renameTo = nil -- { name, time } set when the player renames their pet local activeGuid = nil -- SuperWoW GUID of the pet that was out at the last scan local retries = 0 local function UnitIsBeastCandidate(unit) if not UnitExists(unit) then return false end if UnitIsPlayer(unit) or UnitPlayerControlled(unit) then return false end return UnitCreatureFamily(unit) ~= nil end local function CaptureBeast(unit) if not UnitIsBeastCandidate(unit) then return nil end local info = { name = UnitName(unit), family = UnitCreatureFamily(unit), ctype = UnitCreatureType(unit), level = UnitLevel(unit), zone = GetRealZoneText(), time = GetTime(), } local guid = HPL.UnitGuid(unit) if guid then info.guid = guid info.npcIds = HPL.NpcIdsFromGuid(guid) end return info end local function StartTame(unit) local info = CaptureBeast(unit or "target") if not info and lastBeast and GetTime() - lastBeast.time < 30 then info = lastBeast end if info then info.time = GetTime() pending = info local ids = info.npcIds and table.concat(info.npcIds, "/") or "-" HPL.Debug("taming " .. tostring(info.name) .. " (" .. tostring(info.family) .. ", level " .. tostring(info.level) .. ", guid " .. tostring(info.guid) .. ", npc ids " .. ids .. ")") else HPL.Debug("Tame Beast cast seen, but no beast target to remember") end end local function ValidPetName(name) return name and name ~= "" and name ~= "Unknown" and name ~= UNKNOWNOBJECT end -- The saved record for a pet, and how it was found. Matched by GUID when SuperWoW is present, otherwise -- by name and family. A GUID only holds for one summon (part of it is a spawn counter), so a GUID miss -- proves nothing. Names do clash: on this server every new pet starts out named after its family -- ("Scorpid"). Pets only ever gain levels, so a namesake above this level is a different pet, and one at -- exactly this level is the likeliest match. local function FindPet(list, name, family, guid, level) level = level or 0 if guid then for i = 1, table.getn(list) do if list[i].guid == guid then return list[i], "guid" end end end local found, foundScore for i = 1, table.getn(list) do local p = list[i] if p.name == name and p.family == family and not (level > 0 and (p.level or 0) > level) then local score = ((p.level or 0) == level) and 2 or 1 if not found or score > foundScore or (score == foundScore and (p.lastSeen or 0) >= (found.lastSeen or 0)) then found, foundScore = p, score end end end if found then return found, "name" end return nil end -- Keep the first name a pet had, so the log can say what it used to be called. local function Rename(pet, name) HPL.Debug("renamed " .. tostring(pet.name) .. " to " .. name) if not pet.firstName then pet.firstName = pet.name end pet.name = name end -- A pet with no experience at all has only just been tamed: an old pet being called back has earned -- some. (At the level cap experience stops, so it proves nothing there.) local function FreshPet(level) if level >= HPL.MAX_LEVEL then return false end local ok, xp = pcall(GetPetExperience) return ok and xp == 0 end -- A tamed beast keeps its level. 0 means the pet's level hasn't loaded yet. local function LevelMatches(beastLevel, petLevel) if not beastLevel or beastLevel <= 0 or petLevel == 0 then return true end return beastLevel == petLevel end -- Attack power, damage and so on for the pet that is out. Read a couple of seconds after it appears, -- because the values are still empty the moment it does. local function ReadPetStats() local stats = {} local ok = pcall(function() stats.health = UnitHealthMax("pet") local base, pos, neg = UnitAttackPower("pet") stats.ap = (base or 0) + (pos or 0) + (neg or 0) stats.dmgLow, stats.dmgHigh = UnitDamage("pet") stats.speed = UnitAttackSpeed("pet") local _, armor = UnitArmor("pet") stats.armor = armor local keys = { "str", "agi", "sta", "int", "spi" } for i = 1, 5 do local _, effective = UnitStat("pet", i) stats[keys[i]] = effective end stats.level = UnitLevel("pet") stats.when = time() end) if ok then return stats end return nil end -- What the pet has actually learned, from its spellbook. local function ReadPetSpells() local spells = {} local i = 1 while i < 40 do local ok, name, rank = pcall(GetSpellName, i, "pet") if not ok or not name then break end if rank and rank ~= "" then name = name .. " " .. rank end table.insert(spells, name) i = i + 1 end return spells end function HPL.CapturePetDetails() local pet = HPL.activePet if not pet or not UnitExists("pet") then return end local stats = ReadPetStats() if stats then pet.stats = stats end local spells = ReadPetSpells() if table.getn(spells) > 0 then pet.spells = spells -- What it knew the first time we looked says which beast it was; training adds to it later. if not pet.firstSpells then pet.firstSpells = spells end end if HPL.RefreshUI then HPL.RefreshUI() end end local MILESTONES = { 5, 10, 25, 50, 75, 100 } local function CheckMilestones(pet) local t = HPL.totals for i = 1, table.getn(MILESTONES) do if t.caught == MILESTONES[i] then HPL.Print("|cff00ff00Milestone:|r " .. t.caught .. " skins collected!") end end if t.skins > 0 and t.caught >= t.skins then HPL.Print("|cff00ff00You have caught every skin in the log!|r") end local def = pet.skin and HPL.skinsById[pet.skin] if def and HPL.FamilyComplete(def.type, def.family) then HPL.Print("|cff00ff00Milestone:|r every " .. def.family .. " skin collected!") end end local function Announce(pet, wasCaught) if not HPL.db.settings.notify then return end local def = pet.skin and HPL.skinsById[pet.skin] if def and not wasCaught then HPL.RebuildCollection() HPL.Print("|cff00ff00New skin collected:|r " .. def.name .. " (" .. def.family .. ") " .. HPL.totals.caught .. "/" .. HPL.totals.skins) UIErrorsFrame:AddMessage("New pet skin: " .. def.name, 0.67, 0.83, 0.45, 1.0, 3) CheckMilestones(pet) elseif not def then HPL.Print(pet.name .. " (" .. tostring(pet.family) .. ") was added, but its skin couldn't be worked out. " .. "Open /petlog to pick it.") end end -- source: "pet" (UNIT_PET), "name" (UNIT_NAME_UPDATE), "level", "login", "scan" function HPL.ScanActivePet(source) if not HPL.db or not HPL.IsHunter() then return end if not UnitExists("pet") then HPL.activePet = nil activeGuid = nil if HPL.RefreshUI then HPL.RefreshUI() end return end local name = UnitName("pet") local family = UnitCreatureFamily("pet") if not ValidPetName(name) or not family then -- Pet details can be missing for a moment while it loads in. Mind-controlled humanoids never get a -- family, so give up after a few tries. if source ~= "retry" then retries = 0 end if retries < 5 then retries = retries + 1 HPL.After(1, function() HPL.ScanActivePet("retry") end) end return end local charKey = HPL.CharKey() local list = HPL.PetsFor(charKey) local level = UnitLevel("pet") or 0 local ctype = UnitCreatureType("pet") or "Beast" local guid = HPL.UnitGuid("pet") local now = GetTime() local pet, foundBy = FindPet(list, name, family, guid, level) local active = HPL.activePet local sameGuid = not guid or not activeGuid or guid == activeGuid activeGuid = guid -- Renamed pet: same pet still out, new name. A name change reported before UNIT_PET could also be a -- different pet being called, so without the rename popup we also need the same level (and GUID). if not pet and active and active.family == family and active.name ~= name then local renamed = (renameTo and renameTo.name == name and now - renameTo.time < 30) or (source == "name" and level == (active.level or -1) and sameGuid) if renamed then Rename(active, name) pet, foundBy = active, "rename" renameTo = nil end end if pending and now - pending.time > HPL.TAME_WINDOW then pending = nil end -- Work out whether this pet is a fresh tame. The pet is NOT named after the beast on this server -- (taming a Clattering Scorpid gives a pet called "Scorpid"), so the name proves nothing: a Tame Beast -- cast on a beast of this family, moments ago, is the tame. -- * A pet found by GUID, or just renamed, is one we already know. -- * One found only by name may be an old namesake ("Scorpid" again), so it must also have the tamed -- beast's level. -- * The name event often arrives before UNIT_PET. It has to count, or the tame is filed as an -- unknown pet and UNIT_PET then finds that record instead. -- * Without a Tame Beast cast seen, the beast we last targeted still counts, if the pet still has its -- default name, the beast's family and level, and is new: no record, or no experience yet (an old -- namesake at the same level has earned some). local tame = nil local fresh = FreshPet(level) if foundBy ~= "guid" and foundBy ~= "rename" then if pending and pending.family == family and (not pet or LevelMatches(pending.level, level)) then tame = pending elseif (not pet or fresh) and lastBeast and now - lastBeast.time < 90 and lastBeast.family == family and (lastBeast.name == name or name == family) and LevelMatches(lastBeast.level, level) then tame = lastBeast end end if tame then -- New tame. local skin, how = HPL.ResolveSkin(family, tame.name, tame.npcIds) if not skin then local npcId = tame.npcIds and tame.npcIds[1] skin = HPL.AddCustomSkin(tame.ctype or ctype, family, tame.name, npcId, tame.level, tame.zone) how = "custom" end local wasCaught = HPL.caught[skin] ~= nil HPL.Debug("new tame: " .. name .. " (" .. family .. ") -> skin " .. tostring(skin) .. " via " .. tostring(how) .. (tame == pending and "" or " (from last target)") .. (foundBy == "name" and ", not the old namesake" or "") .. (fresh and ", no experience yet" or "")) pet = { name = name, family = family, ctype = ctype, creature = tame.name, level = level, tamedLevel = tame.level, firstLevel = level, tamed = time(), zone = tame.zone, witnessed = true, guid = guid, knows = HPL.knowsByCreature and HPL.knowsByCreature[string.lower(tame.name or "")] or nil, npcId = tame.npcIds and tame.npcIds[1], skin = skin, match = how, lastSeen = time(), } table.insert(list, pet) HPL.db.stats.tames = HPL.db.stats.tames + 1 pending = nil lastBeast = nil HPL.activePet = pet Announce(pet, wasCaught) elseif not pet then -- A pet we haven't seen before: tamed before the addon was installed, or renamed while it was off. local npcIds = HPL.NpcIdsFromGuid(HPL.UnitGuid("pet")) local skin, how = HPL.ResolveSkin(family, name, npcIds) local wasCaught = skin and HPL.caught[skin] ~= nil HPL.Debug("first time seeing pet " .. name .. " (" .. family .. ", level " .. level .. ", fresh " .. tostring(fresh) .. ", pending " .. tostring(pending and pending.name) .. ", last target " .. tostring(lastBeast and lastBeast.name) .. ", source " .. tostring(source) .. ", guid " .. tostring(guid) .. ") -> skin " .. tostring(skin) .. " via " .. tostring(how)) pet = { name = name, family = family, ctype = ctype, level = level, firstLevel = level, firstSeen = time(), witnessed = false, creature = (how == "name" or how == "ambiguous") and name or nil, guid = guid, skin = skin, match = how, lastSeen = time(), } table.insert(list, pet) HPL.activePet = pet Announce(pet, wasCaught) else -- Found by GUID under its old name: renamed. if foundBy == "guid" and pet.name ~= name then Rename(pet, name) end if level > (pet.level or 0) then HPL.Debug(name .. " level " .. tostring(pet.level) .. " -> " .. level) pet.level = level if level >= HPL.MAX_LEVEL and not HPL.db.stats.first60 then HPL.db.stats.first60 = time() HPL.Print("|cff00ff00Milestone:|r " .. name .. " reached level " .. HPL.MAX_LEVEL .. "!") end end pet.lastSeen = time() pet.guid = guid or pet.guid HPL.activePet = pet end HPL.Changed() HPL.After(2, function() HPL.CapturePetDetails() end) end -- Stabled pets: record levels and pick up pets the log hasn't seen yet. local function ScanStable() if not HPL.db or not HPL.IsHunter() then return end local list = HPL.PetsFor(HPL.CharKey()) local changed = false for slot = 1, 4 do -- Vanilla has 2 stable slots; pcall in case this server's client errors past the last one. local ok, _, name, level, family = pcall(GetStablePetInfo, slot) if ok and ValidPetName(name) and family then local pet = FindPet(list, name, family, nil, level) HPL.Debug("stable slot " .. slot .. ": " .. name .. " (" .. family .. ", level " .. tostring(level) .. ")" .. (pet and "" or " - new to the log")) if pet then if (level or 0) > (pet.level or 0) then pet.level = level changed = true end else local skin, how = HPL.ResolveSkin(family, name, nil) table.insert(list, { name = name, family = family, ctype = "Beast", level = level or 0, firstSeen = time(), witnessed = false, creature = skin and name or nil, skin = skin, match = how, lastSeen = time(), }) changed = true end end end if changed then HPL.Changed() end end function HPL.PrintDebugInfo() HPL.Print("version " .. HPL.VERSION .. ", SuperWoW: " .. tostring(SUPERWOW_VERSION or "no") .. ", hunter: " .. tostring(HPL.IsHunter())) local function describe(unit) if not UnitExists(unit) then HPL.Print(unit .. ": none") return end local guid = HPL.UnitGuid(unit) local ids = HPL.NpcIdsFromGuid(guid) local idText = ids and table.getn(ids) > 0 and table.concat(ids, " or ") or "-" local skin = HPL.ResolveSkin(UnitCreatureFamily(unit), UnitName(unit), ids) HPL.Print(unit .. ": " .. tostring(UnitName(unit)) .. ", family " .. tostring(UnitCreatureFamily(unit)) .. ", type " .. tostring(UnitCreatureType(unit)) .. ", level " .. tostring(UnitLevel(unit))) HPL.Print(" guid " .. tostring(guid) .. ", npc id " .. idText .. ", skin " .. tostring(skin and HPL.skinsById[skin].name or "unknown")) end describe("pet") describe("target") if pending then HPL.Print("taming in progress: " .. tostring(pending.name)) end end function HPL.InitTracker() local f = CreateFrame("Frame") local events = { "PLAYER_ENTERING_WORLD", "UNIT_PET", "UNIT_LEVEL", "UNIT_NAME_UPDATE", "LOCALPLAYER_PET_RENAMED", "PLAYER_TARGET_CHANGED", "SPELLCAST_START", "SPELLCAST_CHANNEL_START", "PET_STABLE_SHOW", "PET_STABLE_UPDATE", "UNIT_MODEL_CHANGED", } if SUPERWOW_VERSION then table.insert(events, "UNIT_CASTEVENT") end for i = 1, table.getn(events) do -- pcall so an event this client doesn't know can't stop the addon loading. local ok = pcall(f.RegisterEvent, f, events[i]) if not ok then HPL.Debug("event not available: " .. events[i]) end end f:SetScript("OnEvent", function() if event == "UNIT_CASTEVENT" then -- arg1 caster guid, arg2 target guid, arg3 "START"/"CAST"/"FAIL"/"CHANNEL", arg4 spell id if arg4 == HPL.TAME_BEAST_SPELL_ID and arg1 == HPL.UnitGuid("player") then HPL.Debug("UNIT_CASTEVENT Tame Beast: " .. tostring(arg3) .. ", target " .. tostring(arg2) .. ", duration " .. tostring(arg5)) end if arg4 == HPL.TAME_BEAST_SPELL_ID and arg3 ~= "FAIL" and arg1 == HPL.UnitGuid("player") then if type(arg2) == "string" and UnitExists(arg2) then StartTame(arg2) else StartTame("target") end end elseif event == "SPELLCAST_START" then if arg1 == HPL.TAME_BEAST_NAME then HPL.Debug("SPELLCAST_START " .. tostring(arg1) .. " " .. tostring(arg2)) StartTame("target") end elseif event == "SPELLCAST_CHANNEL_START" then if arg2 == HPL.TAME_BEAST_NAME or arg1 == HPL.TAME_BEAST_NAME then HPL.Debug("SPELLCAST_CHANNEL_START " .. tostring(arg1) .. " " .. tostring(arg2)) StartTame("target") end elseif event == "PLAYER_TARGET_CHANGED" then local info = CaptureBeast("target") if info then lastBeast = info end elseif event == "UNIT_PET" then if arg1 == "player" then HPL.ScanActivePet("pet") end elseif event == "UNIT_LEVEL" then if arg1 == "pet" then HPL.ScanActivePet("level") end elseif event == "UNIT_NAME_UPDATE" then if arg1 == "pet" then HPL.ScanActivePet("name") end elseif event == "LOCALPLAYER_PET_RENAMED" then HPL.After(0.5, function() HPL.ScanActivePet("name") end) elseif event == "PLAYER_ENTERING_WORLD" then HPL.After(2, function() HPL.ScanActivePet("login") end) elseif event == "PET_STABLE_SHOW" or event == "PET_STABLE_UPDATE" then ScanStable() elseif event == "UNIT_MODEL_CHANGED" then if arg1 == "pet" and HPL.RefreshModel then HPL.RefreshModel() end end end) -- Warn when the pet being abandoned is the only one with its skin. if type(PetAbandon) == "function" then local originalAbandon = PetAbandon PetAbandon = function() local pet = HPL.activePet local def = pet and pet.skin and HPL.skinsById[pet.skin] if def then local caught = HPL.caught[pet.skin] local others = 0 if caught then for i = 1, table.getn(caught.pets) do if caught.pets[i].pet ~= pet then others = others + 1 end end end if others == 0 then HPL.Print("|cffff9933" .. tostring(pet.name) .. " was your only " .. def.name .. ". The log keeps the record, but you will have to tame another one to use it again.|r") end end return originalAbandon() end end -- The rename popup calls PetRename(name); remember the new name so the rename is matched exactly. if type(PetRename) == "function" then local original = PetRename PetRename = function(newName) renameTo = { name = newName, time = GetTime() } return original(newName) end end end