Placeholders

Discover and list all the placeholders employed within this plugin.

PlaceholderAPI

To employ these placeholders in other plugins, it is imperative to have the PlaceholderAPI plugin installed on your server. Additionally, ensure that the other plugins you intend to use support PlaceholderAPI functionality.

Placeholder	Description
%advancedkits_total_kits%	Displays amount of all kits with offline support
%advancedkits_total_kits_<category>%	Displays amount of all kits from a specified category with offline support
%advancedkits_available_kits%	Displays amount of kits that are ready to redeem
%advancedkits_available_kits_<category>%	Displays amount of kits that are ready to redeem from a specified category
%advancedkits_unavailable_kits%	Displays amount of kits that are on cooldown
%advancedkits_unavailable_kits_<category>%	Displays amount of kits that are on cooldown from a specified category
%advancedkits_locked_kits%	Displays amount of locked (no permission) kits
%advancedkits_locked_kits_<category>%	Displays amount of locked (no permission) kits from a specified category
%advancedkits_purchasable_kits%	Displays amount of kits that are available for purchase
%advancedkits_purchasable_kits_<category>%	Displays amount of kits that are available for purchase from a specified category
%advancedkits_overused_kits%	Displays amount of overused (maximum usages) kits
%advancedkits_overused_kits_<category>%	Displays amount of overused (maximum usages) kits from a specified category
%advancedkits_owned_kits%	Displays amount of owned (available, unavailable, overused) kits
%advancedkits_owned_kits_<category>%	Displays amount of owned (available, unavailable, overused) kits from a specified category
%advancedkits_kit_status_<kit>%	Displays the kit status (AVAILABLE, UNAVAILABLE, LOCKED, PURCHASABLE, OVERUSED) of a specified kit
%advancedkits_kit_levels_<kit>%	Displays count of total kit levels of a specified kit with offline support
%advancedkits_kit_usages_<kit>%	Displays current usages of a kit
%advancedkits_kit_is-upgradable_<kit>%	Displays true or false if the kit is upgradeable or not
%advancedkits_kit_display-name_<kit>%	Displays the display name of a kit.
%advancedkits_kit_claim_cooldown_<kit>%	Displays remaining claim cooldown of a specified kit
%advancedkits_kit_buy_cooldown_<kit>%	Displays remaining buy cooldown of a specified kit

Kit Items

These placeholders can be incorporated into the display name and lore of kit items. The placeholders will take effect when a player acquires the kit items or when previewing a kit in any preview menu. This dynamic application enhances the customization and adaptability of kit item information for a more personalized and informative player experience.

Placeholder	Description
{player}	Reveals the name of the player acquiring a kit or engaging in a kit preview, ensuring a personalized experience by dynamically displaying the respective player's name in these contexts.

These placeholders remain fixed, signifying that once kit items are distributed to players, the values represented by these placeholders cannot be altered or modified.

Kits

These placeholders are versatile, allowing their integration into the display name and lore of kit items within a menu. Additionally, they can be applied to messages, titles, player commands, and console commands triggered when a player claims a kit, offering a comprehensive way to customize and personalize various aspects of the kit experience.

Placeholder	Description
{player}	Presents the name of the player engaging with the system.
{cooldown}	Reveals the cooldown duration associated with a kit, specifying the time until it can be accessed again.
{current_usages}	Highlights the current usage count of a kit.
{maximum_usages}	Indicates the maximum allowable usage count for a kit.
{items}	Specifies the quantity of items included in a kit.
{current_level}	Showcases the present level attained by a kit.
{maximum_level}	Displays the highest level achievable for a kit.
{kit}	Exhibits the unique identifier assigned to a specific kit.
{display_name}	Showcases the user-friendly display name associated with a particular kit, providing a clear and recognizable identifier for the kit in a user interface or display.
{cost}	Details the cost associated with the initial level of a kit.
{total}	Illustrates the remaining time before a kit becomes claimable once more.
{empty_slots}	Retrieves the number of empty slots in the player's inventory. (Required to disable claim with full inventory)
{required_slots}	Determines the necessary empty slots for claiming a kit, preventing claims when the inventory lacks sufficient space. (Required to disable claim with full inventory)

The placeholders support auto-refresh when you use them on kit items of a menu in the display name and lore.

Upgrade Buttons

These placeholders can be applied to the upgrade buttons within both the display name and lore, enabling dynamic information presentation on the upgrade level and needed cost directly within the user interface.

Placeholder	Description
{upgrade_level}	Indicates the upgrade level of a kit.
{needed}	Presents the required cost for the upgrade if the player currently lacks the necessary funds.
{buy_delay}	Similar to {total} but is for upgrading a kit.
{buy_delay_remaining}	Similar to {cooldown} but is for upgrading a kit.

All the Kits placeholders mentioned above are supported.

Vouchers

These placeholders can be employed across a spectrum of elements associated with voucher claiming, including items, messages, titles, player commands, and console commands. Their adaptability ensures seamless integration, allowing for comprehensive customization and personalization when players claim a voucher.

Placeholder	Description
{player}	Presents the name of the player engaging with the system.
{voucher}	Exhibits the unique identifier assigned to the voucher.

To employ the {player} placeholders on items, it is necessary to activate NBT support in the config.yml file by enabling voucher-settings.nbt-tags.enabled.