SetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(example onConsole -> command handlers)
No edit summary
Line 3: Line 3:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">setPlayerMoney ( player, money ) </syntaxhighlight>  
<syntaxhighlight lang="lua">setPlayerMoney ( player thePlayer, int money ) </syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''Player:''' Tells the function to give money to a player
*'''Player:''' Tells the function to give money to a player
*'''Money:''' A whole integer specifying the amount of money to give to the player
*'''Money:''' A whole integer specifying the amount of money to give to the player
===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.


==Example==   
==Example==   
This example sets the player's money to the desired amount when he types "setcash" in console.
This example sets the player's money to the desired amount when he types "setcash" in console.
<syntaxhighlight lang="lua">addCommandHandler ( "setcash", "setCash" ) -- add a command handler for setcash
<syntaxhighlight lang="lua">
function setCash ( player, command, amount ) --when the setcash function is called
function setCash ( player, command, amount ) --when the setcash function is called
setPlayerMoney ( source, amount ) --change player's money to the desired amount
setPlayerMoney ( source, amount ) --change player's money to the desired amount
end</syntaxhighlight>
end
addCommandHandler ( "setcash", "setCash" ) -- add a command handler for setcash
</syntaxhighlight>


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

Revision as of 15:28, 1 August 2007

Sets a player's money to a certain value. Regardless of current player money.

Syntax

setPlayerMoney ( player thePlayer, int money ) 

Required Arguments

  • Player: Tells the function to give money to a player
  • Money: A whole integer specifying the amount of money to give to the player

Returns

Returns true if the money was added, or false if invalid parameters were passed.

Example

This example sets the player's money to the desired amount when he types "setcash" in console.

function setCash ( player, command, amount ) --when the setcash function is called
	setPlayerMoney ( source, amount ) --change player's money to the desired amount
end
addCommandHandler ( "setcash", "setCash" ) -- add a command handler for setcash

See Also