SetPlayerMoney: 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}}
{{Needs_Checking|The first time you set the money for a player it doesn't wet the correct amount of money, for example setting it to $100000 gives $98755, this applies to givePlayerMoney as well --[[User:Norby89|Norby89]] 09:10, 5 August 2007 (CDT) }}
{{Needs_Checking|The first time you set the money for a player it doesn't wet the correct amount of money, for example setting it to $100000 gives $98755, this applies to givePlayerMoney as well --[[User:Norby89|Norby89]] 09:10, 5 August 2007 (CDT) }}
Sets a player's money to a certain value. Regardless of current player money.
Sets a player's money to a certain value, regardless of current player money.


==Syntax==  
==Syntax==  
Line 7: Line 8:


===Required Arguments===  
===Required Arguments===  
*'''Player:''' Tells the function to give money to a player
*'''thePlayer:''' Which player to set the money of
*'''Money:''' A whole integer specifying the amount of money to give to the player
*'''amount:''' A whole integer specifying the new amount of money the player will have


===Returns===
===Returns===
Line 16: Line 17:
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">
<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, tonumber(amount) )    -- change player's money to the desired amount
end
end
addCommandHandler ( "setcash", "setCash" ) -- add a command handler for setcash
addCommandHandler ( "setcash", setCash )           -- add a command handler for setcash
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 21:33, 15 August 2007

Dialog-information.png This article needs checking.

Reason(s): The first time you set the money for a player it doesn't wet the correct amount of money, for example setting it to $100000 gives $98755, this applies to givePlayerMoney as well --Norby89 09:10, 5 August 2007 (CDT)

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

Syntax

 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

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, tonumber(amount) )    -- change player's money to the desired amount
end
addCommandHandler ( "setcash", setCash )           -- add a command handler for setcash

See Also