# 🆎 Placeholders

## PlaceholderAPI

* `%combatpets_health%` - Current pet health.
* `%combatpets_max_health%` - Max. pet health.
* `%combatpets_xp%` - Current pet XP.
* `%combatpets_level%` - Pet level.
* `%combatpets_required_xp%` - Total XP amount for the next level.
* `%combatpets_name%` - Pet name.
* `%combatpets_tier_name%` - Pet tier name.
* `%combatpets_aspect_points%` - Amount of Aspect Points.
* `%combatpets_combat_mode%` - Pet combat mode.
* `%combatpets_attribute_[name]%` - Pet [Attribute](/combatpets/features/pet-attributes.md) value.
* `%combatpets_aspect_[name]%` - Pet [Aspect](/combatpets/features/pet-aspects.md) value.

You can use PlaceholderAPI placeholders in GUI's titles and items by enabling the `PlaceholderAPI_In_GUI` option in the **config.yml**.

## Internal Placeholders

{% hint style="info" %}
This is a list of placeholder to use inside plugin configurations. For a list of **PlaceholderAPI** placeholders, see above ↑.
{% endhint %}

### Pet Placeholders

* `%pet_name%` - Pet name.
* `%pet_silent%` - Whether or not pet sounds are muted.
* `%pet_is_dead%` - Whether or not pet is dead.
* `%pet_level%` - Current level.
* `%pet_health%` - Current health.
* `%pet_max_health%` - Max health.
* `%pet_saturation%` - Current saturation.
* `%pet_max_saturation%` - Max saturation.
* `%pet_food%` - Food list.
* `%pet_xp%` - Current XP.
* `%pet_required_xp%` - Total amount of XP for next level.
* `%pet_aspect_points%` - Amount of Aspect Points.
* `%pet_combat_mode%` - Combat mode.
* `%pet_equipment_unlocked%` - Whether or not equipment is unlocked.
* `%pet_inventory_filled%` - Inventory fill percent.
* `%pet_owner_name%` - Owner name.

### Pet Template Placeholders

* `%pet_config_id%` - Template unique identifier (file name).
* `%pet_config_name%` - Default pet name.

### Pet Tier Placeholders

* `%pet_tier_id%` - Tier unique identifier (file name).
* `%pet_tier_name%` - Tier display name.
* `%pet_tier_inventory_has%` - Whether or not inventory is allowed.
* `%pet_tier_inventory_size%` - Inventory size.
* `%pet_tier_equipment_has%` - Whether or not equipment is allowed.
* `%pet_tier_death_revive_cooldown%` - Pet auto-respawn time.
* `%pet_tier_death_revive_cost%` - Pet revive cost.

### Aspect Placeholders

* `%aspect_name%` - Aspect display name.

## Currency Placeholders

* `%currency_id%` - Unique currency identifier.
* `%currency_name%` - Currency display name.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://nightexpress.gitbook.io/combatpets/utility/placeholders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
