Placeholders

Placeholders

The full reference of every placeholder DexRewards resolves in messages and the rewards GUI, and through Placeholder API.

Tip

There are two ways to use a DexRewards placeholder:

• Internal form: %player_dex_count%, %group_name%, etc. Works everywhere DexRewards itself parses text: Messages.json and Reward_GUI.json.
• Placeholder API form: %dexrewards:player_dex_count% (the same ID, prefixed with dexrewards:). Works anywhere another mod supports Placeholder API placeholders: holograms, scoreboards, tab lists, chat mods, etc. Placeholder API is bundled with DexRewards, so these are always registered.

The Reward Group placeholders only exist in the internal form, because they need a specific reward group to read from.

Warning

Placeholders changed in 3.2.0. The old %player.dex_count%-style placeholders and the %player:national.count%-style Placeholder API placeholders were removed. Use the IDs on this page instead.

Choosing a Dex Type

Placeholders that read from a dex type take an optional dex type ID as an argument, written after the ID and separated by a space:

%player_dex_count kanto%
%dexrewards:player_dex_percent shiny_national%

The dex type is picked in this order:

1. The argument, if it's the ID of a loaded dex type.
2. The dex type the text is about. For example, the rewards GUI uses the dex type it was opened for.
3. default_dex_type from Config.json.

So in the rewards GUI, %player_dex_count% shows the open dex type, while %player_dex_count national% always shows the National Dex.

Note

If the argument isn't a loaded dex type's ID, it's ignored and steps 2–3 are used.

Number Formats

Kind	Example	Notes
Count	342
Percentage	47.32, 5, 2.5	Up to two decimal places, without the % sign. Add % yourself in your text, e.g. %player_dex_percent%%.

General

Placeholder	Description
%prefix%	The prefix value from Messages.json.

Dex Type

These read from a dex type (see Choosing a Dex Type).

Placeholder	Description
%dex_type%	The dex type's display_name.
%pokedex_total%	The number of Pokémon in the dex type after filtering, or the number of forms when require_all_forms is on.
%dex_total_groups%	The number of reward groups in the dex type.

Player

These read from a specific player: the player the text is about, or the player viewing it when used through Placeholder API.

Placeholder	Description
%player%	The player's name.
%player_dex_count%	How many of the dex type's Pokémon (or forms) the player has completed.
%player_dex_percent%	The player's completion percentage for the dex type.
%player_reward_group%	The display_name of the highest reward group the player has claimed in the dex type, or None. When several claimed groups share the same required_percent, the one listed last in the file is used.

%player_dex_count%, %player_dex_percent% and %player_reward_group% also take a dex type argument.

Reward Group

Internal form only. Available in text about a specific reward group: the group items in the rewards GUI, and the reward_claimable and rewards_claimed messages.

Placeholder	Description
%group_name%	The group's display_name. Also available as %reward_group_name%.
%group_percent%	The group's required_percent. Also available as %reward_group_percent%.

Where Each Group Works

Location	Dex Type	Player	Reward Group
rewards_to_claim	✅	✅	❌
reward_claimable, rewards_claimed	✅	✅	✅
reset_command_sender, reset_command_target	✅	✅ (the reset player)	❌
update_command	✅ (default dex type)	✅ (the updated player)	❌
reload_command	✅ (default dex type)	❌	❌
Rewards GUI title, player info, buttons, background	✅	✅	❌
Rewards GUI group items	✅	✅	✅
Other mods (Placeholder API)	✅ (default dex type)	✅	❌

%prefix% works everywhere. A placeholder that can't be resolved in a location, or an unknown placeholder, is left as written.

Placeholder API Examples

%dexrewards:player_dex_count%                → 342 (default dex type)
%dexrewards:player_dex_percent kanto%        → 74.83
%dexrewards:pokedex_total shiny_national%    → 886
%dexrewards:player_reward_group%             → Ranger
%dexrewards:dex_type kanto%                  → Kanto Dex

See Also

• Messages.json: where the internal placeholders are used in chat.
• Reward_GUI.json: where they're used in the GUI.
• Your_Dex_Type.json: the dex type and reward group values these placeholders read.