> 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/pets-and-echoes.md).

# Pet and Echo placeholders

Equipped pet and Echo placeholders for HUDs.

### Pets

Pet slots are numbered from **1** in equip order. A slot past the last equipped pet returns nothing.

| Placeholder                                                                   | Returns                                                                                           |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `%clickem_pet_equipped_count%`                                                | Pets equipped                                                                                     |
| `%clickem_pet_slots_max%`                                                     | Equip slots the player has                                                                        |
| `%clickem_pet_owned_count%`                                                   | Pets owned                                                                                        |
| `%clickem_pet_ticket_enhancement%`                                            | Enhancement Tickets                                                                               |
| `%clickem_pet_ticket_boost%`                                                  | Boost Tickets                                                                                     |
| `%clickem_pet_ticket_special%`                                                | Special Boost Tickets                                                                             |
| `%clickem_pet_<n>_name%`                                                      | Name of pet `n`                                                                                   |
| `%clickem_pet_<n>_name_short%`                                                | Name cut to 10 characters on a word boundary, for narrow HUDs (`Oaken Hopper` becomes `Oaken H.`) |
| `%clickem_pet_<n>_level%`                                                     | Level                                                                                             |
| `%clickem_pet_<n>_level_cap%`                                                 | Its level cap right now                                                                           |
| `%clickem_pet_<n>_variant%`                                                   | Golden, Rainbow or Shiny (empty for none)                                                         |
| `%clickem_pet_<n>_grade%`                                                     | Grade (`F` to `GOD-LIKE`)                                                                         |
| `%clickem_pet_<n>_prestige%`                                                  | Prestige count                                                                                    |
| `%clickem_pet_<n>_power%`                                                     | Power it gives                                                                                    |
| `%clickem_pet_<n>_coins%`                                                     | Coins bonus it gives                                                                              |
| `%clickem_pet_<n>_essence%`                                                   | Essence bonus it gives                                                                            |
| `%clickem_pet_<n>_power_formatted%`, `_coins_formatted`, `_essence_formatted` | Compact versions                                                                                  |
| `%clickem_pet_<n>_ability_cooldown%`                                          | Seconds left on its active ability. `0` ready, `-1` it has none                                   |

Example: `%clickem_pet_1_name% Lv.%clickem_pet_1_level%`.

### Echoes

| Placeholder                         | Returns                                                                                                                                 |
| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `%clickem_echo_equipped_count%`     | Echoes equipped                                                                                                                         |
| `%clickem_echo_slots_max%`          | Equip slots                                                                                                                             |
| `%clickem_echo_fragments%`          | Roll XP balance                                                                                                                         |
| `%clickem_echo_charge%`             | Echo Charge bar progress as `0.10` to `1.00` (a HUD bar scale, not a percent)                                                           |
| `%clickem_echo_element%`            | The player's dominant element name (`Fire`)                                                                                             |
| `%clickem_echo_element_color%`      | That element's MiniMessage colour tag                                                                                                   |
| `%clickem_echo_element_icon%`       | The element id in lower case (`fire`, `neutral`) for building a BetterHud image name                                                    |
| `%clickem_echo_matchup_tier%`       | How the element fares against the mob being hit: `Very Weak`, `Weak`, `Neutral`, `Strong`, `Very Strong`, or `None` when not in a fight |
| `%clickem_echo_matchup_multiplier%` | The damage multiplier for that matchup (empty when not fighting)                                                                        |
| `%clickem_echo_<n>_element%`        | Element of equipped Echo `n`                                                                                                            |
| `%clickem_echo_<n>_level%`          | Level of equipped Echo `n`                                                                                                              |

See [Echoes](/lethium-docs/gameplay/echoes.md) for what the matchups mean.


---

# 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/pets-and-echoes.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.