Update Plugin Configuration authored by wordandahalf's avatar wordandahalf
......@@ -232,4 +232,28 @@ Only elements that can be moved can use `behind`.
</details>
# HUD Updating
This documents fields under the `updaters` configuration node.
\ No newline at end of file
`updaters` allows you to configure the events that MythicHUD uses to update the players' custom HUDs.
| Value | Description |
| ----- | ----------- |
| `CONSUMING` | When a player begins to consume food, potions, etc. |
| `ARMOR` | When a player's armor changes, whether via equipping, un-equipping, etc. |
| `AIR` | When a player's remaining air changes, e.g., while under water. |
| `EXPERIENCE` | When a player's experience changes, e.g., after accumulating an experience orb. |
| `RESPAWNING` | When a player dies and respawns. |
<details>
<summary><b>Example</b></summary>
```yaml
updaters:
CONSUMING: false
RESPAWNING: true
ARMOR: false
AIR: false
EXPERIENCE: false
```
This configures the plugin only to update the players' custom HUDs when respawning (in addition to the configured update interval above).
</details>
\ No newline at end of file