SetPlayerMoney: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Syntax: OOP syntax added)
mNo edit summary
Line 15: Line 15:
===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
{{OptionalArg}}
{{New items|4.0132|1.4|
{{New items|3.0140|1.4|
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
</section>
</section>
Line 27: Line 27:
===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
{{OptionalArg}}
{{New items|4.0132|1.4|
{{New items|3.0140|1.4|
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}}
</section>
</section>
Line 52: Line 52:
==See Also==
==See Also==
{{Player functions}}
{{Player functions}}
[[ru:setPlayerMoney]]

Revision as of 09:01, 19 September 2014

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 ] ) 

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