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

# Placeholders

Needs PlaceholderAPI. `<cat>` is the category's file name (`tabpaint`, `tags`, `glow`...). The identifier `edcosmetics` can be changed, and more identifiers added, in `config.yml` → `placeholders`.

| Placeholder                                | Types                        | Gives                                                                                                                                                                                                                            |
| ------------------------------------------ | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `%edcosmetics_<cat>%`                      | COLOR                        | the colour code (a gradient's first colour, a rainbow's current colour), or `default`                                                                                                                                            |
| `%edcosmetics_<cat>_apply%`                | COLOR                        | `apply-to` painted with the colour (gradients included, formats kept), inside `format`. Nothing equipped: `apply-to` with its own colours, behind `default`. Nothing visible in it (no rank): only its colour codes, no `format` |
| `%edcosmetics_<cat>_apply_raw%`            | COLOR                        | `_apply` without `format`                                                                                                                                                                                                        |
| `%edcosmetics_<cat>_paint_<text>%`         | COLOR                        | any text painted like `_apply`, `format` included (skipped when the text is empty); `{placeholders}` work inside, e.g. `_paint_{player_name}`                                                                                    |
| `%edcosmetics_<cat>_start%` / `_end%`      | COLOR                        | `<gradient:...>` / `</gradient>` around text, for plugins that expand gradients                                                                                                                                                  |
| `%edcosmetics_<cat>%`                      | TEXT                         | the text inside `format`, or `default`                                                                                                                                                                                           |
| `%edcosmetics_<cat>_raw%`                  | TEXT                         | only the text (`''` with nothing equipped)                                                                                                                                                                                       |
| `%edcosmetics_<cat>%`                      | GLOW                         | the current glow colour code (`&c`), or `default`                                                                                                                                                                                |
| `%edcosmetics_<cat>%`                      | SCALE                        | the size (`1.25`), or `default`                                                                                                                                                                                                  |
| `%edcosmetics_<cat>%`                      | HAT                          | the hat's name, or `default`                                                                                                                                                                                                     |
| `%edcosmetics_<cat>%`                      | JOIN\_MESSAGE, QUIT\_MESSAGE | the player's message inside `format`, or `default`                                                                                                                                                                               |
| `%edcosmetics_<cat>_name%`                 | all                          | equipped cosmetic's name, or `none-name`                                                                                                                                                                                         |
| `%edcosmetics_<cat>_id%`                   | all                          | equipped cosmetic's id, or `''`                                                                                                                                                                                                  |
| `%edcosmetics_<cat>_unlocked%` / `_total%` | all                          | cosmetics unlocked / in the category                                                                                                                                                                                             |
| `%edcosmetics_<cat>_has_<cosmetic>%`       | all                          | `yes` when the player has unlocked that cosmetic, else `no`                                                                                                                                                                      |

## Examples

* TAB `groups.yml`: `tabprefix: "%edcosmetics_rankcolor_apply%"`, `customtabname: "%edcosmetics_tabpaint_apply%"`, `tagsuffix: "%edcosmetics_tags%"`.
* Chat name: `'%edcosmetics_rankcolor_apply%&f%edcosmetics_tabpaint_apply%%edcosmetics_tags%'`.
* Chat message (gradient-aware chat plugins): `'%edcosmetics_chatcolor_start%{message}%edcosmetics_chatcolor_end%'`.
* Glow with TAB (`glow.mode: TAB`): `tagprefix: "&f %edcosmetics_glow%"` (the glow code must be last).

Animated rainbows need a short refresh interval in TAB (`placeholder-refresh-intervals`, e.g. `"%edcosmetics_tabpaint_apply%": 500`).