SetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Minor update; grammar.)
mNo edit summary
Line 11: Line 11:


===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' Which player to set the money of
*'''thePlayer:''' Which player to set the money of.
*'''amount:''' A whole integer specifying the new amount of money the player will have.
*'''amount:''' A whole integer specifying the new amount of money the player will have.
</section>
</section>

Revision as of 23:29, 14 November 2011

Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.

Note: Using this function client side (not recommended) will not change a players money server side.

Syntax

Click to collapse [-]
Server
bool setPlayerMoney ( player thePlayer, int amount ) 

Required Arguments

  • thePlayer: Which player to set the money of.
  • amount: A whole integer specifying the new amount of money the player will have.
Click to collapse [-]
Client
bool setPlayerMoney ( int amount ) 

Required Arguments

  • amount: A whole integer specifying the new amount of money the local player will have.

Returns

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

Example

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

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

Example 2: This gives all players the amount of 1337 money when "leet" is typed in console.

function leetmoney()
	setPlayerMoney( getRootElement(), 1337 )
end
addCommandHandler("leet", leetmoney)

See Also