SetPlayerMoney: Difference between revisions
m (→Example) |
(Added instant argument.) |
||
Line 7: | Line 7: | ||
<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> | ||
===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|4.0132|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> | ||
===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|4.0132|1.4| | |||
*'''instant:''' If set to ''true'' money will be set instantly without counting up/down like in singleplayer.}} | |||
</section> | </section> | ||
Revision as of 13:21, 3 July 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.
Syntax
bool setPlayerMoney ( player thePlayer, int amount [, bool instant = false ] )
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.
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.
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
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState