WorldGuard Commands: Difference between revisions
(creation) |
m (→Claim) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Server internals]] | |||
{{notice|The base command is <code>/region</code>, but you can also use <code>/rg</code> as a shortcut.}} | |||
== Commands == | |||
=== Define === | |||
* <code>/region define <id> [<owner1> [<owner2> [<owners...>]]]</code> | |||
* <code>/region def <id> [<owner1> [<owner2> [<owners...>]]]</code> | |||
* <code>/region d <id> [<owner1> [<owner2> [<owners...>]]]</code> | |||
This is the primary region definition command. It allows you to create a new protected region with the given ID and the given owners. You can specify groups by prefixing group names with <code>g:</code>. Special region creation restrictions are | |||
'''not checked''' with this command (for that, use the claim command), and so this command is ''aimed for administrators'. The area of the region will be taken as your current WorldEdit region selection. | |||
=== Redefine === | |||
* <code>/region redefine <id></code> | |||
* <code>/region update <id></code> | |||
* <code>/region move <id></code> | |||
This command allows you to change the area for a defined protected region. The area of the region will be taken as your current WorldEdit region selection. You cannot limit, with permissions, the new land area size. | |||
=== Claim === | |||
* <code>/region claim <id> [<owner1> [<owner2> [<owners...>]]]</code> | |||
This command is similar to "define" except that it also does extra checks: | |||
# If enabled in the configuration, the player must not have more regions than the maximum region limit. | |||
# The new region cannot replace an existing region of the same name unless the player also owns that. | |||
# The new region may not overlap with another region that the player must own. | |||
# If enabled in the configuration, the region must overlap an existing region that the player owns. | |||
# If enabled in the configuration, the volume of the region must not exceeded the maximum region limit specified. | |||
=== Information === | |||
* <code>/region info [<world>] <id></code> | |||
Lists information for a given region. The information shown is: | |||
* Shape | |||
* Priority | |||
* Flag values | |||
* Parent | |||
* Owners | |||
* Members | |||
* Bounding box | |||
=== List === | |||
* <code>/region list [<page> [<world>]]</code> | |||
Displays the list of regions. A page number can be provided to scroll through the list, and a world can also be specified to list the regions of a world. | |||
Alternatively the list of regions can be filtered by user by using the prefix <code>.</code> to specify the <code>.<user></code> as the first argument . Regions the user is an owner of are listed first, prefixed with a (+) symbol. The permission worldguard.region.list.own can be set to allow users to only list their own regions using <code>.me</code> or <code>.</code>. | |||
=== Set flag === | |||
* <code>/region flag <id> <flag> [<value>]</code> | |||
Sets a [[WorldGuard Flags|flag]] for a region. If a value is not given, then the flag is ''cleared'' to its default unset set. See the [[WorldGuard Flags|flag list]] to see which flags you can set. It is important you understand how region priorities and parent-child relationships work out when setting flags. | |||
=== Set priority === | |||
* <code>/region setpriority <id> <priority></code> | |||
* <code>/region priority <id> <priority></code> | |||
* <code>/region pri <id> <priority></code> | |||
Sets the priority of a region. The priority is a numeric integer that can be negative as well as positive. | |||
=== Set parent === | |||
* <code>/region setparent <child> <parent></code> | |||
* <code>/region parent <child> <parent></code> | |||
* <code>/region par <child> <parent></code> | |||
Sets the parent of a region. You must specify the name of an existing region. | |||
=== Remove === | |||
* <code>/region remove <id> <priority></code> | |||
* <code>/region rem <id> <priority></code> | |||
* <code>/region delete <id> <priority></code> | |||
* <code>/region del <id> <priority></code> | |||
Removes a region. | |||
Latest revision as of 15:23, 22 May 2025
ℹ️ Notice: The base command is /region, but you can also use /rg as a shortcut.
Commands
Define
/region define <id> [<owner1> [<owner2> [<owners...>]]]/region def <id> [<owner1> [<owner2> [<owners...>]]]/region d <id> [<owner1> [<owner2> [<owners...>]]]
This is the primary region definition command. It allows you to create a new protected region with the given ID and the given owners. You can specify groups by prefixing group names with g:. Special region creation restrictions are
not checked with this command (for that, use the claim command), and so this command is aimed for administrators'. The area of the region will be taken as your current WorldEdit region selection.
Redefine
/region redefine <id>/region update <id>/region move <id>
This command allows you to change the area for a defined protected region. The area of the region will be taken as your current WorldEdit region selection. You cannot limit, with permissions, the new land area size.
Claim
/region claim <id> [<owner1> [<owner2> [<owners...>]]]
This command is similar to "define" except that it also does extra checks:
- If enabled in the configuration, the player must not have more regions than the maximum region limit.
- The new region cannot replace an existing region of the same name unless the player also owns that.
- The new region may not overlap with another region that the player must own.
- If enabled in the configuration, the region must overlap an existing region that the player owns.
- If enabled in the configuration, the volume of the region must not exceeded the maximum region limit specified.
Information
/region info [<world>] <id>
Lists information for a given region. The information shown is:
- Shape
- Priority
- Flag values
- Parent
- Owners
- Members
- Bounding box
List
/region list [<page> [<world>]]
Displays the list of regions. A page number can be provided to scroll through the list, and a world can also be specified to list the regions of a world.
Alternatively the list of regions can be filtered by user by using the prefix . to specify the .<user> as the first argument . Regions the user is an owner of are listed first, prefixed with a (+) symbol. The permission worldguard.region.list.own can be set to allow users to only list their own regions using .me or ..
Set flag
/region flag <id> <flag> [<value>]
Sets a flag for a region. If a value is not given, then the flag is cleared to its default unset set. See the flag list to see which flags you can set. It is important you understand how region priorities and parent-child relationships work out when setting flags.
Set priority
/region setpriority <id> <priority>/region priority <id> <priority>/region pri <id> <priority>
Sets the priority of a region. The priority is a numeric integer that can be negative as well as positive.
Set parent
/region setparent <child> <parent>/region parent <child> <parent>/region par <child> <parent>
Sets the parent of a region. You must specify the name of an existing region.
Remove
/region remove <id> <priority>/region rem <id> <priority>/region delete <id> <priority>/region del <id> <priority>
Removes a region.