WoW:API UnitHealth: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(added info about 0 result for non existing target, corrected the example)
(Factual correction - 3.0 changed it to always return exact health.)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns the current health of the specified unit. Returns the exact hitpoints for friendly players and pets in your raid/party, percentages otherwise.
Returns the current health of the specified unit.
  local health = UnitHealth(unit);
  local health = UnitHealth(unit);



Revision as of 07:23, 13 January 2009

WoW API < UnitHealth

Returns the current health of the specified unit.

local health = UnitHealth(unit);

Parameters

unit
UnitId - identifies the unit to query health for

Returns

health
Integer - current 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 target's health to the chat frame:

DEFAULT_CHAT_FRAME:AddMessage( "target health ="..UnitHealth("target") )