# Placeholders

This are the plugins placeholders that work with the [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/).

## Ranking Placeholders

#### All-Time

| Placeholder (place) represents the ranking. | Description                                                                                                                                                  |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| %ctd\_alltime\_amount\_(place)%             | Returns how much the player at the specified all-time leaderboard rank has spent.                                                                            |
| %ctd\_alltime\_name\_(place)%               | Returns the name of the player at the specified all-time leaderboard rank.                                                                                   |
| %ctd\_alltime\_skin\_(place)%               | Returns the skin of the player at the specified all-time leaderboard rank. If no skin is available, the `embed-purchase-offline-skin` value is used instead. |

#### Monthly

| Placeholder (place) represents the ranking. | Description                                                                                                                                                 |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| %ctd\_monthly\_amount\_(place)%             | Returns how much the player at the specified monthly leaderboard rank has spent.                                                                            |
| %ctd\_monthly\_name\_(place)%               | Returns the name of the player at the specified monthly leaderboard rank.                                                                                   |
| %ctd\_monthly\_skin\_(place)%               | Returns the skin of the player at the specified monthly leaderboard rank. If no skin is available, the `embed-purchase-offline-skin` value is used instead. |

#### GGWave Stats

| Placeholder (place) represents the ranking.           | Description                                                                 |
| ----------------------------------------------------- | --------------------------------------------------------------------------- |
| %ctd\_alltime\_ggwave\_participated\_amount\_(place)% | Returns the amout of ggwave participations the player on "place" has.       |
| %ctd\_alltime\_ggwave\_sent\_amount\_(place)%         | Returns the amout of ggwave messages the player on "place" has sent.        |
| %ctd\_alltime\_ggwave\_participated\_name\_(place)%   | Returns the name of the player on "place" on the participation leaderboard. |
| %ctd\_alltime\_ggwave\_sent\_name\_(place)%           | Returns the name of the player on "place" on the sent leaderboard.          |

## Player Placeolders

<table><thead><tr><th width="376">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%ctd_player_spent_alltime%</td><td>Returns the total amount the player has spent across all time.</td></tr><tr><td>%ctd_player_spent_monthly%</td><td>Returns the total amount the player has spent during the current month.</td></tr><tr><td>%ctd_player_spent_alltime_raw%</td><td>Returns the raw all-time amount the player has spent without formatting.</td></tr><tr><td>%ctd_player_spent_monthly_raw%</td><td>Returns the raw monthly amount the player has spent without formatting.</td></tr><tr><td>%ctd_ggwave_participated%</td><td>Returns the amount of ggwaves a player has participated in.</td></tr><tr><td>%ctd_ggwave_sent%</td><td>Returns the amount of messages a player has sent during ggwaves.</td></tr></tbody></table>

## Goal Placeholders

<table><thead><tr><th width="376">Placeholder (goalid) represents the goal id.</th><th>Description</th></tr></thead><tbody><tr><td>%ctd_goal_bars_(goalid)%</td><td>Returns the progress bar display for the specified goal, where <code>(goalid)</code> is the goal identifier.</td></tr><tr><td>%ctd_goal_dcbars_(goalid)%</td><td>Returns the Discord-formatted progress bar display for the specified goal, where <code>(goalid)</code> is the goal identifier.</td></tr><tr><td>%ctd_goal_reached_amount_(goalid)%</td><td>Returns the current progress amount of the specified goal.</td></tr><tr><td>%ctd_goal_reached_percentage_(goalid)%</td><td>Returns the current completion percentage of the specified goal.</td></tr><tr><td>%ctd_goal_target_(goalid)%</td><td>Returns the target amount required to complete the specified goal.</td></tr><tr><td>%ctd_goal_achieved%</td><td>Returns the number of times the goal has been completed.</td></tr></tbody></table>

### Where do i find my goalid ?

> When on goal-mode: `external`. The goal-id is provided by the store provider. Once loaded into CSD, you will find the goal-id under /csd listgoals.

> When on goal-mode: `internal`. You have to create a goal first. Use the /csd creategoal command.

## Sale Placeholders

<table><thead><tr><th width="376">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%ctd_sales_name%</td><td>Returns the name of the most recently active sale.</td></tr><tr><td>%ctd_sales_amount%</td><td>Returns the percentage or fixed value of the most recently active sale.</td></tr></tbody></table>

## Latest Purchase Placeholders

<table><thead><tr><th width="376">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%ctd_latest_player%</td><td>Returns the name of the player who made the most recent purchase.</td></tr><tr><td>%ctd_latest_amount%</td><td>Returns the amount of the most recent purchase.</td></tr><tr><td>%ctd_latest_package%</td><td>Returns the name of the first package included in the most recent purchase.</td></tr><tr><td>%ctd_latest_packages%</td><td>Returns the names of all packages included in the most recent purchase.</td></tr></tbody></table>


---

# 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://obey.gitbook.io/wiki/storedata/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.