SetPlayerArmor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
This example removes the armor of a player.
This example removes the armor of a player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function armoroff ( player, command )
function armorOff ( player, command )
setPlayerArmor ( player, getPlayerArmor(player) - 100 )
    setPlayerArmor ( player, 0 )
end
end


addCommandHandler ( "armoroff", armoroff )
addCommandHandler ( "armoroff", armorOff )
</syntaxhighlight> </section>
</syntaxhighlight> </section>



Revision as of 10:30, 16 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

Click to collapse [-]
Server

This example removes the armor of a player.

function armorOff ( player, command )
    setPlayerArmor ( player, 0 )
end

addCommandHandler ( "armoroff", armorOff )

See Also