Skip to content

Class

Wallet

Generated GDScript class reference for ItemVault.Wallet.

Status
Current
Version
v1.1
Source updated
2026-09-12
Generated on
2026-10-12

Currency container: a balance per StringName id (e.g. &"coins", &"gems"). Standalone or an Inventory sub-component. No implicit cap; games enforce caps externally via can_afford / add / remove round-trips. Mutations are atomic: add/remove return the new balance or a negative number on failure, so callers can roll back.

Source: addons/item_vault/inventory/wallet.gd

Syntax

class Wallet extends RefCounted

Members

NameKindSummary
currency_changedSignalEmitted whenever any currency's balance changes. payload: { "currency": StringName, "old": int, "new": int }
get_balanceMethod
can_affordMethod
balancesMethod
currenciesMethod
addMethod
removeMethod
set_balanceMethod
clearMethod
transfer_fromMethod
merge_fromMethod
to_dictMethod
from_dictMethod