Got a question that the wiki doesn't answer? Ask on the forum (preferred), or join us on IRC.
WorldGuard
Regions
Flags
Contents
Flag List
Flag | Description | Default | Type |
---|---|---|---|
passthrough | Use allow to have this region treated as a region that doesn't check build permission (use this to make simple no-PVP, etc. zones). | N/A | State |
build | DON'T TOUCH THIS FLAG. Everything will work normally without changing this flag. This flag overrides all region build checks, either to blanket allow or blanket deny. Deny always takes precedence over allow. If you simply want to protect a region, you don't have to touch this flag. Just define the region, and addowner a player to the region, and everyone else is denied. | N/A | State |
construct | Allow or block placing/breaking blocks. | Members | Group |
pvp | Allow or block PvP. | Allowed | State |
mob-damage | Allow or block mob damage on players. | Allowed | State |
mob-spawning | Allow or deny mobs spawning | Allowed | State |
creeper-explosion | Allow or block creeper damage to terrain and players. | Allowed | State |
enderman-grief | Allow or prevent endermen from picking up or placing blocks. | Allowed | State |
enderdragon-block-damage | Allow or prevent enderdragon damage to blocks. | Allowed | State |
ghast-fireball | Allow or block fireballs damage to terrain and players. | Allowed | State |
sleep | Allow or block players from entering beds. | Allowed | State |
tnt | Allow or block TNT. | Allowed | State |
lighter | Allow or block flint and steel. | Allowed | State |
fire-spread | Allow or block the spread of fire (requires high frequency flags to be on in configuration) | Allowed | State |
lava-fire | Allow or block whether lava can start fires (requires high frequency flags to be on in configuration) | Allowed | State |
lightning | Allow or block lightning striking at all in a region | Allowed | State |
chest-access | Allow or block chest access | Deny | State |
pistons | Allow or block piston activation | Allowed | State |
water-flow | Allow or block flow of water. (requires high frequency flags to be on in configuration) | Allowed | State |
lava-flow | Allow or block flow of lava. (requires high frequency flags to be on in configuration) | Allowed | State |
use | Allow or block the ability to use doors, buttons, pressure plates, levers, etc | Allowed | State |
vehicle-place | Allow or block the ability to place vehicles | Denied | State |
vehicle-destroy | Allow or block the ability to remove vehicles | Denied | State |
snow-fall | Allow or block snow from forming in an area. Note that this will not block weather altogether, that can be done in the config. | Allowed | State |
snow-melt | Allow or block snow from melting in an area. | Allowed | State |
ice-form | Allow or block ice from forming in an area. | Allowed | State |
ice-melt | Allow or block ice from melting in an area. | Allowed | State |
leaf-decay | Allow or block leaves from decaying. | Allowed | State |
grass-growth | Allow or block grass from spreading to dirt. | Allowed | State |
invincible | Sets a temporary godmode on the player. This will also disable /god-mode if set to deny, unless the player has the worldguard.god.override-regions permission. | None | State |
entry | Allow or deny a group of players to enter an area
Example: /rg flag regionname entry deny --- /rg addmember regionname g:groupname <--- These two commands should deny entry to groups not added as members or owners. Keep in mind that if you use any inheritance system in your permissions (for example: builder inherits default permissions), any groups that inherit the same permissions as the allowed group will also be allowed entrance to the region. Your best bet is to eliminate the inheritances and give each group their own group.groupname permission. This allows worldguard to see separate groups. |
Allowed | State |
entry -g | Although this command isn't really necessary: (Note the entry flag above and with this command the space before -g) Set the group to be considered when checking if a player is allowed entry. | Non-members | Group |
exit | Allow or deny a group of players to leave an area | Allowed | State |
exit-group | Set the group to be considered when checking if a player is allowed to leave. | Non-members | Group |
greeting | Message to show a player when they enter a region | unset | String |
farewell | Message to show a player when they leave a region | unset | String |
notify-enter | Sends a message to players with the worldguard.notify permission when a player enters a region. | False | Boolean |
notify-leave | Sends a message to players with the worldguard.notify permission when a player leaves a region. | False | Boolean |
deny-spawn | Set mobs that can't spawn within the region. From console or ingame: /region flag [id] denyspawn Skeleton,Zombie,Creeper,etc . In config file: deny-spawn: [SKELETON, CREEPER, ZOMBIE, ETC] | unset | List |
heal-delay | Set the rate of healing in the region | unset | Integer |
heal-amount | Set the amount per heal time (see heal-delay) | unset | Integer |
heal-min-health | Minimum health the heal flags will drop a player to. | unset | Integer |
heal-max-health | Maximum health the heal flags will raise a player to. | unset | Integer |
feed-delay | Set the rate of food regeneration | unset | Integer |
feed-amount | Set the amount per hunger regen time (see feed-delay) | unset | Integer |
feed-min-hunger | Minimum hunger the feed flags will drop a player to. | unset | Integer |
feed-max-hunger | Maximum hunger the feed flags will raise a player to. | unset | Integer |
teleport | Defines the location /region teleport <id> teleports you to. | unset | Location |
spawn | Define the spawn of the region, use /region flag region x y z | unset | Location |
buyable | NOT YET IMPLEMENTED | False | Boolean |
price | NOT YET IMPLEMENTED | unset | Double |
blocked-cmds | Sets the commands that will be blocked inside the region | unset | List |
allowed-cmds | Sets the commands allowed in the region. If this is set (not empty) it will act like a whitelist and ONLY commands from this list will be allowed. | unset | List |
send-chat | Sets whether or not a player can send chat inside the region | unset | Boolean |
receive-chat | Sets whether or not a player can receive chat inside the region. | unset | Boolean |
potion-splash | Allow or block splash effect from potion | Allowed | State |
Types
State
This type of flag has three states: allow, none, and deny. allow
will allow the event to happen in the region, deny
will disallow the event to happen, and none
will use the default behavior as if there was no region.
Note that the build flag is unique. If set to none
(which it is by default) only members of the region can build.
String
This can be set to any arbitrary text. Note that if it is unset, it will usually disable the flag.
List
This flag can be set to a list of strings. Input values should be comma separated.
Integer
This flag can be any number, negative or positive, that does not have a fraction or decimal portion.
Double
This flag is like an integer, but accepts decimals.
Boolean
This flag can be either true or false. It differs from state flags in that it does not have a default position (none) to fall to.
Location
This flag represents a location. It consists of an x, y, and z coordinate.
Group
This does NOT refer to a permission group. It refers to region members/owners.
This flag can be set to any of the following: members
, nonmembers
, owners
, nonowners
, or everyone
.
If editing regions.yml directly, the values are: MEMBERS
, NON_MEMBERS
, OWNERS
, NON_OWNERS
, or ALL
.
Example:
/rg flag <region_ID> entry deny
/rg flag <region_ID> entry -g nonmembers
/rg flag <region_ID> exit deny
/rg flag <region_ID> exit -g nonowners
/rg addmember <region_ID> g:member
/rg addowner <region_ID> g:VIP
This would make it so that the permission groups VIP (region owner) and Member (region member) would be allowed to enter the region, but only the VIP group would be allowed to exit. All other permission groups would be denied entry.
It is also important to note:
If entry
, exit
, or construct
are set to allow
, it will allow ALL.