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

# Placeholders

How ClickEm placeholders work with PlaceholderAPI, and where to use them.

ClickEm adds placeholders to **PlaceholderAPI** (PAPI). Any plugin that supports PAPI can show ClickEm data: the tab list, scoreboards, holograms, chat formats, BetterHud and more.

All placeholders start with `%clickem_`. For example `%clickem_balance_coins%`.

### Requirements

* **PlaceholderAPI** installed.
* `integrations.placeholderapi.enabled: true` in ClickEm's `config.yml` (the default).
* The expansion registers itself when ClickEm starts, and stays registered across `/papi reload`.

Check that it works:

```
/papi parse me %clickem_balance_coins%
/papi parse <player> %clickem_profile_level%
```

### Where you can use them

| Plugin                        | Example                                                                 |
| ----------------------------- | ----------------------------------------------------------------------- |
| **TAB** (tab list, name tags) | `%clickem_profile_level%` as a suffix                                   |
| **FancyHolograms**            | `%clickem_leaderboard_kills_1_name%` on a hub board                     |
| **BetterHud**                 | The HUD reads `combat`, `pet`, `echo`, `ability` and `hud` placeholders |
| **EssentialsX chat, LPC**     | `%clickem_clan_tag%` in a chat format                                   |
| **Any PAPI plugin**           | Anything below                                                          |

### Good to know

* A placeholder returns **nothing (empty)** when the module behind it is disabled or the value does not apply (for example `%clickem_pet_3_name%` when only 2 pets are equipped).
* Where a value has no owner it shows `None` (text comes from `clickem.placeholder-values.none` in the language file).
* **Big numbers** are written in short form (`1.5K`, `3.2M`, `4.1B`) when a value is 1000 or more. The suffixes come from `clickem.number-suffix.*` in the language file. Stat percentages stay exact below 1000.
* `_formatted` variants give a compact HUD-friendly version: 1000 or more as `1.5K`, below that at most **one decimal, truncated** (not rounded) and dropped if whole (`999.05` becomes `999`, `999.505` becomes `999.5`).
* `_rounded` variants round to a whole number below 1000.
* They are safe to use from plugins that evaluate off the main thread (BetterHud). Values are refreshed on a short cache: fast ones (combat, killstreak, ability, echo charge, matchup) every 0.1 seconds, slow ones (rebirth, clan, leaderboard, navigation) every second, others every 0.25 seconds.
* Names are plain text with no colour. Wrap them in your own colour tag.

### Categories

| Page                                                                       | Covers                                                                 |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [Balances and stats](/lethium-docs/placeholders/stats.md)                  | `balance_*`, `stat_*`, kills                                           |
| [Pets and Echoes](/lethium-docs/placeholders/pets-and-echoes.md)           | `pet_*`, `echo_*`                                                      |
| [Combat](/lethium-docs/placeholders/combat.md)                             | `combat_*`, `killstreak_*`, `ability_*`                                |
| [Zones and navigation](/lethium-docs/placeholders/zones.md)                | `zone_*`, `navigation_*`                                               |
| [Progress](/lethium-docs/placeholders/progress.md)                         | `profile_*`, `rebirth_*`, `clan_*`, `idle_*`, `leaderboard_*`, `hud_*` |
| [Other plugins' placeholders](/lethium-docs/placeholders/other-plugins.md) | Placeholders shipped with this setup by other plugins                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://lethium.gitbook.io/lethium-docs/placeholders.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.