> 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/edevents/features/placeholders.md).

# Placeholders

## Internal placeholders (`{...}`)

Usable in every event text (messages, titles, boss bar, action bar, rewards, announcements).

### Event

| Placeholder                                                        | Description                                                     |
| ------------------------------------------------------------------ | --------------------------------------------------------------- |
| `{prefix}`                                                         | `prefix` from messages.yml.                                     |
| `{plugin}`                                                         | Host plugin name (EdPrison, PinnaPrison, EdTools, EdDungeons).  |
| `{event}` / `{event_id}` / `{event_type}`                          | Display name, id and type.                                      |
| `{description}`                                                    | Description lines joined with a space.                          |
| `{objective}` / `{objective_type}`                                 | Objective display name (`Blocks`) and type.                     |
| `{duration}` / `{duration_short}`                                  | Total duration.                                                 |
| `{time_left}` / `{time_left_short}` / `{time_left_seconds}`        | Remaining time.                                                 |
| `{elapsed}` / `{elapsed_seconds}`                                  | Elapsed time.                                                   |
| `{time_percent}` / `{time_bar}`                                    | Time progress.                                                  |
| `{goal}` / `{goal_formatted}`                                      | `objective.goal`.                                               |
| `{total}` / `{total_formatted}`                                    | Sum of everyone's progress.                                     |
| `{percent}` / `{bar}`                                              | Goal progress (community total, or the leader for other types). |
| `{participants}`                                                   | Players with progress.                                          |
| `{leader_name}` / `{leader_value}` / `{leader_value_formatted}`    | Current leader.                                                 |
| `{top_<n>_name}` / `{top_<n>_value}` / `{top_<n>_value_formatted}` | Leaderboard entry `n` (1..`leaderboard-size`, min 10).          |
| `{started_by}`                                                     | `scheduler` or the command sender.                              |
| `{reason}`                                                         | Why the event ended (messages.yml → `reasons`).                 |
| `{milestone}` / `{milestone_formatted}`                            | In milestone messages.                                          |
| custom                                                             | Every `placeholders.<key>` of the event as `{key}`.             |

### Player (personal texts: boss bar, action bar, personal messages, rewards)

| Placeholder                                     | Description                                       |
| ----------------------------------------------- | ------------------------------------------------- |
| `{player}`                                      | Player name.                                      |
| `{progress}` / `{progress_formatted}`           | Own score.                                        |
| `{position}` / `{position_suffix}`              | Own rank (`3`, `3rd`; `-` when no progress).      |
| `{player_percent}` / `{player_bar}`             | Own progress towards the goal.                    |
| `{remaining}` / `{remaining_formatted}`         | Left to reach the goal.                           |
| `{behind_leader}` / `{behind_leader_formatted}` | Distance to the leader.                           |
| `{winner}` / `{value}` / `{value_formatted}`    | In placement rewards and the winner announcement. |

`/events top` lines also get `{rank}`, `{rank_suffix}`, `{name}`, `{value}`, `{value_formatted}`, `{page}`, `{pages}`.

## PlaceholderAPI (`%edevents_...%`)

Requires PlaceholderAPI. Identifier: `edevents`.

### Global

| Placeholder                                                                      | Description                                                                           |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `%edevents_active%`                                                              | `true` / `false`.                                                                     |
| `%edevents_active_count%`                                                        | Running events.                                                                       |
| `%edevents_plugin%`                                                              | Host plugin name.                                                                     |
| `%edevents_events_count%`                                                        | Configured events.                                                                    |
| `%edevents_next_event%` / `%edevents_next_event_id%`                             | Next automatic event.                                                                 |
| `%edevents_next_in%` / `%edevents_next_in_short%` / `%edevents_next_in_seconds%` | Time until it starts.                                                                 |
| `%edevents_scheduler_enabled%`                                                   | Scheduler state.                                                                      |
| `%edevents_actionbar%`                                                           | The rendered event action bar for the player (embed it in the host plugin's own bar). |
| `%edevents_info_<id>_<name\|duration\|type\|objective\|goal\|active>%`           | Static info of any configured event.                                                  |

### Running event

Every internal placeholder above is available as `%edevents_<name>%` for the first running event, personal ones included: `%edevents_time_left%`, `%edevents_progress_formatted%`, `%edevents_position%`, `%edevents_top_1_name%`, `%edevents_leader_value_formatted%`, `%edevents_percent%`... Prefix with `event_<id>_` to target a specific event (`%edevents_event_ore-rush_time_left%`). When no event runs, `placeholders.not-active` (messages.yml) is returned; `%edevents_event_<id>_active%` is always `true`/`false`.

### Statistics

| Placeholder                                                                                 | Description           |
| ------------------------------------------------------------------------------------------- | --------------------- |
| `%edevents_stats_wins%`                                                                     | 1st places.           |
| `%edevents_stats_top3%`                                                                     | Top-3 finishes.       |
| `%edevents_stats_played%`                                                                   | Events with progress. |
| `%edevents_stats_best%` / `%edevents_stats_best_formatted%` / `%edevents_stats_best_event%` | Best score and where. |
| `%edevents_stats_total%` / `%edevents_stats_total_formatted%`                               | Lifetime progress.    |
| `%edevents_stats_last_win_event%` / `%edevents_stats_last_win_ago%`                         | Last win.             |
| `%edevents_stats_bossbar%` / `%edevents_stats_actionbar%` / `%edevents_stats_messages%`     | Display toggles.      |

### History

| Placeholder                                                                                   | Description                        |
| --------------------------------------------------------------------------------------------- | ---------------------------------- |
| `%edevents_last_winner%`                                                                      | Winner of the last finished event. |
| `%edevents_last_event%` / `%edevents_last_event_id%`                                          | Last finished event.               |
| `%edevents_last_value%` / `%edevents_last_value_formatted%`                                   | Winning score.                     |
| `%edevents_last_participants%` / `%edevents_last_ago%`                                        | Participants / time since.         |
| `%edevents_history_<n>_<winner\|event\|event_id\|value\|value_formatted\|participants\|ago>%` | Same for the n-th last event.      |