TakePlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server function}}
This function substracts money from a [[player]]'s current money amount.
This function substracts money from a [[player]]'s current money amount.


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


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

Revision as of 18:07, 15 August 2007

This function substracts money from a player's current money amount.

Syntax

bool takePlayerMoney ( player thePlayer, int amount )

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" in console.

function takeCash ( thePlayer, command, amount ) --when the takecash command is called
	takePlayerMoney ( thePlayer, amount ) --take the amount of money from the player
end
addCommandHandler ( "takecash", takeCash ) --add a handler function for the command "takecash"

See Also