remove_currency
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| remove_currency [2024/04/04 20:35] – created justin | remove_currency [2024/04/05 09:33] (current) – justin | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ======Function====== | + | ======Remove Currency====== |
| ---- | ---- | ||
| - | (WIP) | + | Removes the specified amount of a currency from a [[character]]. |
| ====Signature: | ====Signature: | ||
| Line 9: | Line 9: | ||
| ^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
| - | |amount| |[[Number]]|Yes| | + | |amount|Amount of currency to remove.|[[Number]]|Yes| |
| - | |stat_id| |[[String]]|No| | + | |stat_id|Defaults to " |
| - | |character| |[[Entity]]|No| | + | |character|Defaults to main [[player character]].|[[Entity]]|No| |
| ====Example: | ====Example: | ||
| <code bauxite> | <code bauxite> | ||
| - | remove_currency(); | + | remove_currency(100, " |
| </ | </ | ||
| - | // | + | // |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| - | Use the **Remove Currency** function to... | + | 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. |
| </ | </ | ||
remove_currency.1712288154.txt.gz · Last modified: 2024/04/04 20:35 by justin
Page Tools
