DUXPLIMA Documentation

Commands

Every /guard subcommand, with its arguments, what it does and the node it needs.

Contents: Root and words · For everyone · Drawing · Defining · Rules, roles and behaviours · Organising · Looking around · History and logs · Running the module

Root and words

The command is /guard, and /bolge in Turkish. Set commands.rg-alias = true in modules/guard/config.conf to also answer /rg; it is off by default so WorldGuard keeps /rg while both are installed. Like every uxmEssentials command it can be renamed, re-aliased or switched off in commands.conf under the id guard.

/guard alone opens the menu for staff with the menu node and for a region owner or manager standing in their region; anyone else gets the help list. /guard help lists the subcommands you have the node for. Every node below starts with uxmessentials.guard.; Permissions has the defaults.

<region> is a region name in the world you stand in, or world:name for another world. A command typed from the console needs the world: form.

For everyone

These nodes default to every player.

CommandWhat it doesNode
/guard menuOpens the region list (with the menu node), or, for a region owner or manager without it, the roles window of the region they stand inuse
/guard helpLists the subcommands you may runuse
/guard actions [prefix]Lists the action tree: the top level, or every action under a prefix such as useuse
/guard hereThe regions where you stand, highest first, and your role in eachhere
/guard why <action>Explains whether you may do the action where you stand: each region asked, the rule that decided, and where it came fromwhy
/guard member <region> <player> <member|guest|clear>An owner or manager hands out or takes back member and guest in their own region. Staff with role may do it anywheremember

Drawing

CommandWhat it doesNode
/guard wandGives the guard wand, a blaze rod. Left click: first corner. Right click: second corner. Sneak and right click: a polygon pointdefine
/guard pos1, /guard pos2Sets the first or second corner where you standdefine
/guard pointAdds a polygon point where you standdefine
/guard clearForgets your selectiondefine
/guard expand <amount> <direction>Grows the selection by blocks: up, down, north, south, east, west or alldefine
/guard expand vertStretches the selection to the full height of the worlddefine

With WorldEdit or FAWE installed, a selection made with their wand is used as well.

Defining

CommandWhat it doesNode
/guard define <name> [shape]Makes a region. Shapes: cuboid (the default, from your selection), polygon [minY] [maxY], cylinder <radius> [height], sphere <radius>, chunks [radius], global. See Shapesdefine
/guard redefine <region> [shape]Gives a region a new shape and keeps everything elsedefine
/guard remove <region>Removes a region. The menu asks first; the command does notremove
/guard restore <region>Brings back a removed region as it wasremove

Rules, roles and behaviours

CommandWhat it doesNode
/guard rule <region> <action> <target> <allow|deny|clear>Sets or clears one rule. Targets: everyone, nonmember, role:<name>, perm:<node>, cond:<condition>; a bare role name also works. See Rulesrule
/guard role <region> <player> <role|clear>Gives any role, owner and manager included, or takes it awayrole
/guard set <region> <behaviour> <value|clear>Sets or clears a behaviour. A value that does not fit the behaviour is refused with the reason. See Behavioursset
/guard template <region> <template|clear>Links the region to a template, or unlinks it. See Templatestemplate

Organising

CommandWhat it doesNode
/guard priority <region> <number>Sets the priority. Higher wins where regions overlappriority
/guard parent <region> <parent|clear>Makes the region inherit from another one in the same worldparent
/guard family <region> <name|clear>Puts the region in a family, so blocks may cross between it and its relatives. See Parents and familiesfamily
/guard tag <region> add <tag>, /guard tag <region> remove <tag>Adds or removes a tagtag
/guard tag bulk <tag> rule <action> <target> <allow|deny|clear>Sets one rule on every region with the tagtag
/guard tag bulk <tag> set <behaviour> <value|clear>Sets one behaviour on every region with the tagtag
/guard tag bulk <tag> template <template|clear>Links every region with the tag to a templatetag
/guard scope <region> <server|set:name>Chooses which servers load the region. See Networksscope
/guard lock <region>, /guard unlock <region>Locks or unlocks a region. See Locked regionslock

A bulk edit writes one history entry per region, so each region can be undone on its own.

Looking around

CommandWhat it doesNode
/guard info [region]Shape, scope, priority, parent, family, template, tags, lock, rules, behaviours and roles. Without a name, the top region where you standinfo
/guard list [world] [page]The regions of a world, highest priority firstlist
/guard near [radius]Regions within the radius around you, 32 blocks by default and at most 512near
/guard show [region]Draws borders for you alone: the named region, or every region near you plus your selectionshow
/guard hideTakes the borders away againshow
/guard test <player> <action> [region]Whether that player may do the action where you stand, or inside the named region, and whytest
/guard inspectInspect mode on or off. A click on a block explains what a player with no role may do there; your own refusals are explained as they happeninspect

History and logs

CommandWhat it doesNode
/guard history [region] [page]Recent changes, newest first: of one region, or of all of them. Each line has an idhistory
/guard undo <id>Undoes one change by its history id. The undo is recorded too, so it can be undoneundo
/guard log [player|region:<name>] [page]Refused actions, when the denial log is on (log.enabled)log

Running the module

CommandWhat it doesNode
/guard bypassRules stop applying to you until you run it again, except inside a locked region without the lock node. A reminder shows every bypass.reminder-secondsbypass
/guard statusRegions, chunk columns and region sets in memory, checks per second, and the cost per action familystatus
/guard import worldguard <dry-run|run|undo> [yaml|sql]Imports WorldGuard regions. See Importing WorldGuardimport
/guard backupsLists the region backups, newest first. See Backupsbackups
/guard backups restore <file>Puts every region of a backup back, after saving the present state as a new backupbackups
/guard reloadReads modules/guard/config.conf and the window files again, and reloads every region from the databasereload