Currencies

The currencies tab of the Inventool window.

Tip: While currency is a term used on this page, you're not actually creating a currency. Rather, you're creating a Currency Identity object. Currency identities are a way to identify a currency type and set general rules for them.

Currencies can be created from the currencies section. The top-left contains buttons to create, duplicate, and delete currencies. Below that is a list of all of your currencies. The right-hand side is a currency property inspector.

Properties

Name
Description

ID

The unique ID of the currency. This can be used to get a currency through code.

Icon

The icon of the currency displayed in-game.

Display Name

The name of the currency displayed in-game.

Localized Display Name Key

The localized string key for the display name.

Code

The currency code (e.g. USD).

Symbol

The currency symbol (e.g. $).

Numeric Type

The numeric type of the currency.

Has Min

If the currency has a min value.

Min

The min currency value.

Has Max

If the currency has a max value.

Max

The max currency value.

Start Value

The value of the currency that the player starts with.

Scripting Side

Currencies

Last updated