WoW:API UnitHealth: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Clarified when a percentage is returned and when real health points are returned)
mNo edit summary
Line 42: Line 42:
----
----
{{Template:WoW API}}
{{Template:WoW API}}
[[Category:API Functions|UnitHealth]]
[[Category:API Unit Functions|UnitHealth]]

Revision as of 13:22, 27 August 2005

UnitHealth -Documentation by danboo-

Returns the current health of the specified unit, in percentage, for:

  • target
  • mouseover

Otherwise in points.

local health = UnitHealth(unit);

Arguments
(String unit)
arg1
the unit's health to query

Returns
health
health
the current health of the specified unit

Example
local health = UnitHealth("player");
local health2 = UnitHealth("target");
ChatFrame1:AddMessage('player health: ' .. health);
ChatFrame1:AddMessage('target health: ' .. health .. "%");
Result
Prints the player's and target's health to the chat frame as

'player health: 900' and 'target health: 80%'.

Description
Returns the current health of the specified unit. The health is returned in real points only if the unit is in the player's party. Otherwise, a percentage is returned (0-100). (Note, that the player, the player's pet, and any party member pets are considered to be in the party.)

Template:WoW API