WoW:API GetPetHappiness: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (type: 'happiness' should be 'loyalty' for loyaltyRate)
(Reformating to API Template)
Line 1: Line 1:
{{wowapi}}
Returns the pet's happiness, damage percentage, and loyalty gain rate.
Returns the pet's happiness, damage percentage, and loyalty gain rate.


  happiness, damagePercentage, loyaltyRate = GetPetHappiness();
  happiness, damagePercentage, loyaltyRate = GetPetHappiness()
 
== Parameters ==
=== Arguments ===
:none


----
=== Returns ===
:happiness, damagePercentage, loyaltyRate


; ''Returns:''<br>
:;happiness : Number - the numerical happiness value of the pet (1 = unhappy, 2 = content, 3 = happy)
:'''happiness''' (integer) - 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%)  
:'''damagePercentage''' (integer) - 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)
:'''loyaltyRate''' (integer) - the rate at which your pet is currently gaining loyalty (< 0, losing loyalty, > 0, gaining loyalty)


{{template:WoW API}}
== 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 " .. )
DEFAULT_CHAT_FRAME:AddMessage("Pet is doing " .. damagePercentage .. "% damage")
DEFAULT_CHAT_FRAME:AddMessage("Pet is " .. loyalty .. " loyalty")
end

Revision as of 02:04, 15 September 2006

← 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 " .. )
	DEFAULT_CHAT_FRAME:AddMessage("Pet is doing " .. damagePercentage .. "% damage")
	DEFAULT_CHAT_FRAME:AddMessage("Pet is " .. loyalty .. " loyalty")
end
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetPetHappiness&oldid=11332"