# Roles and their Flags

Lands has a feature packed role system which allows each land to adjust flags for each role and create new roles for your land. Players can change role flags by opening their land menu (`/lands`) and then navigating to the roles menu. You as an administrator can edit/add default roles. Wilderness flags can be edited in the `/lands admin wilderness` menu.

Whenever a new flag is added to Lands, all existing Lands will apply the flag, if specified by the flag author.\
But for future land creations, you need to configure it correctly here. Lands will always send you a popup in console and on\
admin in game accounts, if there is a new flag available.

## Reset flag(s) to their defined state from roles.yml

`/lands admin land <land | *> resetFlag <flag | all>`\
Keep in mind that changes to the roles.yml file require a server restart or reload. This only affects the following roles: owner, member, visitor, nation, ally

## Set flag states

`/lands admin land <land | *> setflag <flag> <state> <apply-to-visitors>`\
This also affects roles created by players. If apply-to-visitors is false, it won't set the flag for the visitor role.

## Add a custom role from roles.yml to a land or all existing lands

> /lands admin land \<land | \*> addRole\
> Caution: Executing this command can lead to lands having this role multiple times. For example, if an existing land already got this role assigned at land creation or if you execute this command multiple times with the same role. Since lands can change the name of a role, there is no unique identification possible by name.

## Hide / show flags from the flags menu

```yaml
  # Which flags should be displayed in the role settings menu?
  # You can still set default values below and hide them by removing them from this list.
  display:
    - BLOCK_PLACE
    - BLOCK_BREAK
    - PLANT
    - HARVEST
    - BLOCK_IGNITE
    - INTERACT_GENERAL
    - INTERACT_CONTAINER
    - INTERACT_DOOR
    - INTERACT_TRAPDOOR
    - INTERACT_MECHANISM
    - INTERACT_VILLAGER
    - ATTACK_PLAYER
    - ATTACK_ANIMAL
    - ATTACK_MONSTER
    - FLY
    - SPAWN_TELEPORT
    - ENDER_PEARL
    - LAND_ENTER
    - VEHICLE_USE
    - ITEM_PICKUP
    - TRAMPLE_FARMLAND
    - LAND_CLAIM
    - LAND_CLAIM_BORDER
    - SPAWN_SET
    - BALANCE_WITHDRAW
    - AREA_ASSIGN
    - WAR_MANAGE
    - PLAYER_TRUST
    - PLAYER_SETROLE
    - PLAYER_UNTRUST
    - PLAYER_BAN
    - SETTING_EDIT_LAND
    - SETTING_EDIT_ROLE
    - SETTING_EDIT_TAXES
    - SETTING_EDIT_VARIOUS
```

## Edit / add default Roles

You can find the configuration options in your `roles.yml` located in `/plugins/lands`. In this file you can edit existing default roles or add your own default roles. These roles will apply to new land creations.

Example Configuration of a custom default role:

```yaml
    yourCustomDefaultRole:
      name: '&eCustomDefaultRole'
      # The icon supports texture values (example: https://minecraft-heads.com/) and normal material values.
      icon: 'eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYjFhZGZkZjA3MTE3NWFkYWQ2NDRmZTRiM2E5NzMxYWM2YThmYTQ3NTExNjJlODEzOGM4OTlmYmFhNWZmMGI5In19fQ=='
      # Default flag values. Please note that these only apply to new land creations. Players will be able to change them later in their land menu if the flag is listed under 'display' above.
      default:
        - BLOCK_PLACE
        - BLOCK_BREAK
        - INTERACT_GENERAL
        - INTERACT_DOOR
        - INTERACT_CONTAINER
        - INTERACT_MECHANISM
        - INTERACT_VILLAGER
        - BLOCK_IGNITE
        - ATTACK_PLAYER
        - ATTACK_ANIMAL
        - FLY
        - LAND_ENTER
        - SPAWN_TELEPORT
        - VEHICLE_USE
        - ITEM_PICKUP
```

## Flags

### Action Flags

Actions flags represent players actions. Each flag has their own bypass and toggle permission, which is required for players to toggle the flag. The wilderness bypass permission allows a player to bypass flags set in the wilderness via `/lands admin menu`.

* **BLOCK\_PLACE**\
  Allows the role to place blocks.\
  \&#xNAN;*Toggle permission: lands.role.setting.block\_place*\
  \&#xNAN;*Bypass permission: lands.bypass.block\_place*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.block\_place*
* **BLOCK\_BREAK**\
  Allows the role to break blocks.\
  \&#xNAN;*Toggle permission: lands.role.setting.block\_break*\
  \&#xNAN;*Bypass permission: lands.bypass.block\_break*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.block\_break*
* **PLANT**\
  Allows the role to plant crops, saplings, etc.\
  \&#xNAN;*Toggle permission: lands.role.setting.plant*\
  \&#xNAN;*Bypass permission: lands.bypass.plant*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.plant*
* **HARVEST**\
  Allows the role to harvest crops, etc.\
  \&#xNAN;*Toggle permission: lands.role.setting.harvest*\
  \&#xNAN;*Bypass permission: lands.bypass.harvest*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.harvest*
* **INTERACT\_GENERAL**\
  Allows all types of interaction that are not covered by the other `INTERACT_<type>` flags.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_general*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_general*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_general*
* **INTERACT\_CONTAINER**\
  Allows the role to open containers like chests, etc.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_container*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_container*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_container*
* **INTERACT\_DOOR**\
  Allows the role to open and close doors.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_door*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_door*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_door*
* **INTERACT\_TRAPDOOR**\
  Allows the role to open and close trapdoors.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_trapdoor*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_trapdoor*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_trapdoor*
* **INTERACT\_MECHANISM**\
  Allows the role to use redstone, levers, pressure plates, etc.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_mechanism*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_mechanism*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_mechanism*
* **INTERACT\_VILLAGER**\
  Allows the role to interact and trade with villagers.\
  \&#xNAN;*Toggle permission: lands.role.setting.interact\_villager*\
  \&#xNAN;*Bypass permission: lands.bypass.interact\_villager*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.interact\_villager*
* **BLOCK\_IGNITE**\
  Allows the role to ignite blocks / set blocks on fire.\
  \&#xNAN;*Toggle permission: lands.role.setting.block\_ignite*\
  \&#xNAN;*Bypass permission: lands.bypass.block\_ignite*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.block\_ignite*
* **ATTACK\_PLAYER**\
  Should the role be able to attack players? This flag may not always take effect, if combat-tag is enabled in the config.\
  \&#xNAN;*Toggle permission: lands.role.setting.attack\_player*\
  \&#xNAN;*Bypass permission: lands.bypass.attack\_player*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.attack\_player*\\
  * If disabled: The role won't be able to attack anyone.
  * If enabled: The role will be able to attack other players that are also allowed to attack this role in the given claim.
* **ATTACK\_ANIMAL**\
  Allows the role to attack animals.\
  \&#xNAN;*Toggle permission: lands.role.setting.attack\_animal*\
  \&#xNAN;*Bypass permission: lands.bypass.attack\_animal*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.attack\_animal*
* **FLY**\
  Allow the role to fly within an area. Fly will be disabled if the player is not allowed to fly at a given location. If they enter a area where they're allowed to fly, Lands will automatically re-enable their fly (if fly was active before).\
  This is compatible with every fly plugin.\
  \&#xNAN;*Toggle permission: lands.role.setting.fly*\
  \&#xNAN;*Bypass permission: lands.bypass.fly*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.fly*
* **ELYTRA**\
  Allow the role to use elytras within an area.\
  \&#xNAN;*Toggle permission: lands.role.setting.elytra*\
  \&#xNAN;*Bypass permission: lands.bypass.elytra*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.elytra*
* **WIND\_BURST**\
  Allow the role to use the wind burst enchantment with a mace attack or wind charge items.\
  \&#xNAN;*Toggle permission: lands.role.setting.wind\_burst*\
  \&#xNAN;*Bypass permission: lands.bypass.wind\_burst*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.wind\_burst*
* **LAND\_ENTER**\
  Allows the role to enter a area.\
  \&#xNAN;*Toggle permission: lands.role.setting.land\_enter*\
  \&#xNAN;*Bypass permission: lands.bypass.land\_enter*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.land\_enter*
* **SPAWN\_TELEPORT**\
  Allows the role to teleport to the land spawn.\
  \&#xNAN;*Toggle permission: lands.role.setting.spawn\_teleport*\
  \&#xNAN;*Bypass permission: lands.bypass.spawn\_teleport*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.spawn\_teleport*
* **VEHICLE\_USE**\
  Allows the role to use or place vehicles in the area.\
  \&#xNAN;*Toggle permission: lands.role.setting.vehicle\_use*\
  \&#xNAN;*Bypass permission: lands.bypass.vehicle\_use*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.vehicle\_use*
* **ITEM\_PICKUP**\
  Allows the role to pick up dropped items.\
  \&#xNAN;*Toggle permission: lands.role.setting.item\_pickup*\
  \&#xNAN;*Bypass permission: lands.bypass.item\_pickup*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.item\_pickup*
* **ENDER\_PEARL**\
  Allows the role to use ender pearls.\
  \&#xNAN;*Toggle permission: lands.role.setting.ender\_pearl*\
  \&#xNAN;*Bypass permission: lands.bypass.ender\_pearl*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.enter\_pearl*
* **SHEAR**\
  Allows the role to shear animals.\
  \&#xNAN;*Toggle permission: lands.role.setting.shear*\
  \&#xNAN;*Bypass permission: lands.bypass.shear*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.shear*
* **ATTACK\_MONSTER**\
  Allows the role to attack monsters. If disabled: Monsters also won't be able to damage the players of the role.\
  \&#xNAN;*Toggle permission: lands.role.setting.attack\_monster*\
  \&#xNAN;*Bypass permission: lands.bypass.attack\_monster*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.attack\_monster*
* **TRAMPLE\_FARMLAND**\
  Allows the role to trample farmland.\
  \&#xNAN;*Toggle permission: lands.role.setting.trample\_farmland*\
  \&#xNAN;*Bypass permission: lands.bypass.trample\_farmland*\
  \&#xNAN;*Wilderness bypass permission: lands.bypass.wilderness.trample\_farmland*
* **NO\_DAMAGE**\
  Players of the role won't get any damage from any damage cause. This flag is hidden by default.\
  \&#xNAN;*Toggle permission: lands.role.setting.no\_damage*\
  \&#xNAN;*Bypass permission: None*\
  \&#xNAN;*Wilderness bypass permission: None*

### Management Flags

Management flags will allow players to edit flags and options for the land. Each flag has their own toggle permission, which is required for players to be able to toggle the flag. The bypass permission allows server admins to execute these management operations for other lands.

* **PLAYER\_TRUST**\
  Allow the role to trust other players.\
  \&#xNAN;*Toggle permission: lands.role.setting.player\_trust*\
  \&#xNAN;*Bypass permission: lands.bypass.player\_trust*
* **PLAYER\_SETROLE**\
  Allow the role to set roles for trusted players. They can only edit players which have a lower role (priority) than their own.\
  \&#xNAN;*Toggle permission: lands.role.setting.player\_setrole*\
  \&#xNAN;*Bypass permission: lands.bypass.player\_setrole*
* **PLAYER\_UNTRUST**\
  Allow the role to untrust players. They can only untrust players which have a lower role (priority) than their own.\
  \&#xNAN;*Toggle permission: lands.role.setting.player\_untrust*\
  \&#xNAN;*Bypass permission: lands.bypass.player\_untrust*
* **PLAYER\_BAN**\
  Allow the role to ban players. They can only ban players which have a lower role (priority) than their own.\
  \&#xNAN;*Toggle permission: lands.role.setting.player\_ban*\
  \&#xNAN;*Bypass permission: lands.bypass.player\_ban*
* **SETTING\_EDIT\_LAND**\
  Allow the role to edit natural land flags (like mob spawning etc.)\
  \&#xNAN;*Toggle permission: lands.role.setting.setting\_edit\_land*\
  \&#xNAN;*Bypass permission: lands.bypass.setting\_edit\_land*
* **SETTING\_EDIT\_ROLE**\
  Allow the role to edit settings and flags of roles which have a lower priority than their own role.\
  \&#xNAN;*Toggle permission: lands.role.setting.setting\_edit\_role*\
  \&#xNAN;*Bypass permission: lands.bypass.setting\_edit\_role*
* **SETTING\_EDIT\_TAXES**\
  Allow the role to edit taxes of the area. Roles with that flag won't pay taxes. Note: It is recommended to give this permission only to trustworthy players in your land.\
  \&#xNAN;*Toggle permission: lands.role.setting.setting\_edit\_taxes*\
  \&#xNAN;*Bypass permission: lands.bypass.setting\_edit\_taxes*
* **SETTING\_EDIT\_VARIOUS**\
  Allow role to set a new name for the land and to change the title.\
  \&#xNAN;*Toggle permission: lands.role.setting.setting\_edit\_various*\
  \&#xNAN;*Bypass permission: lands.bypass.setting\_edit\_various*
* **LAND\_CLAIM**\
  Allow the role to claim chunks for the land.\
  \&#xNAN;*Toggle permission: lands.role.setting.land\_claim*\
  \&#xNAN;*Bypass permission: lands.bypass.land\_claim*
* **AREA\_ASSIGN**\
  Create sub areas and assign a selection to a sub area (`/lands selection assign <area>`).\
  \&#xNAN;*Toggle permission: lands.role.setting.area\_assign*\
  \&#xNAN;*Bypass permission: lands.bypass.area\_assign*
* **LAND\_CLAIM\_BORDER**\
  The players will be able to claim directly near your land, ignoring the chunk distance from config.\
  \&#xNAN;*Toggle permission: lands.role.setting.land\_claim\_border*\
  \&#xNAN;*Bypass permission: lands.bypass.land\_claim\_border*
* **SPAWN\_SET**\
  Allow the players of the role to change the spawn.\
  \&#xNAN;*Toggle permission: lands.role.setting.spawn\_set*\
  \&#xNAN;*Bypass permission: lands.bypass.spawn\_set*
* **BALANCE\_WITHDRAW**\
  Withdraw balance from the land bank (`/lands withdraw`).\
  \&#xNAN;*Toggle permission: lands.role.setting.balance\_withdraw*\
  \&#xNAN;*Bypass permission: lands.bypass.balance\_withdraw*
* **WAR\_MANAGE**\
  Declare war with your land or surrender in the war of the land.\
  \&#xNAN;*Toggle permission: lands.role.setting.war\_manage*\
  \&#xNAN;*Bypass permission: lands.bypass.war\_manage*

#### Bypass Role Priority

With the permission `lands.bypass.priority` a player can bypass role priorities. That means theat they can for example untrust players with higher roles, if they have the permission to untrust any player. If they don't have this bypass permission, they won't be able to edit players with a higher role priority.


---

# 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://wiki.incredibleplugins.com/lands/configuration/roles-and-their-flags.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.
