SetPlayerArmor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:


==Example==
==Example==
This example removes the armor of a player called someguy and tells them that it has.
This example removes the armor of a player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Find a player called 'someguy'
function armoroff ( player, command )
someguy = findPlayer ( "someguy" )
setPlayerArmor ( player, getPlayerArmor - 100 )
-- If the player was found then
end
if ( someguy ) then
 
-- Set the player's armor to 0
addCommandHandler ( "armoroff", armoroff )
if ( setPlayerArmor ( someguy, 0 ) ) then
-- Tell the player you've removed their armor
outputChatBox ( "Sorry someguy, no armor for you!", someguy )
end
end
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 06:59, 6 August 2007

This function allows you to set the armor value of a player.

Syntax

bool setPlayerArmor ( player thePlayer, float playerArmor )

Required Arguments

  • thePlayer: the player whose armor you want to modify.
  • playerArmor: the amount of armor you want to set on the player. Valid values are from 0 to 100.

Returns

Returns true if the armor was changed succesfully. Returns false if an invalid player is specified, or the armor value specified is out of acceptable range.

Example

This example removes the armor of a player. 

function armoroff ( player, command )
setPlayerArmor ( player, getPlayerArmor - 100 )
 end

addCommandHandler ( "armoroff", armoroff )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerArmor?oldid=9916"