> For the complete documentation index, see [llms.txt](https://ultimaterewards.athelion.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ultimaterewards.athelion.eu/placeholders.md).

# Placeholders

The plugin includes registered placeholders that can be utilized anywhere within [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/). The current list of valid placeholders is as follows:

<table data-full-width="true"><thead><tr><th width="404">Placeholder</th><th>Description</th><th data-hidden></th></tr></thead><tbody><tr><td><code>%ultimaterewards_cooldown_{reward}%</code></td><td>displays current state of reward</td><td></td></tr><tr><td><code>%ultimaterewards_state_{reward}%</code></td><td>returns state of reward, e.g. available, unavailable, upcoming, locked</td><td></td></tr><tr><td><code>%ultimaterewards_claimed_of_{rewards}%</code></td><td>shows how many rewards player had claimed from the list, e.g. %ultimaterewards_claimed_of_reward1,reward2%, suitable for non-cooldown rewards (like custom rewards, onetime rewards and others)</td><td></td></tr><tr><td><code>%ultimaterewards_progress_{reward}%</code></td><td>draws the progress bar of the reward</td><td></td></tr><tr><td><code>%ultimaterewards_available%</code></td><td>shows amount of available rewards to claim</td><td></td></tr><tr><td><code>%ultimaterewards_available_{rewardType}%</code></td><td>displays the number of rewards of the specified type to claim, available reward types <a href="/pages/VhRUxfH4JyvBdHx7hIZa">here</a>, e.g. %ultimaterewards_available_time_reward% will only show available rewards with Time Reward type</td><td></td></tr><tr><td><code>%ultimaterewards_current_streak_{reward}%</code></td><td>displays current streak of the specific reward</td><td></td></tr><tr><td><code>%ultimaterewards_referrals%</code></td><td>shows the total number of referral activations</td><td></td></tr><tr><td><code>%ultimaterewards_referred_to%</code></td><td>shows whom the player is referring</td><td></td></tr><tr><td><code>%ultimaterewards_playtime_session%</code></td><td>shows current session play-time</td><td></td></tr><tr><td><code>%ultimaterewards_playtime_local%</code></td><td>shows the time spent on current server</td><td></td></tr><tr><td><code>%ultimaterewards_playtime_local_in_hours%</code></td><td>shows the time spent on current server in hours</td><td></td></tr><tr><td><code>%ultimaterewards_playtime_local_in_minutes%</code></td><td>shows the time spent on current server in minutes</td><td></td></tr><tr><td><code>%ultimaterewards_playtime_global%</code></td><td>shows the total time spent on network (requires MySQL)</td><td></td></tr><tr><td><code>%ultimaterewards_afk_session_time%</code></td><td>shows time elapsed in the AFK area/world</td><td></td></tr><tr><td><code>%ultimaterewards_total_votes%</code></td><td>returns the total number of player's votes </td><td></td></tr><tr><td><code>%ultimaterewards_total_collected%</code></td><td>displays the total number of reward openings</td><td></td></tr><tr><td><code>%ultimaterewards_collected_{reward}%</code></td><td>displays the total number of specific reward openings</td><td></td></tr><tr><td><code>%ultimaterewards_setting_enabled_{setting}%</code></td><td>shows whether the player has the given setting enabled (true/false), setting type can be found <a href="/pages/yk9KmKDZ5nSxdTLhoUvf">here</a></td><td></td></tr><tr><td><code>%ultimaterewards_remaining_time_{reward}%</code></td><td>shows remaining play-time in order to unlock the reward <mark style="color:red;"><strong>NEW</strong></mark></td><td></td></tr></tbody></table>