DUXPLIMA Documentation

Behaviours

Every behaviour a region can set, its values, and what it does to the players inside.

Contents: Setting one · Messages · Actions on the way in and out · Player state · Comfort · Lists · Elsewhere

Setting one

/guard set <region> <behaviour> <value>
/guard set <region> <behaviour> clear

Each behaviour takes one kind of value, and a value that does not fit is refused when you type it, with the reason. Where regions overlap, the first region in precedence order that sets a behaviour decides it. Behaviours are applied when a player enters and taken back when they leave, quit, or the server stops: guard remembers what it changed (flight, speed, game mode, god mode, effects, time, weather) and restores exactly that.

Value words: a yes/no behaviour takes true or false (also on, off, yes, no, evet, hayir, acik, kapali). A three-way behaviour takes allow, deny or keep (also izin, yasak, koru); keep leaves the player's own setting alone. A list is comma separated.

Messages

BehaviourValueWhat it does
message.entertextShown on the way in. MiniMessage, {player} for the player's name, and PlaceholderAPI placeholders when it is installed
message.exittextShown on the way out, the same way
message.channelchat, title, actionbar, bossbarWhere the two messages go. chat by default. For title, write `title
enter.deny-messagetextReplaces the refusal shown when move.enter or move.teleport-in turns a player away
exit.deny-messagetextReplaces the refusal when move.exit holds a player in
enter.push-backyes/notrue by default: a refused player is put back where they last stood outside. false only stops them
deny-messagesyes/nofalse keeps every refusal in this region silent: no action bar, no chat line

Actions on the way in and out

BehaviourValueWhat it does
actions.enteractionsRun once when a player comes in
actions.exitactionsRun once when they leave
actions.intervalactionsRun again and again while they stay
actions.interval-secondsa whole numberHow often actions.interval runs

Actions are the click actions NPCs and holograms run, written type: value and separated by |:

/guard set arena actions.enter title: <red>Arena|<gray>no teleporting out | sound: ENTITY_WITHER_SPAWN:0.6:1
/guard set mine actions.interval chance: 5 | give: diamond
TypeValue
messageA chat line
actionbarAn action bar line
title`title
soundSOUND_KEY[:volume[:pitch]]
playerA command the player runs
player_opA command the player runs with operator rights for that one command
consoleA command the console runs
connectA server name on your proxy to send the player to
delayTicks to wait before the rest
randomn: run one of the next n actions, picked at random
chanceA percent; on a miss the rest is skipped
permissionA node; without it the rest is skipped
condition<left> <op> <right> with placeholders; when false the rest is skipped
costAn amount taken from the player's balance; if they cannot pay the rest is skipped
givematerial[:amount]

Player state

BehaviourValueWhat it does
flyallow/deny/keepallow lets players fly inside, deny takes flight away (creative and spectator are left alone). /fly refuses to turn on in a deny region
glideallow/deny/keepdeny stops elytra gliding
godallow/deny/keepuxmEssentials god mode inside: deny switches it off in an arena, allow switches it on. /god refuses to turn on in a deny region. On the way out the player gets back the god mode they have in uxmEssentials at that moment
game-modesurvival, creative, adventure, spectatorSets the game mode inside. A player with uxmessentials.guard.bypass.gamemode keeps their own
walk-speed0 to 1Walking speed; 0.2 is normal
fly-speed0 to 1Flying speed; 0.1 is normal
effects.givelist of effect[:level]Effects that last while inside, such as speed:2, night_vision
effects.blocklist of effectsEffects removed on the way in and refused while inside, such as speed, levitation
timea tick from 0 to 23999, or day, noon, night, midnightThe time of day the player sees
weatherclear or rainThe weather the player sees
void-teleport<y> spawn or <y> <world> <x> <y> <z>Below that height the player is sent to the world spawn or the given place, and takes no fall damage from it

A player with bypass on is not grounded by fly = deny and may glide where glide = deny. game-mode has its own exemption, the uxmessentials.guard.bypass.gamemode node, which nobody has by default.

Comfort

BehaviourValueWhat it does
invincibleyes/notrue: players take no damage at all inside
fall-damageyes/nofalse: no fall damage
firework-damageyes/nofalse: fireworks hurt nobody here, players or mobs
hungeryes/nofalse: food does not go down
heal<amount> <seconds>Gives that much health (2 is one heart) every so many seconds
feed<amount> <seconds>Gives that much food every so many seconds
keep-inventoryyes/notrue: a player who dies here keeps their items
keep-expyes/notrue: a player who dies here keeps their levels
exp-dropsyes/nofalse: broken blocks and killed mobs drop no experience here

Lists

These are checked on top of the rules, for finer control than an action gives.

BehaviourValueWhat it does
blocks.break.denylist of blocksThese may not be broken, even where break is allowed
blocks.break.allowlist of blocksThese may be broken, even where break is denied
blocks.place.denylist of blocksThese may not be placed, even where place is allowed
blocks.place.allowlist of blocksThese may be placed, even where place is denied
items.use.denylist of itemsThese may not be used here
spawn.denylist of type[:reason]Mobs that may not spawn: a mob type (zombie), monster, animal (anything that is not a monster) or * for all; :reason narrows it to a spawn reason such as natural or spawner
commands.denylist of commandsCommands refused here. An entry catches every name of the command (home also stops /h and /uxmessentials:home) and any other plugin's command of that name. Write arguments with _: warp_vip stops /warp vip but not /warp shop
commands.allowlist of commandsWhen set, only these commands run here. An entry matches the named command of the plugin that owns that name, with any of its aliases

deny entries win over allow entries. /guard itself always runs, so staff are never locked out of fixing a region. Players with bypass on are not stopped by the command lists.

Elsewhere

  • God mode and flight from uxmEssentials commands respect god and fly, see above.
  • Player Warps, Homes and every teleport obey move.enter and move.teleport-in, since guard checks the teleport itself.