# Ranks

<details>

<summary>Structure</summary>

```yaml
rank:
  display-name: "<red>Owner"
  weight: 10
  changeable: true
  permissions: []
  allow-toggle: []
```

* `display-name` - Rank display name

- `weight` - Rank weight (higher values = more important)

* `changeable` - Allows promoting / demoting to or from this rank

- `permission` - Rank permissions

* `allow-toggle` - Permissions allowed to be modified by other ranks

</details>

<details>

<summary>EXAMPLE - Full config</summary>

```yaml
rank:
  display-name: "<red>Owner"
  weight: 10
  changeable: true # Allow promoting / demoting to this rank

  permissions: # Permissions to allow (set to true) as default
    - "GUI_OPEN"
    - "PROTECTION_TELEPORT_HOME"
    - "PROTECTION_BUY_FUEL"
    - "PROTECTION_BUY_UPGRADE"
    - "PROTECTION_COLLECT_GENERATOR"
    - "PROTECTION_INVITE_OUTSIDER"
    - "PROTECTION_STATUS_CHANGE"

    - "BLOCK_BURN"
    - "BLOCK_PLACE"
    - "BLOCK_BREAK"
    - "PLAYER_ITEM_PICKUP"
    - "PLAYER_ITEM_DROP"
    - "PLAYER_MOVE_IN"
    - "PLAYER_MOVE_OUT"
    - "PLAYER_MOVE_IN_OUT"
    - "PLAYER_TELEPORT_IN"
    - "PLAYER_TELEPORT_OUT"
    - "PLAYER_TELEPORT_IN_OUT"

    - "PERMISSION_TOGGLE_MEMBER"
    - "PERMISSION_TOGGLE_OUTSIDER"
    - "PERMISSION_TOGGLE_PROTECTION"

    - "MEMBER_PROMOTE"
    - "MEMBER_DEMOTE"
    - "MEMBER_INVITE"

    - "INTERACT"
    - "INTERACT_CONTAINER"
    - "INTERACT_ENTITY"

    - "IGNITE"

    - "BUCKET_WATER_FILL"
    - "BUCKET_WATER_EMPTY"
    - "BUCKET_LAVA_FILL"
    - "BUCKET_LAVA_EMPTY"

    - "UNKNOWN"
  allow-toggle: # Allow toggle by higher ranks -- does not allow editing yourself
    - "GUI_OPEN"
    - "PROTECTION_TELEPORT_HOME"
    - "PROTECTION_BUY_FUEL"
    - "PROTECTION_BUY_UPGRADE"
    - "PROTECTION_COLLECT_GENERATOR_MONEY"
    - "PROTECTION_COLLECT_GENERATOR_ITEMS"
    - "PROTECTION_INVITE_OUTSIDER"
    - "PROTECTION_STATUS_CHANGE"

    - "BLOCK_BURN"
    - "BLOCK_PLACE"
    - "BLOCK_BREAK"
    - "PLAYER_ITEM_PICKUP"
    - "PLAYER_ITEM_DROP"
    - "PLAYER_MOVE_IN"
    - "PLAYER_MOVE_OUT"
    - "PLAYER_MOVE_IN_OUT"
    - "PLAYER_TELEPORT_IN"
    - "PLAYER_TELEPORT_OUT"
    - "PLAYER_TELEPORT_IN_OUT"

    - "PERMISSION_TOGGLE_MEMBER"
    - "PERMISSION_TOGGLE_OUTSIDER"
    - "PERMISSION_TOGGLE_PROTECTION"

    - "MEMBER_PROMOTE"
    - "MEMBER_DEMOTE"
    - "MEMBER_INVITE"

    - "INTERACT"
    - "INTERACT_CONTAINER"
    - "INTERACT_ENTITY"

    - "IGNITE"

    - "BUCKET_WATER_FILL"
    - "BUCKET_WATER_EMPTY"
    - "BUCKET_LAVA_FILL"
    - "BUCKET_LAVA_EMPTY"

    - "UNKNOWN"
```

</details>
