WoW:API UnitHealth - Revision history

Move page script: Move page script moved page API UnitHealth to WoW:API UnitHealth without leaving a redirect

2023-08-15T04:47:44Z

Move page script moved page API UnitHealth to API UnitHealth without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>WoWWiki-Shefki: Factual correction - 3.0 changed it to always return exact health.

2009-01-13T07:23:28Z

Factual correction - 3.0 changed it to always return exact health.

← Older revision		Revision as of 07:23, 13 January 2009
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);

WoWWiki>Skeeve2: added info about 0 result for non existing target, corrected the example

2007-10-12T12:25:35Z

added info about 0 result for non existing target, corrected the example

← Older revision		Revision as of 12:25, 12 October 2007
Line 4:		Line 4:

	==Parameters==		==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==		==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.

WoWWiki>Hedgymister234: /* Example */

2007-09-26T01:13:45Z

Example

← Older revision		Revision as of 01:13, 26 September 2007
Line 11:		Line 11:

	==Example==		==Example==
	~~ChatFrame1:AddMessage('Player health: ' .. UnitHealth("player") .. " HP");~~		UnitHealth("target"); -- Note: we're assuming the target isn't a friendly player/pet in our group.
	~~ChatFrame1:AddMessage('Target health: ' ..~~ UnitHealth("target~~") .. "%~~"); -- Note: we're assuming the target isn't a friendly player/pet in our group.

	===Result===		===Result===
	Prints the player's and target's health to the chat frame.		Prints the player's and target's health to the chat frame.

WoWWiki>Starlightblunder: {{wowapi}}, update formatting, reword text

2006-12-23T15:43:45Z

{{wowapi}}, update formatting, reword text

← Older revision		Revision as of 15:43, 23 December 2006
Line 1:		Line 1:
	~~<center>'''UnitHealth''' ''-Documentation by [[User:Danboo\|danboo]]-''</center>~~		{{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, in ~~percentage~~, ~~for:~~

	*target
	*mouseover
	*pet if pet is charmed/enslaved

	~~Otherwise in points~~.

	local health = UnitHealth(unit);		local health = UnitHealth(unit);

	~~----~~		==Parameters==
	~~;''~~Arguments''		===Arguments===
			:;unit : [[UnitId]] - the unit's health to query
	:~~(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: ' .. health2 .. "%");~~

	~~;''Result''~~
	~~Prints the player's and target's health to the chat frame as~~

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

	~~----~~		===Returns===
	;~~''Description''~~		:;health : Integer - current health of the specified unit.

	: ~~Returns the current~~ health ~~of the specified unit~~. ~~The~~ health ~~is returned in real points only if the unit is in the player~~'~~s group~~ (~~party or raid~~). ~~Otherwise, a percentage is returned (0~~-~~100). (~~Note~~, that the player,~~ the player's pet~~, and any group member pets are considered to be~~ in ~~the~~ group.)		==Example==
			ChatFrame1:AddMessage('Player health: ' .. UnitHealth("player") .. " HP");
			ChatFrame1:AddMessage('Target health: ' .. UnitHealth("target") .. "%"); -- Note: we're assuming the target isn't a friendly player/pet in our group.

	~~----~~		===Result===
	~~{{WoW API}}~~		Prints the player's and target's health to the chat frame.

WoWWiki>WoWWiki-Keita at 19:48, 26 November 2006

2006-11-26T19:48:49Z

← Older revision		Revision as of 19:48, 26 November 2006
Line 29:		Line 29:
	local health2 = UnitHealth("target");		local health2 = UnitHealth("target");
	ChatFrame1:AddMessage('player health: ' .. health);		ChatFrame1:AddMessage('player health: ' .. health);
	ChatFrame1:AddMessage('target ~~health2~~: ' .. ~~health~~ .. "%");		ChatFrame1:AddMessage('target health: ' .. health2 .. "%");

	;''Result''		;''Result''

WoWWiki>Cogwheel at 18:37, 29 September 2006

2006-09-29T18:37:56Z

← Older revision		Revision as of 18:37, 29 September 2006
Line 39:		Line 39:
	;''Description''		;''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~~.)		: Returns the current health of the specified unit. The health is returned in real points only if the unit is in the player's group (party or raid). Otherwise, a percentage is returned (0-100). (Note, that the player, the player's pet, and any group member pets are considered to be in the group.)

	----		----
	{{WoW API}}		{{WoW API}}

WoWWiki>Virtuous: Just edited a small part in the example

2006-09-16T15:19:31Z

Just edited a small part in the example

← Older revision		Revision as of 15:19, 16 September 2006
Line 29:		Line 29:
	local health2 = UnitHealth("target");		local health2 = UnitHealth("target");
	ChatFrame1:AddMessage('player health: ' .. health);		ChatFrame1:AddMessage('player health: ' .. health);
	ChatFrame1:AddMessage('target ~~health~~: ' .. health .. "%");		ChatFrame1:AddMessage('target health2: ' .. health .. "%");

	;''Result''		;''Result''

WoWWiki>Muert at 05:33, 4 January 2006

2006-01-04T05:33:38Z

← Older revision		Revision as of 05:33, 4 January 2006
Line 42:		Line 42:

	----		----
	{{~~Template:~~WoW API}}		{{WoW API}}
	~~[[Category:API Functions\|UnitHealth]]~~
	~~[[Category:API Unit Functions\|UnitHealth]]~~

WoWWiki>WoWWiki-Mord at 23:52, 29 September 2005

2005-09-29T23:52:29Z

← Older revision		Revision as of 23:52, 29 September 2005
Line 5:		Line 5:
	*target		*target
	*mouseover		*mouseover
			*pet if pet is charmed/enslaved

	Otherwise in points.		Otherwise in points.