> For the complete documentation index, see [llms.txt](https://enchantedmobs.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://enchantedmobs.superiormc.cn/for-ultimatequest/features/placeholders.md).

# PlaceholderAPI

Install PlaceholderAPI before startup to register the persistent ultimatequest expansion. Supported patterns:

```

%ultimatequest_state_<task-or-instance>%
%ultimatequest_battlepass_total_<id>%
%ultimatequest_battlepass_level_<id>%
%ultimatequest_battlepass_season_<id>%
%ultimatequest_battlepass_remaining_<id>%
%ultimatequest_battlepass_progress_<id>%
%ultimatequest_battlepass_percent_<id>%
%ultimatequest_battlepass_premium_<id>%
%ultimatequest_battlepass_claimable_<id>%
%ultimatequest_battlepass_timeleft_<id>%

```

Replace battlepass with milestone for milestone fields. total is cumulative progress, level is the reached stage, remaining is progress to the next threshold, progress is progress since the previous threshold, percent is an integer percentage, premium is a boolean, claimable counts available stages accessible to the online player, and timeleft is seconds until end (-1 for no end). Premium checks require an online player.

Before state is ready, the expansion returns LOADING. state returns AVAILABLE when no instance exists; this alone does not prove that a definition exists or acceptance requirements are met. Unknown patterns return no value. Menu-local braces such as {name} are separate from PlaceholderAPI.
