# Boss Bar

The `boss-bar` action displays a message on a boss bar when an elevator is used with the current floor progress.

---

## Variables

| Variable Name | Description                                  | Default Value  | Elevator Setting Name | Per-Ele Customizable
|---------------|----------------------------------------------|----------------|-----------------------|----------------------
| `message`     | Controls the message shown on the boss bar   |                | `boss-bar/message`    | true
| `barcolor`    | Controls the color of the boss bar           | BLUE           | `boss-bar/color`      | true
| `barstyle`    | Controls the segments of the boss bar        | SOLID          | `boss-bar/style`      | true

---

## Example Usage

```yaml
- 'boss-bar: message=%elevators_new_floor_name% %elevators_new_floor% / %elevators_top_floor% barcolor=PINK barstyle=SEGMENTED_6'
```

---

## Notes

- The boss bar disappears automatically after a few seconds.
- Supported Boss Bar Colors can be found in the [BarColor PaperMC JavaDocs](https://jd.papermc.io/paper/1.21.5/org/bukkit/boss/BarColor.html). Different Minecraft versions may vary.
- Supported Boss Bar Styles can be found in the [BarStyle PaperMC JavaDocs](https://jd.papermc.io/paper/1.21.5/org/bukkit/boss/BarStyle.html). Different Minecraft versions may vary.
- Supports adventure / minimessage formatting and color codes compatible with your server version.
- Supports placeholders.