SetPlayerArmor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(12 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Needs_Checking|Is Armor an int or a float? What is the maximum Armor value?|[[User:Vandalite|Vandalite]]}}
{{Deprecated|setPedArmor}}
==Description==
 
This function allows you to set the armor value of a player. This function will return false if an invalid player is specified, or the armor value specified is out of acceptable range.
This function allows you to set the armor value of a [[player]].


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setPlayerArmor ( player thePlayer, float playerArmor )</syntaxhighlight>


bool [[setPlayerArmor]] ( [[player]] player, float armor )
===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.


===Required Arguments===
===Returns===
*'''player''': the [[player]] whose armor you want to modify
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.
*'''armor''': the amount of armor you want to set on the player.


==Example==
==Example==
if ( [[setPlayerArmor]] ( [[findPlayer]] ( "SomeGuy" ), 0 ) ) then
<section name="Server" class="server" show="true">
  [[serverChat]] ( "Sorry Someguy, no armor for you! " )
This example removes the armor of a player.
end
<syntaxhighlight lang="lua">function givePlayerArmor ( player, command )
setPlayerArmor ( player, 100 ) --Set player's armor to 100 when he types the command 'addarmor'
end
addCommandHandler ( "addarmor", givePlayerArmor )
 
function removePlayerArmor ( player, command )
setPlayerArmor ( player, 0 ) --Set player's armor to 0 when he types the command 'removearmor'
end
addCommandHandler ( "removearmor", removePlayerArmor )</syntaxhighlight> </section>
 
==See Also==
{{Player functions}}
{{Server function}}

Latest revision as of 22:00, 5 July 2014


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use setPedArmor instead.


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 givePlayerArmor ( player, command )
	setPlayerArmor ( player, 100 ) --Set player's armor to 100 when he types the command 'addarmor'
end
addCommandHandler ( "addarmor", givePlayerArmor )

function removePlayerArmor ( player, command )
	setPlayerArmor ( player, 0 ) --Set player's armor to 0 when he types the command 'removearmor'
end
addCommandHandler ( "removearmor", removePlayerArmor )

See Also


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