WoW:API UnitHealthMax: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(added note about 0 return for non exist unit)
(Factual correction)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns the maximum health of the specified unit. Returns the exact hitpoints for friendly players and pets in your raid/party, percentages otherwise.
Returns the maximum health of the specified unit.


  local max_health = UnitHealthMax(unit);
  local max_health = UnitHealthMax(unit);

Revision as of 07:24, 13 January 2009

WoW API < UnitHealthMax

Returns the maximum health of the specified unit.

local max_health = UnitHealthMax(unit);

Parameters

unit
UnitId - the unit whose max health to query.

Returns

max_health
Integer - the maximum health of the specified unit, returns 0 if the specified unit does not exist (eg. "target" given but there is no target)

Example

Print the maximum health of player and target units to the chat window:

ChatFrame1:AddMessage('Player max health: ' .. UnitHealthMax("player") .. " HP");
ChatFrame1:AddMessage('Target max health: ' .. UnitHealthMax("target").. "%");