Placeholders

Every placeholder the plugin registers in PlaceholderAPI.

The plugin registers the placeholders below, which can be used anywhere PlaceholderAPI is supported — in reward lore, menus, actions, scoreboards, holograms and other plugins.

{reward} is the file name of the reward (without .yml), {rewardType} one of the reward types.

While a player's data is still being loaded, placeholders return the loading message from lang.yml.

Rewards

Placeholder	Description
%ultimaterewards_state_{reward}%	State of the reward, e.g. available, unavailable, upcoming, locked
%ultimaterewards_cooldown_{reward}%	Remaining cooldown of the reward. When use-timer-in-placeholder is false in config.yml, the unavailable text from lang.yml is shown instead
%ultimaterewards_progress_{reward}%	Draws the progress bar of the reward (styling is set by the progress-bar-* keys in config.yml)
%ultimaterewards_available%	Number of rewards the player can claim right now
%ultimaterewards_available_{rewardType}%	Number of claimable rewards of one type only, e.g. %ultimaterewards_available_time_reward%
%ultimaterewards_claimed_of_{rewards}%	How many rewards of a comma-separated list the player has already claimed, e.g. %ultimaterewards_claimed_of_reward1,reward2%. Suitable for non-cooldown rewards (custom, one-time and similar)
%ultimaterewards_collected_{reward}%	How many times the player has claimed this specific reward
%ultimaterewards_total_collected%	How many rewards the player has claimed in total
%ultimaterewards_current_streak_{reward}%	The player's current streak of a streak-based reward
%ultimaterewards_remaining_time_{reward}%	Play-time still missing before the reward unlocks (play-time reward types only). Formatted by remaining-play-time-placeholder-format in config.yml

Play-time

Placeholder	Description
%ultimaterewards_playtime_local%	Time spent on the current server, formatted by play-time-placeholder-format in config.yml
%ultimaterewards_playtime_local_in_hours%	Time spent on the current server, in whole hours
%ultimaterewards_playtime_local_in_minutes%	Time spent on the current server, in whole minutes
%ultimaterewards_playtime_local_formatted_{format}%	Time spent on the current server in a format defined inline — see below
%ultimaterewards_playtime_global%	Total time spent on the network (requires a shared MySQL / MariaDB / PostgreSQL backend)
%ultimaterewards_playtime_session%	Play-time of the current session
%ultimaterewards_afk_session_time%	Time elapsed in the AFK area/world, formatted by afk-time-placeholder-format in config.yml

Inline play-time format

%ultimaterewards_playtime_local_formatted_{format}% lets you define the format directly in the placeholder instead of relying on config.yml. Because % and spaces cannot appear inside a placeholder, they are written as # and _:

Written as	Renders as
%ultimaterewards_playtime_local_formatted_#hours#h_#minutes#m%	12h 30m
%ultimaterewards_playtime_local_formatted_#days#_days%	3 days

Available units are #days#, #hours#, #minutes# and #seconds#.

Referrals & votes

Placeholder	Description
%ultimaterewards_referrals%	Total number of activations of the player's referral code
%ultimaterewards_referred_to%	Name of the player whose referral this player applied
%ultimaterewards_total_votes%	Total number of the player's votes

Player settings

Placeholder	Description
%ultimaterewards_setting_enabled_{setting}%	Whether the player has the given setting enabled (true/false)