GetElementHealth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
Line 7: Line 7:
float getElementHealth ( element theElement )
float getElementHealth ( element theElement )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getHealth|health|}}


===Required Arguments===
===Required Arguments===

Revision as of 16:18, 16 August 2014

This function returns the current health for the specified element. This can be a player, a ped, or a vehicle.

Syntax

float getElementHealth ( element theElement )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:getHealth(...)
Variable: .health


Required Arguments

  • theElement: The player or vehicle whose health you want to check.

Returns

Returns a float indicating the element's health, or false if invalid arguments were passed.

Example

Click to collapse [-]
Clientside example

This example outputs the health of the player who enters the command 'showhealth', and their vehicle's health. 

function showLocalHealth()
	-- get the player's health and output it
	local playerHealth = getElementHealth ( getLocalPlayer() )
	outputChatBox ( "Your health: " .. playerHealth )

	-- get the player's vehicle: if he is in one, output its health as well
	local playerVehicle = getPedOccupiedVehicle ( getLocalPlayer() )
	if playerVehicle then
		local vehicleHealth = getElementHealth ( playerVehicle ) / 10  -- Divide this by 10, as default the denominator is 1000
		outputChatBox ( "Your vehicle's health: " .. vehicleHealth )
	end
end
addCommandHandler ( "showhealth", showLocalHealth )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementHealth?oldid=41450"