# Placeholders

{% hint style="warning" %}
**Note:** There are no ecloud extensions for IridiumSkyblock in PlaceholderAPI. This means that you *don't* have to do `/papi ecloud download <extension>`. The placeholders will simply work. Running this command will break these placeholders.
{% endhint %}

<details>

<summary>Placeholder Wrapping and Notes</summary>

* If you have **PlaceholderAPI** installed, you need to wrap the placeholder with percentage signs. Example: `%iridiumskyblock_island_value%`.
* If you are using **MVdWPlaceholderAPI,** you need to wrap the placeholder with a curly bracket. Example: `{iridiumskyblock_island_value}`.
* Placeholders with `#` should be replaced with the island's ranking on the island top, here's an Example: `%iridiumskyblock_island_top_1_name%`.
* Placeholders with `upgradeType` should be replaced with the type of upgrade. Currently, you can replace it with `blocklimit`, `member`, `size`, `warp`, and `generator`.
* Chat placeholders MUST be use with `[` and `]` surrounding them. \
  Example: `[ISLAND_RANK]`.

</details>

## Using These Placeholders

IridiumSkyblock has many placeholders, and the best way to explain how they work is to separate them into parts.

### Prefix

This is the first part of the placeholder and is REQUIRED in order to use any placeholders. Using a body without a prefix will result in the placeholder being displayed instead of the value it represents.

Example: `iridiumskyblock_island`*`_`*

### `Body`

This is the second part of the placeholder and REQUIRED to use any placeholders. Using a prefix without a body will result in the placeholder being displayed instead of the value it represents.

Example: `member_names`

In the example provided, the entire placeholder would be `iridiumskyblock_island_member_names`.

{% tabs %}
{% tab title="Prefix" %}

<table><thead><tr><th width="298.3654017343316">Prefix</th><th width="207.2623752236884">Description</th><th>Example</th></tr></thead><tbody><tr><td><code>iridiumskyblock_island_</code></td><td>This will show the placeholder result for the player's own island.</td><td><code>%iridiumskyblock_island_level%</code> - This will show your island's level.</td></tr><tr><td><code>iridiumskyblock_current_</code></td><td>This will show the placeholder result for the island that the player is currently on.</td><td><code>%iridiumskyblock_current_level%</code> - This will show the level of the island you're visiting.</td></tr><tr><td><code>iridiumskyblock_island_top_#_</code></td><td>This will show the placeholder result for the island top <code>#</code>.</td><td><code>%iridiumskyblock_island_top_1_level%</code> - This will show the level of the top 1 island in the server.</td></tr></tbody></table>

{% endtab %}

{% tab title="Body" %}

<table data-header-hidden><thead><tr><th width="161.47100933424605">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>Placeholder</td><td>Description</td></tr><tr><td>name</td><td>This will return the island's name.</td></tr><tr><td>owner</td><td>This will return the island owner's name.</td></tr><tr><td>rank</td><td>This will return the island's rank in the island top.</td></tr><tr><td>level</td><td>This will return the island's total level.</td></tr><tr><td>value</td><td>This will return the island's total value.</td></tr><tr><td>members</td><td>This will return the number of island members.</td></tr><tr><td>visitors</td><td>This will return the number of visitors on the island.</td></tr><tr><td>players</td><td>This will return the number of players currently on the island.</td></tr><tr><td>member_names</td><td>This will return all the names of all island members separated by commas.</td></tr><tr><td>visitor_names</td><td>This will return all the names of all island visitors separated by commas.</td></tr><tr><td>player_names</td><td>This will return all the names of all players on the island separated by commas.</td></tr><tr><td>experience</td><td>This will return the amount of experience the island currently has.</td></tr><tr><td>experience_required</td><td>This will return how much experience is required for the next level.</td></tr><tr><td>experience_remaining</td><td>This will return how much remaining experience is needed to level up.</td></tr><tr><td>overworld_biome</td><td>This will return the island's selected biome in the overworld.</td></tr><tr><td>nether_biome</td><td>This will return the island's selected biome in the nether.</td></tr><tr><td>end_biome</td><td>This will return the island's selected biome in the end.</td></tr><tr><td>bank_experience</td><td>This will return the island's total experience in the bank.</td></tr><tr><td>bank_crystals</td><td>This will return the island's total amount of crystals in the bank.</td></tr><tr><td>bank_money</td><td>This will return the island's total amount of money in the bank.</td></tr><tr><td>upgrade_<code>upgradeType</code>_level</td><td>This will return the island's upgrade level of the specified upgradeType.</td></tr><tr><td>upgrade_member_amount</td><td>This will return the max amount of island members that the island can get.</td></tr><tr><td>upgrade_warp_amount</td><td>This will return the max amount of island warps that the island can get.</td></tr><tr><td>upgrade_size_dimensions</td><td>This will return the island's size dimensions.</td></tr></tbody></table>

{% endtab %}

{% tab title="Chat Placeholders" %}

<table><thead><tr><th>Placeholder</th><th width="232.33333333333331">Description</th><th data-hidden>Example</th></tr></thead><tbody><tr><td>ISLAND_LEVEL</td><td>Displays the level of the island the player belongs to.</td><td></td></tr><tr><td>ISLAND_RANK</td><td>Displays the rank of the island the player belongs to.</td><td></td></tr><tr><td>ISLAND_VALUE</td><td>Displays the value of the island the player belongs to.</td><td></td></tr></tbody></table>
{% endtab %}
{% endtabs %}