WoW:API UnitHealthMax: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{wowapi}}, update)
Line 1: Line 1:
<center>'''UnitHealthMax''' ''-Documentation by [[User:Danboo|danboo]]-''</center>
{{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 maximal health of the specified unit, in percentage, for:
 
*target
*mouseover
*pet if pet is charmed/enslaved
 
Otherwise in points.


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


----
==Parameters==
;''Arguments''
===Arguments===
 
:;unit : [[UnitId]] -  the unit whose max health to query.
:(String unit)
===Returns===
 
:;max_health : Integer - the maximum health of the specified unit
:;arg1 : the unit's max health to query
 
----
;''Returns''
 
:max_health
:;max_health : the maximum health of the specified unit
 
----
;''Example''
local max_health = UnitHealthMax("player");
local max_health2 = UnitHealthMax("target");
ChatFrame1:AddMessage('player max health: ' .. max_health);
ChatFrame1:AddMessage('target max health: ' .. max_health2 .. "%");
 
;''Result''
Prints the player's maximum health to the chat frame as
'player max health: 900' and 'target max health: 100%'
 
----
;''Description''


: Returns the maximum 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 (which will always be 100 in this case). (Note, that the player, the player's pet, and any party member pets are considered to be in the party.)
==Example==


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


----
===Result===
{{WoW API}}
Prints the maximum health of ''player'' and ''target'' units to the chat window.

Revision as of 16:19, 23 December 2006

← WoW API < UnitHealthMax

Returns the maximum health of the specified unit. Returns the exact hitpoints for friendly players and pets in your raid/party, percentages otherwise. 

local max_health = UnitHealthMax(unit);

Parameters

Arguments

unit
UnitId - the unit whose max health to query.

Returns

max_health
Integer - the maximum health of the specified unit

Example

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

Result

Prints the maximum health of player and target units to the chat window.

Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_UnitHealthMax&oldid=9350"