numericalstorage_definition

Defines a configurable numerical storage — misc entry.

Entry Information

Property	Value
Entry ID	numericalstorage_definition
Type	Misc
Color	Blue
Icon	fa6-solid:piggy-bank

Fields

Field	Type	Description
displayName	String	Display name shown to players.
prefix	String	Prefix used in messages.
artifact	Ref<PlayerNumericalStorageArtifactEntry>	Artifact storing player data
interestEnabled	Boolean	Enable interest system based on real time.
interestRate	Double	Interest rate in percentage (e.g. 2.0 for 2%).
interestMessage	String	Message when interest is applied. Placeholders: <amount> <new_balance> <rate> <prefix>
interestRates	List<InterestRatePermission>	List of permission based interest rates. Each entry defines a permission and a specific rate.
levels	List<BankLevel>	Configured levels. Messages support placeholders: {limit}, {amount}, {new_balance}, {prefix}, {level}
menu	NumericalStorageMenuConfig	Menu configuration for this storage.
interestCron	CronExpression	Cron expression for interest application (e.g. '0 0 12 * * *' for daily at 12:00).
transaction	TransactionConfig	Transaction configuration for deposits/withdrawals via menu and commands.
profileMode	Boolean	When enabled, balances are stored per-profile instead of globally. Requires ProfilesExtension.

Usage Example

- entry: numericalstorage_definition
  name: "Defines a configurable numerical storage"
  displayName: ""
  prefix: ""
  artifact: ""
  interestEnabled: false
  interestRate: 0
  interestMessage: ""
  interestRates: 0
  levels: []
  menu: ""
  interestCron: ""
  transaction: ""
  profileMode: false