SetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Minor update; grammar.)
m (Undo revision 75196 by XNikoXD (talk))
Tag: Undo
 
(14 intermediate revisions by 13 users not shown)
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
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.
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.}}
'''Note:''' Using this function client side (not recommended) will not change a players money server side.


==Syntax==  
==Syntax==  
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( player thePlayer, int amount ) </syntaxhighlight>  
bool setPlayerMoney ( player thePlayer, int amount [, bool instant = false ] ) </syntaxhighlight>  
 
{{OOP||[[player]]:setMoney|money|getPlayerMoney}}
===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.
===Optional Arguments===
{{OptionalArg}}
{{New items|3.0140|1.4|
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
</section>
</section>
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( int amount ) </syntaxhighlight>  
bool setPlayerMoney ( int amount [, bool instant = false ] ) </syntaxhighlight>  
 
{{OOP||[[Player]].setMoney||getPlayerMoney}}
===Required Arguments===  
===Required Arguments===  
*'''amount:''' A whole integer specifying the new amount of money the local player will have.
*'''amount:''' A whole integer specifying the new amount of money the local player will have.
===Optional Arguments===
{{OptionalArg}}
{{New items|3.0140|1.4|
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
</section>
</section>


Line 28: Line 37:
'''Example 1:''' This example sets the player's money to the desired amount when he types "setcash" in console.
'''Example 1:''' 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 ( thePlayer, command, amount )      -- when the setcash function is called
function setCash(thePlayer, command, amount)      -- when the setcash function is called
     setPlayerMoney ( thePlayer, tonumber(amount) )    -- change player's money to the desired amount
     setPlayerMoney(thePlayer, 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>
'''Example 2:''' This gives all players the amount of 1337 money when "leet" is typed in console.
'''Example 2:''' This sets all players the amount of 1337 money when "leet" is typed in console.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function leetmoney()
function leetmoney()
setPlayerMoney( getRootElement(), 1337 )
setPlayerMoney(root, 1337)
end
end
addCommandHandler("leet", leetmoney)
addCommandHandler("leet", leetmoney)
Line 43: Line 52:
==See Also==
==See Also==
{{Player functions}}
{{Player functions}}
[[pt-br:SetPlayerMoney]]
[[ru:setPlayerMoney]]

Latest revision as of 10:26, 29 June 2022

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.

[[{{{image}}}|link=|]] 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 [, bool instant = false ] )

OOP Syntax Help! I don't understand this!

Method: player:setMoney(...)
Variable: .money
Counterpart: getPlayerMoney


Required Arguments

  • thePlayer: Which player to set the money of.
  • amount: A whole integer specifying the new amount of money the player will have.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • instant: If set to true money will be set instantly without counting up/down like in singleplayer.
Click to collapse [-]
Client
bool setPlayerMoney ( int amount [, bool instant = false ] )

OOP Syntax Help! I don't understand this!

Method: Player.setMoney(...)
Counterpart: getPlayerMoney


Required Arguments

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

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • instant: If set to true money will be set instantly without counting up/down like in singleplayer.

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 sets all players the amount of 1337 money when "leet" is typed in console. 

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

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerMoney?oldid=75197"