TakePlayerMoney

2007-09-23T09:34:54Z

Auron: /* Syntax */

__NOTOC__
{{Server function}}
This function subtracts money from a [[player]]'s current money amount.

==Syntax==
<syntaxhighlight lang="lua">bool takePlayerMoney ( player thePlayer, int amount )</syntaxhighlight>

====Required Arguments====
*'''thePlayer:''' the [[player]] you are taking the money from.
*'''amount:''' an integer number specifying the amount of money to take from the player.

===Returns===
Returns ''true'' if the money was taken, or ''false'' if invalid parameters were passed.

==Example==
This example takes money from a player when he types "takecash ''number''" in the console.
<syntaxhighlight lang="lua">
function takeCash ( thePlayer, command, amount ) -- when the takecash command is called
takePlayerMoney ( thePlayer, tonumber(amount) ) -- take the amount of money from the player
end
addCommandHandler ( "takecash", takeCash ) -- add a handler function for the command "takecash"
</syntaxhighlight>

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

Multi Theft Auto: Wiki - User contributions [en]

TakePlayerMoney