• Tutorials

  • Home
  • GPDL Money Variables

    DungeonCraft Help Home

    You can determine the names of the coins, their relative value, and the number held by each of the characters. In all cases, the coinOrdinal is a number from one to ten and is in the order specified in the 'Configure Money Types' dialog. Number one is usually the most valuable coin.

    $COINNAME(coinOrdinal);

    The return value is the name of the coin. Example: "Silver".

    $COINRATE(coinOrdinal);

    The return value is the the 'Conversion Rate' that you specified in the 'Configure Money Types' dialog. See the menu item Global/Global Settings/Currency in the Design Editor.

    $COINCOUNT(coinOrdinal, CharacterOrdinal);

    The return value is the number of coins of this particular type in the possession of one of the characters. The characters are numbered starting at one and are in the order currently displayed on the adventure screen. If you specify character number 0 (zero) then the Active Character is assumed.

    $GET_PARTY_MONEYAVAILABLE(coinOrdinal);

    This will return the total funds available for all current party members. The coinOrdinal can be zero, which will return the funds in terms of the base coin type (usually copper). If coinOrdinal is 1-10, the return value will be in terms of the specified coin type. For instance, assume the party has 200 platinum pieces and you are using the default money configuration. Using $GET_PARTY_MONEYAVAILABLE(0) will return 200000 (copper), and $GET_PARTY_MONEYAVAILABLE(1) will return 200 (platinum). There is no support for fractional values. If the party has 999 copper pieces and you ask for the total in terms of platinum, the answer will be 0 since 1000 copper = 1 platinum.

    $GET_VAULT_MONEYAVAILABLE(coinOrdinal);

    This will return the total funds available in the vault. The coinOrdinal can be zero, which will return the funds in terms of the base coin type (usually copper). If coinOrdinal is 1-10, the return value will be in terms of the specified coin type. For instance, assume the vault has 200 platinum pieces and you are using the default money configuration. Using $GET_VAULT_MONEYAVAILABLE(0) will return 200000 (copper), and $GET_VAULT_MONEYAVAILABLE(1) will return 200 (platinum). There is no support for fractional values. If the vault has 999 copper pieces and you ask for the total in terms of platinum, the answer will be 0 since 1000 copper = 1 platinum.