| Name | Type | Deprecated | Secure | Description |
|---|---|---|---|---|
| Event.Currency | Signals a change in the player's available currency. | |||
| Inspect.Currency.Category.Detail | function | Returns information about currency categories. | ||
| Inspect.Currency.Category.List | function | Returns a table of valid currency categories. | ||
| Inspect.Currency.Detail | function | Provides detailed information about currencies. | ||
| Inspect.Currency.List | function | Returns a table of all known currencies. |
Signals a change in the player's available currency.
| Event.Currency(currencies) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| currencies | parameter | variant | New currency counts, in key/value form. |
Returns information about currency categories.
| detail = Inspect.Currency.Category.Detail(category) | |||
| details = Inspect.Currency.Category.Detail(categories) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| categories | parameter | table | A table of identifiers of currency categories to retrieve detail for. |
| category | parameter | currencycategory | The identifier of the currency category to retrieve detail for. |
| detail | result | table | Detail table for a single currency category. |
| details | result | table | Detail tables for all requested currency categories. The key is the category ID, the value is the category's detail table. |
| id | The ID of the requested element. |
|---|---|
| name | The name of the currency category. |
Returns a table of valid currency categories.
| categories = Inspect.Currency.Category.List() | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| categories | result | table | Valid currency categories, in {id = true} format. |
Provides detailed information about currencies.
| detail = Inspect.Currency.Detail(coin) | |||
| detail = Inspect.Currency.Detail(currency) | |||
| details = Inspect.Currency.Detail(currencies) | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| coin | parameter | string | The string "coin", used as a value to request the player's money. |
| currencies | parameter | table | A table of identifiers of currencies to retrieve detail for. |
| currency | parameter | itemtype | The identifier of the currency to retrieve detail for. |
| detail | result | table | Detail table for a single currency. |
| details | result | table | Detail tables for all requested currencies. The key is the currency ID, the value is the currency's detail table. |
| category | ID of the currency's category. |
|---|---|
| icon | Internal name of the currency's icon. |
| id | The ID of the requested element. |
| name | The currency's name. |
| stack | The number of this currency that you have. |
| stackMax | The maximum number of this currency that you can have. |
Returns a table of all known currencies.
| currencies = Inspect.Currency.List() | |||
| Parameter | Type | Datatype | Description |
|---|---|---|---|
| currencies | result | table | All known currencies, in {id = amount} format. |