— — — — —
— — — — —
— — — — —
— — — — —
— — — — —
— — — — —
— — — — —
— — — — —
Removes the specified amount of a currency from a character.
remove_currency(amount, stat_id, character)
Argument | Description | Type | Required |
---|---|---|---|
amount | Amount of currency to remove. | Number | Yes |
stat_id | Defaults to “currency”. | String | No |
character | Defaults to main player character. | Entity | No |
remove_currency(100, "currency", player);
Results: Decreases the player's base currency by 100 (i.e. their “currency” stat).
Use the Remove Currency function to take some gold coins from the player upon buying an item from an NPC or as a penalty for failing a quest.