GetPlayerArmor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
===Required Arguments===
===Required Arguments===
*'''player''': The [[player]] whose armor you want to check
*'''player''': The [[player]] whose armor you want to check
==Returns==
A ''float'' with the armor, ''false'' if a invalid player was given.


==Example==
==Example==
This example gets health of the player called 'someguy' and shows it in the chat
This example outputs the amount of armor the player who calls the function 'showArmor' currently has.
<syntaxhighlight lang="lua">tmpplayer = getPlayerFromNick ( "someguy" )
<syntaxhighlight lang="lua">
armor = getPlayerArmor ( tmpplayer )
function showArmor( player )
outputChatBox ( "The player's armor is: " .. armor )</syntaxhighlight>
local armor = getPlayerArmor(player)
outputChatBox("Your armor: "..armor)
end
addCommandHandler("showArmor", showArmor)
</syntaxhighlight>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Revision as of 21:49, 29 July 2007

This function returns a float that contains the current armor for the specified player.

Syntax

float getPlayerArmor ( player player )

Required Arguments

  • player: The player whose armor you want to check

Returns

A float with the armor, false if a invalid player was given.

Example

This example outputs the amount of armor the player who calls the function 'showArmor' currently has.

function showArmor( player )
	local armor = getPlayerArmor(player)
	outputChatBox("Your armor: "..armor)
end
addCommandHandler("showArmor", showArmor)

See Also