Numericalstorage Definition

Defines a configurable numerical storage

МанифестПредоставлено: Numerical Storage

Поля

Поле	Тип	По умолчанию	Описание
prefix	String	—	Prefix used in messages.
artifact	Ref<PlayerNumericalStorageArtifactEntry>	—	Artifact storing player data
interestEnabled	Boolean	false	Enable interest system based on real time.
interestRate	Double	0.0	Interest rate in percentage (e.g. 2.0 for 2%).
interestMessage	String	<green>You received <amount> interest! New balance: <new_balance>	Message when interest is applied. Placeholders: <amount> <new_balance> <rate> <prefix>
interestRates	List<InterestRatePermission>	empty	List of permission based interest rates. Each entry defines a permission and a specific rate. InterestRatePermission (2) Поле Тип По умолчанию Описание permission String — Permission node required for this rate. rate Double 0.0 Interest rate in percentage for this permission.
levels	List<BankLevel>	empty	Configured levels. Messages support placeholders: {limit}, {amount}, {new_balance}, {prefix}, {level} BankLevel (10) Поле Тип По умолчанию Описание limit Double 0.0 Maximum balance/xp allowed. depositErrorMessage String — Message when deposit/xp exceeds limit. Placeholders: <limit> <amount> <prefix> depositMessage String — Message when deposit/xp add succeeds. Placeholders: <limit> <amount> <new_balance> <prefix> levelUpMessage String — Status message when this level is reached. interestRate Double? — Interest rate specific to this level (e.g. 1.5 for 1.5%). If null, the global rate is used. interestCap Double 0.0 Maximum interest gain per cycle (Cron) for this level. Set to 0 for no limit. criteria List<LevelCriteria> empty Criteria required to unlock this level (all must be met). LevelCriteria (7) Поле Тип По умолчанию Описание mode CriteriaMode PLACEHOLDER Mode of criteria: PLACEHOLDER or FACTЗначения:PLACEHOLDERFACT placeholder String — Placeholder that returns a numeric value (e.g. %player_level%, %vault_eco_balance%). Used when mode is PLACEHOLDER. fact Ref<ReadableFactEntry> — Fact entry to read the criteria value from. Used when mode is FACT. requiredValue Double 0.0 Required value to meet the criteria. comparison ComparisonType GREATER_THAN_OR_EQUALS Comparison type for the criteria check.Значения:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALSLESS_THANLESS_THAN_OR_EQUALS deductOnMet Boolean false If true and mode is PLACEHOLDER, deduct the required value from the source when criteria is met. deductCommand String — Command to execute to deduct the required value (e.g. 'eco take {player} {amount}'). Placeholder: {amount}, {player}. levelUpTriggers List<Ref<TriggerableEntry>> empty Triggers to execute when this level is reached. withdrawMessage String — Message when withdraw/remove xp succeeds. Placeholders: <limit> <amount> <new_balance> <prefix> withdrawErrorMessage String — Message when withdraw/remove xp fails. Placeholders: <limit> <amount> <prefix>
menu	NumericalStorageMenuConfig	—	Menu configuration for this storage. NumericalStorageMenuConfig (31) Поле Тип По умолчанию Описание title String Storage Title of the menu. rows Int 3 Number of rows in the menu. fillEnabled Boolean true Background item to fill empty slots. fill ItemTemplate — Item used to fill empty slots. ItemTemplate (2) Поле Тип По умолчанию Описание item Item — Item used when rendering the item lore List<String> empty Lore displayed on the itemПлейсхолдерыЦветаМногострочное transactionButtons List<TransactionButtonConfig> empty List of transaction buttons (add/remove). TransactionButtonConfig (7) Поле Тип По умолчанию Описание type TransactionType DEPOSIT Type of transaction: DEPOSIT, WITHDRAW, or TRANSFER.Значения:DEPOSITWITHDRAWTRANSFER amountType AmountType FIXED Type of amount: FIXED, PERCENTAGE, CUSTOM, or ALL.Значения:FIXEDPERCENTAGECUSTOMALL amount Double 0.0 Amount for FIXED (value) or PERCENTAGE (0-100). Ignored for CUSTOM and ALL. template ItemTemplate — Item to display. slots List<Int> — Slot in the inventory. label String — Optional label override for the button. If empty, the default label from the menu config is used. transferTarget String — (TRANSFER only) Target definition ID. The balance is transferred from this storage to the target. optionalButtons List<OptionalButtonConfig> empty Display-only items drawn at fixed slots (a click does nothing). They replace whatever the layout puts in the same slot. OptionalButtonConfig (2) Поле Тип По умолчанию Описание template ItemTemplate — Item to display. slots List<Int> — Inventory slots (0 = top left, 9 per row). Slots outside the menu size are ignored. customAmountDialog DialogConfig — Configuration for the custom amount dialog. DialogConfig (7) Поле Тип По умолчанию Описание title String Enter Amount Title of the dialog for custom amount input. inputLabel String Amount Label for the input field. inputPlaceholder String 100 Placeholder text for the input field. inputWidth Int 200 Width of the input field. maxLength Int 16 Maximum length of the input field. submitButton String Submit Text for the submit button. invalidInputMessage String <red>Invalid amount!</red> Message shown on invalid input. levelButton LevelButtonConfig — Configuration for the level up button (only used if levelingMode is MANUAL). LevelButtonConfig (3) Поле Тип По умолчанию Описание availableTemplate ItemTemplate — Item to display when level up is available. Placeholders: {cost}, {level} maxLevelTemplate ItemTemplate — Item to display when max level is reached. slots List<Int> — Slot in the inventory. closeButton CloseButtonConfig — Configuration for the close button. CloseButtonConfig (2) Поле Тип По умолчанию Описание template ItemTemplate — Item to display for the close button. slots List<Int> — Slot in the inventory. depositLabel String <green>Deposit Label for deposit buttons. Placeholders: {amount}, {balance}, {limit} depositPercentLabel String <green>Deposit % Label for deposit percentage buttons. depositCustomLabel String <green>Deposit Custom Label for deposit custom amount buttons. depositAllLabel String <green>Deposit All Label for deposit ALL button. depositSubmenuLabel String <green>Deposit More... Label for deposit sub-menu opener button. withdrawLabel String <red>Withdraw Label for withdraw buttons. Placeholders: {amount}, {balance}, {limit} withdrawPercentLabel String <red>Withdraw % Label for withdraw percentage buttons. withdrawCustomLabel String <red>Withdraw Custom Label for withdraw custom amount buttons. withdrawAllLabel String <red>Withdraw All Label for withdraw ALL button. withdrawSubmenuLabel String <red>Withdraw More... Label for withdraw sub-menu opener button. transferLabel String <aqua>Transfer Label for transfer buttons. transferPercentLabel String <aqua>Transfer % Label for transfer percentage buttons. transferAllLabel String <aqua>Transfer All Label for transfer ALL button. transferInsufficientMessage String <red>Insufficient balance in source for transfer. Message when transfer source has insufficient balance. Placeholders: <amount>, <balance>, <prefix> transferCapacityMessage String <red>Target storage has insufficient capacity. Message when transfer target has insufficient capacity. Placeholders: <amount>, <limit>, <prefix> transferSuccessMessage String <aqua>Transferred <amount>! New source balance: <new_balance>, target: <target_balance> Message when transfer succeeds. Placeholders: <amount>, <new_balance>, <target_balance>, <prefix> transferTargetNotFoundMessage String <red>Target storage not found. Message when the transfer target is not a known definition. Placeholders: <prefix> transferTargetUnavailableMessage String <red>Target storage is not available. Message when the transfer target definition has no artifact. Placeholders: <prefix> maxLevelMessage String <red>Already at max level. Message when already at max level. Placeholders: <prefix> criteriaNotMetMessage String <red>You don't meet the requirements to level up. Message when criteria not met for upgrade. Placeholders: <prefix> notEnoughFundsMessage String <red>Not enough funds to upgrade. Cost: <cost> Message when not enough funds to upgrade. Placeholders: <cost>, <prefix> subMenus Map<String, SubMenuConfig> empty Sub-menus that can contain additional buttons (e.g. 'deposit_options' with 25/50/100% buttons). Each sub-menu has a unique ID referenced by SUB_MENU button type param. SubMenuConfig (8) Поле Тип По умолчанию Описание title String Options Title of the sub-menu. rows Int 3 Number of rows in the sub-menu. transactionButtons List<TransactionButtonConfig> empty List of transaction buttons in this sub-menu. optionalButtons List<OptionalButtonConfig> empty List of optional buttons in this sub-menu. backButton ItemTemplate — Configuration for the back/return button. backButtonSlots List<Int> — Slots for the back button. closeButton CloseButtonConfig — Configuration for the close button in the sub-menu. fill ItemTemplate — Background item to fill empty slots.
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. TransactionConfig (12) Поле Тип По умолчанию Описание transactionMode TransactionMode INTERNAL How the external economy is integrated: INTERNAL (commands + placeholder) or VAULT (direct API).Значения:INTERNALVAULT amountPlaceholder String — (INTERNAL mode) Placeholder to read the source balance (e.g. %vault_eco_balance%). Ignored in VAULT mode. addSuccessMessage String <green>Successfully added <amount>! New balance: <new_balance> Message when adding to storage succeeds. Placeholders: <amount>, <new_balance>, <limit>, <prefix> addErrorMessage String <red>Cannot add <amount>. Would exceed limit of <limit>. Message when adding exceeds limit. Placeholders: <amount>, <balance>, <limit>, <prefix> removeSuccessMessage String <green>Successfully removed <amount>! New balance: <new_balance> Message when removing from storage succeeds. Placeholders: <amount>, <new_balance>, <limit>, <prefix> removeErrorMessage String <red>Cannot remove <amount>. Insufficient balance (<balance>). Message when removing exceeds available balance. Placeholders: <amount>, <balance>, <limit>, <prefix> addCommand String — (INTERNAL mode) Command executed before the persistent DEPOSIT mutation. Placeholders: {amount}, {player}. Ignored in VAULT mode. removeCommand String — (INTERNAL mode) Command executed before the persistent WITHDRAW mutation. Placeholders: {amount}, {player}. Ignored in VAULT mode. noFundsMessage String <red>No funds available. Message when no funds available for transaction. Placeholders: <prefix> invalidAmountMessage String <red>Invalid amount. Message when amount is invalid. Placeholders: <prefix> vaultInsufficientMessage String <red>Insufficient funds in your economy balance. (VAULT mode) Message when Vault deposit fails (e.g. insufficient economy funds). Placeholders: <amount>, <prefix> vaultUnavailableMessage String <red>Economy system is not available. (VAULT mode) Message when Vault integration is unavailable. Placeholders: <prefix>
profileMode	Boolean	false	When enabled, balances are stored per-profile instead of globally: one balance per MMOProfiles profile. Without MMOProfiles, or before a profile is selected, the balance is the player's.
adminMessages	AdminCommandMessages	—	Replies shown to the sender of the /typewriter ns admin commands (add, remove, level, reset, open). AdminCommandMessages (8) Поле Тип По умолчанию Описание resetMessage String <red><bold>Typewriter »<reset><white> Numerical storage reset for <player>. Reply to /typewriter ns reset. Placeholders: <player>, <storage>, <prefix>ПлейсхолдерыЦвета levelSetMessage String <red><bold>Typewriter »<reset><white> Set numerical storage level to <level> for <player>. Reply to /typewriter ns level. Placeholders: <player>, <level>, <storage>, <prefix>ПлейсхолдерыЦвета addMessage String <red><bold>Typewriter »<reset><white> Added <amount> to <player>. Reply to /typewriter ns add. Placeholders: <player>, <amount>, <storage>, <prefix>ПлейсхолдерыЦвета removeMessage String <red><bold>Typewriter »<reset><white> Removed <amount> from <player>. Reply to /typewriter ns remove. Placeholders: <player>, <amount>, <storage>, <prefix>ПлейсхолдерыЦвета noMenuMessage String <red><bold>Typewriter »<reset> <red>No menu entry found for storage '<storage>'. Create a 'numericalstorage_open_menu' entry in a Typewriter page. Reply to /typewriter ns open when no Open Numerical Storage Menu entry is linked to the definition. Placeholders: <storage>, <prefix>ПлейсхолдерыЦвета invalidAmountMessage String <red><bold>Typewriter »<reset> <red>Invalid amount '<amount>'. Use a positive number. Reply to /typewriter ns add and remove when the amount is not a positive number. Placeholders: <amount> (the value typed), <player>, <storage>, <prefix>ПлейсхолдерыЦвета noArtifactMessage String <red><bold>Typewriter »<reset> <red>Storage '<storage>' has no artifact linked. Link a 'player_numericalstorage_artifact' entry to it. Reply to /typewriter ns add, remove, level and reset when no artifact is linked to the definition. Placeholders: <player>, <storage>, <prefix>ПлейсхолдерыЦвета noActiveProfileMessage String <red><bold>Typewriter »<reset> <red><player> has no active profile. Reply to /typewriter ns add, remove, level and reset, and to a menu action, when the definition is in profile mode and the player has no active MMOProfiles profile (profile selection, or a profile still loading). Nothing is written. Placeholders: <player>, <storage>, <prefix>ПлейсхолдерыЦвета

Общие поля TypeWriter (displayName)

Поле	Тип	По умолчанию	Описание
displayName	String	—	Display name shown to players.

How to use it

One definition is one store. Use its entry id in placeholders, in /typewriter ns commands and as transferTarget.

• Levels. levels is a list: the first line is level 1. limit is the maximum balance of that level. With no levels, the capacity is unlimited. A level can override the interest with interestRate and interestCap (0 means no cap), and runs levelUpTriggers when reached.
• Upgrading. The upgrade button moves a player to the next level. If the next level has criteria, each one compares a placeholder or a fact (mode) with requiredValue using comparison. With deductOnMet and a deductCommand ({player}, {amount}), the value is taken from a source such as a Vault balance. If the next level has no criteria, the player pays the limit of their current level from the stored balance.
• Interest. Turn on interestEnabled, set interestRate (percent) and interestCron. The rate is, in order, the first permission of interestRates the player has, then the level interestRate, then the global rate. Interest is calculated when a player joins, for the cycles they missed (at most 100), and never goes above the capacity.
• Transactions. In VAULT mode, deposits and withdrawals use your Vault economy and ignore amountPlaceholder, addCommand and removeCommand. In INTERNAL mode, amountPlaceholder gives the source balance (for example a %vault_eco_balance% placeholder), addCommand runs from the console to take the money on a deposit, and removeCommand runs to give it back on a withdrawal. Both commands run before the storage is changed and must succeed. They accept {player} and {amount}.
• Messages. The messages are MiniMessage and accept <amount>, <new_balance>, <balance>, <limit> and <prefix> where the field help lists them.
• Profile mode. profileMode stores one balance per MMOProfiles profile. MMOProfiles is optional: without it, the balance is the player's (key = their UUID). With MMOProfiles and no active profile (profile selection, after /mmoprofiles quit), the balance shown is 0 and writes are refused with noActiveProfileMessage (in adminMessages). Interest is settled when a profile is selected.
• Menu. menu holds the title, the number of rows, the transaction buttons and the sub-menus. Where the items sit in the inventory is decided by the layoutPool of the Open Menu action. optionalButtons (in menu and in each sub-menu) are display-only items drawn at their slots; a click on them does nothing. They replace whatever the layout or the other buttons put in the same slot, and slots outside the menu size are ignored.