WoW:API UnitHealth: Difference between revisions

Latest revision as of 04:47, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns the current health of the specified unit.

local health = UnitHealth(unit);

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)

Print the target's health to the chat frame:

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

@@ Line 1: / Line 1: @@
 {{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);
 ==Parameters==
-===Arguments===
+:;unit : [[UnitId]] - identifies the unit to query health for
-:;unit : [[UnitId]] - the unit's health to query
-===Returns===
+==Returns==
-:;health : Integer - current health of the specified unit.
+:;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==
- UnitHealth("target"); -- Note: we're assuming the target isn't a friendly player/pet in our group.
+Print the target's health to the chat frame:
+ DEFAULT_CHAT_FRAME:AddMessage( "target health ="..UnitHealth("target") )
-===Result===
-Prints the player's and target's health to the chat frame.