WoW API: GetPetHappiness

Revision as of 04:46, 15 August 2023 by Move page script (talk) (Move page script moved page API GetPetHappiness to API GetPetHappiness without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

WoW API < GetPetHappiness

Returns the pet's happiness, damage percentage, and loyalty gain rate.

happiness, damagePercentage, loyaltyRate = GetPetHappiness()

Parameters

Arguments

none

Returns

happiness, damagePercentage, loyaltyRate
happiness
Number - the numerical happiness value of the pet (1 = unhappy, 2 = content, 3 = happy)
damagePercentage
Number - damage modifier, happiness affects this (unhappy = 75%, content = 100%, happy = 125%)
loyaltyRate
Number - the rate at which your pet is currently gaining loyalty (< 0, losing loyalty, > 0, gaining loyalty)

Example

happiness, damagePercentage, loyaltyRate = GetPetHappiness()
if not happiness then
	DEFAULT_CHAT_FRAME:AddMessage("No Pet")
else
	local happy = ({"Unhappy", "Content", "Happy"})[happiness]
	local loyalty = loyaltyRate > 0 and "gaining" or "losing"
	DEFAULT_CHAT_FRAME:AddMessage("Pet is " .. happy)
	DEFAULT_CHAT_FRAME:AddMessage("Pet is doing " .. damagePercentage .. "% damage")
	DEFAULT_CHAT_FRAME:AddMessage("Pet is " .. loyalty .. " loyalty")
end