Placeholders

Placeholders

View as Markdown ·

On this page

PhoenixCrates supports PlaceholderAPI, allowing you to use player data from our plugin in other plugins that also support PlaceholderAPI. Below is a list of the available PlaceholderAPI placeholders as well as our internal placeholders that you can use in holograms.

#PlaceholderAPI

The following is the list of the available placeholders that Phoenixcrates has, make sure to replace the <id> with the ID of your crate without using the <>.

Placeholders Description
%phoenixcrates_keys_<key_id>% Returns the number of keys a user has (virtual + physical).
%phoenixcrates_cooldown_<crate_id>% Returns the cooldown timer for that specific crate.
%phoenixcrates_totalopened_<crate_id>% Returns the total number of how many times a user opened that specific crate.
%phoenixcrates_totalopened% Returns the total number of openings for a user.
%phoenixcrates_rerolls_available_<crate_id>% Returns the amount of rerolls a user has for a crate.
%phoenixcrates_guaranteed_amount_<crate_id>% Returns the number of openings remaining until the user's next guaranteed reward for that crate.
%phoenixcrates_guaranteed_reward_<crate_id>% Returns the name of the next guaranteed reward the user will receive for that crate.
%phoenixcrates_winLimit_<crate_id>_<reward_id>% Returns the player's win limit progress for a specified reward (amount/limit).
%phoenixcrates_globalWinLimit_<crate_id>_<reward_id>% Returns the global win limit progress for a specified reward (amount/limit).
%phoenixcrates_rewardTimeLimit_<crate_id>_<reward_id>% Returns the time remaining until the reward expires.
%phoenixcrates_cooldownGlobalWin_<crate_id>_<reward_id>% Returns the global win limit cooldown remaining.
%phoenixcrates_cooldownWinLimit_<crate_id>_<reward_id>% Returns the player's win limit cooldown remaining.

#Hologram Placeholders

These are available in a crate's hologram lines, on top of any PlaceholderAPI placeholder.

Placeholders Description
%name% The crate's display name.
%cooldown% The viewer's remaining cooldown for this crate, or the "available to open" text when there is none.
%virtual_keys% How many virtual keys the viewer holds across every key linked to this crate.
%player% The viewer's name.
%online% The number of players online.
%max_online% The server's player limit.
%plugin_version% The installed PhoenixCrates version.

Holograms are per player, so each viewer sees their own cooldown and key count. How often those values refresh is set with hologram-refresh-rate in Main Configuration.

#Internal Placeholders

The following placeholders are available when configuring reward display items, such as in the menus configuration:

Placeholders Description
%player% Returns the name of the player.
%reward_name% Returns the display name of the reward.
%reward_lore% Returns the lore of the reward.
%percentage% Returns the configured weight/percentage of the reward.
%chance% Returns the calculated chance (%) of receiving the reward.
%required_keys% Returns the number of keys required to redeem the reward.
%amount_limit% Returns the number of wins remaining before the reward's win limit is reached.
%global_amount_limit% Returns the number of wins remaining before the reward's global win limit is reached.

%percentage% and %chance% keep up to five decimals for values below 0.01, so a very rare reward does not show as 0. | %win_amount% | Returns the player's current win count for the reward (preview and select-reward menus). | | %win_limit% | Returns the reward's win limit (preview and select-reward menus). | | %global_win_amount% | Returns the current global win count for the reward (preview and select-reward menus). | | %global_limit% | Returns the reward's global win limit (preview and select-reward menus). | | %cooldown% | Returns the time remaining on the player's win limit cooldown (preview and select-reward menus). | | %global_cooldown% | Returns the time remaining on the global win limit cooldown (preview and select-reward menus). | | %time% | Returns the time remaining until a time-limited reward expires (preview menu). | | %rarity_name% | Returns the reward's rarity display name (requires the Rarity Add-on). | | %total_selections% | Returns how many rewards are selected (mass selection menu). | | %available_keys% | Returns how many keys the player owns for the crate (mass selection menu). | | %selected_amount% | Returns how many times that reward is selected (mass selection menu). |

My Cart
Spider

Your cart is empty

Looks like the spiders padded through here. Pick a plugin and it will show up here. Continue shopping