WoW:API UnitHealthMax: Difference between revisions
Jump to navigation
Jump to search
({{wowapi}}, update) |
m (Move page script moved page API UnitHealthMax to WoW:API UnitHealthMax without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Returns the maximum health of the specified unit | Returns the maximum health of the specified unit. | ||
local max_health = UnitHealthMax(unit); | local max_health = UnitHealthMax(unit); | ||
==Parameters== | ==Parameters== | ||
:;unit : [[UnitId]] - the unit whose max health to query. | :;unit : [[UnitId]] - the unit whose max health to query. | ||
:;max_health : Integer - the maximum health of the specified unit | ==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== | ==Example== | ||
Print the maximum health of ''player'' and ''target'' units to the chat window: | |||
ChatFrame1:AddMessage('Player max health: ' .. UnitHealthMax("player") .. " HP"); | ChatFrame1:AddMessage('Player max health: ' .. UnitHealthMax("player") .. " HP"); | ||
ChatFrame1:AddMessage('Target max health: ' .. UnitHealthMax("target").. " | ChatFrame1:AddMessage('Target max health: ' .. UnitHealthMax("target") .. " HP"); | ||
Latest revision as of 04:47, 15 August 2023
← 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") .. " HP");