Flags

Flags are specific permissions applied to global players, members, and nature.

There are 35+ flags for players and 20+ flags for the environment.

To set default flag values, use true for Allow, and false for Deny.

default-players-flags:
  break-blocks: false
  place-blocks: false
  containers: false
  ...
  
default-world-flags:
  passive-entities-spawn: true
  hostile-entities-spawn: true
  entities-grief: false
  ...

How they work

Flags are represented as integer values using bitwise shifts (like 1 << 1, 1 << 2... etc) are a way of using bitmasks to store multiple boolean options within a single 64-bit integer. This is efficient for storage and fast for checking permissions.

Each flag is assigned a unique bit position using bitwise shifting (1 << n), which moves the bit 1 to the left by n places.

For example:

public class PlayerFlags {
    public static final long BREAK_BLOCKS = 1L; // 1
    public static final long PLACE_BLOCKS = 1L << 1; // 2
    public static final long CONTAINERS = 1L << 2; // 4
    public static final long DOORS = 1L << 3; // 8
    public static final long TRAP_DOORS = 1L << 4; // 16
    ...
}

Table of Flags

Player Flags

Player Flags are flags applied to global players and members.

When adding a member to a region, they will have the same flags as global players' flags, but you can change a specific flag state for a specific member.

Flag	Default	Explanation
break-blocks	Deny	Allow players to break blocks?
place-blocks	Deny	Allow players to place blocks?
containers	Deny	Allow players to open containers?
doors	Deny	Allow players to open doors?
trap-doors	Deny	Allow players to open trap doors?
fence-gates	Deny	Allow players to open fence gates?
use-anvil	Deny	Allow players to use anvils?
redstone	Deny	Allow players to use redstone?
levers	Deny	Allow players to use levers?
buttons	Deny	Allow players to use buttons?
pressure-plates	Deny	Allow players to use pressure plates?
use-bells	Deny	Allow players to use bells?
trigger-tripwire	Deny	Allow players to trigger tripwires?
frost-walker	Deny	Allow players to use frost walker enchanted boots?
harvest-crops	Deny	Allow players to harvest (break) crops?
block-trampling	Deny	Allow players to trample Farmland and Turtle Eggs?
general-interaction	Deny	Allow players to interact (in general)?
armor-stands	Deny	Allow players to take off armor from armor stands?
interact-entities	Deny	Allow players to interact with entities?
item-frame-rotation	Deny	Allow players to rotate items from item frames?
damage-passive-entities	Deny	Allow players to kill passive (Cow, Sheep...) entities?
damage-hostile-entities	Deny	Allow players to kill hostile (Zombie, Skeleton...) entities?
trade-villagers	Deny	Allow players to trade with Villagers?
ignite	Deny	Allow players to ignite fire?
vehicles	Deny	Allow players to ride vehicles (Minecarts, Horses...)?
teleport-spawn	Deny	Allow players to teleport to region's spawn?
passthrough	Allow	Allow players to go inside the region?
pvp	Deny	Allow players to fight each other?
no-fall-damage	Deny	Disallow players to take fall damage?
teleport	Deny	Allow players to teleport with Ender Pearl or Chorus Fruit?
throw-potions	Deny	Allow players to throw potions?
pickup-items	Allow	Allow players to pick items?
sleep	Deny	Allow players to sleep within the region?
trigger-raid	Deny	Allow players to trigger raid?
elytra	Deny	Allow players to fly with an Elytra?

World Flags

World Flags are flags applied to the environment of the server for a region.

Flag	Default	Explanation
passive-entities-spawn	Allow	Allow passive entities to spawn?
hostile-entities-spawn	Allow	Allow hostile entities to spawn?
entities-grief	Deny	Allow entities (except Creeper) to grief?
entities-damage-entities	Deny	Allow entities to kill each other?
leaves-decay	Allow	Allow leaves to decay?
fire-spread	Deny	Allow fire to spread within the region?
liquid-flow	Deny	Allow any liquid to flow into the region?
explosions-damage	Deny	Allow explosions (except Wither) to damage the region?
wither-damage	Deny	Allow wither to damage the region?
wilderness-pistons	Deny	Allow wilderness pistons to push/pull blocks to your region?
wilderness-dispensers	Deny	Allow wilderness dispensers to dispense inside your region?
wilderness-minecarts	Deny	Allow wilderness minecarts to enter your region?
plant-growth	Allow	Allow plants to grow inside the region?
grass-growth	Allow	Allow grass to spread inside the region?
sculk-spread	Allow	Allow sculk to spread inside the region?
player-glowing	Allow	Give the glowing effect to players?
snow-melting	Allow	Allow snow to melt?
ice-melting	Allow	Allow ice to melt?
snowman-trails	Allow	Allow Snow Golem to leave snow trails?
windcharge-burst	Deny	Allow Windcharges to burst inside the region?

Removed Flags

Not important, but these flags were replaced or concatenated with another flag.

These flags existed in the early days of the plugin (May 2024).

Flag	Replaced With	Explanation
signs	break-blocks	Allow players to edit signs?
throw-ender-pearls	teleport	Allow players to throw Ender Pearls?
enter-land	passthrough	Allow players to go inside the region?