DUXPLIMA Documentation

Menus

The eight guard windows, what every slot and click does, and how to restyle them.

Contents: Opening · Region list · Region · Rules · Roles · Behaviours · Templates · History · Regions inside · Restyling

Opening

/guard menu, or /guard alone. Staff with uxmessentials.guard.menu get the region list. A region owner or manager without it gets the roles window of the region they stand in, where they hand out member and guest. Every edit made in a window is the same edit as the command, with the same permission check, history entry and message, and the window redraws with the new value.

Bedrock players get every window as a native form, built from the same files.

All windows are six rows. The tiles sit in rows two to five inside a grey frame; the bottom row holds the previous page arrow (slot 48), back (49) and next page arrow (50).

Region list

The regions of the world you stand in, highest priority first.

SlotShowsLeft clickRight click
10 to 43A region, with its shape, priority, rule and role countsOpens the regionDraws its borders for you
48, 50Previous and next pageTurns the page

Region

One region. Each tile shows its current value in the lore.

SlotTileClick
20RulesOpens the rule editor
21RolesOpens the roles
22BehavioursOpens the behaviours
23TemplatesOpens the template picker
24HistoryOpens the history
29Regions insideOpens the regions inside this one
30BordersDraws the borders for you
31PriorityAsks for a number
32TagsLeft click asks for a tag to add, right click for a tag to remove
33LockLocks or unlocks the region (iron bars when locked)
40RemoveAsks to confirm, then removes the region
49BackThe region list

Rules

The actions at one level of the action tree, each showing its state for one target.

SlotShowsLeft clickRight click
10 to 43An action and its rule for the chosen target: unset, allow or denySteps unset, allow, deny, unsetOpens the actions under it
46The target the rules are forSteps through everyone, nonmember and the rolesAsks for a perm: or cond: target
49BackOne level up, or the region

Roles

Every player with a role in the region.

SlotShowsLeft clickRight click
10 to 43A player and their roleMoves them to the next roleTakes the role away
46Add a memberAsks for a name, and makes that player a member
49BackThe region (for an owner or manager, closes)

An owner or manager here can only hand out and take back member and guest.

Behaviours

Every behaviour guard knows, with its value in this region.

SlotShowsLeft clickRight click
10 to 43A behaviour and its valueAsks for a value in chat; a wrong value is refused with the reasonClears it
49BackThe region

Templates

The templates from modules/guard/config.conf.

SlotShowsLeft click
10 to 43A template, with how many rules and behaviours it has, marked when linkedLinks the region to it
46UnlinkRemoves the link
49BackThe region

History

The last changes to the region, newest first.

SlotShowsLeft click
10 to 43A change: its id, who made it, when, and what changedUndoes it; the undo is recorded too
49BackThe region

Regions inside

The regions whose parent is this one, as tiles like the region list: a left click opens one, a right click draws its borders. Back returns to the parent region.

Restyling

The windows are the files in plugins/uxmEssentials/modules/guard/gui/:

FileWindow
guard-regions.confRegion list
guard-region.confRegion
guard-rules.confRules
guard-roles.confRoles
guard-behaviours.confBehaviours
guard-templates.confTemplates
guard-history.confHistory
guard-children.confRegions inside

They use the menu engine: move slots, change materials, sounds and the frame, and /guard reload picks the change up. The words come from the language files (guard.gui.* keys), so a window reads in each player's language; change them in messages/.