Dungeon Restrictions

Dungeon Restrictions

ManifesteFourni par Dungeon

What the members of a run may not do. A 'Dungeon Instance' names one (Restrictions field) for the whole dungeon and a 'Dungeon Room' may name another: while a player stands in such a room, the room's restrictions REPLACE the dungeon's (they do not add to them), so a room with nothing ticked lifts every restriction of the dungeon inside it. Creating the entry means wanting to restrict: every blocking switch starts ticked ('Limit interactions' and the game mode are extras, off until chosen). Only the members of a run that is playing, inside the world of their run, are concerned. Every other player, and every dungeon that names no restrictions, behaves as before.

Champs

Champ	Type	Par défaut	Description
blockElytra	Boolean	true	Players cannot start gliding with an elytra. A player already gliding when they enter the dungeon or a room that blocks it stops gliding.
blockVehiclePlace	Boolean	true	Players cannot place a boat or a minecart.
blockVehicleEnter	Boolean	true	Players cannot get into a boat, a minecart or any other vehicle.
blockEnderPearl	Boolean	true	Players cannot throw an ender pearl, and an ender pearl thrown earlier does not teleport them.
blockChorusFruit	Boolean	true	Players cannot eat a chorus fruit: the right click does nothing, so the fruit is not bitten, not used up and does not teleport.
blockRiptide	Boolean	true	Players cannot launch themselves with a riptide trident: the right click that starts the charge does nothing. A trident thrown the ordinary way is not touched. Paper 1.21.11 or later also stops a launch that gets past the click; on an older server the click alone is refused, with a warning in the log.
blockedCommands	List<String>	empty	Commands players cannot run, written without the slash, one per line (for example 'home'). Case and a 'plugin:' prefix do not matter, and only the first word counts, so list each alias ('tp', 'teleport'). Empty = every command is allowed.
deniedMessage	Var<String>	—	Message sent to a player when something is refused. Empty = nothing is said. Takes placeholders and colors.PlaceholdersCouleurs
messageRepeatDelay	Duration	2000	How long the message above is not repeated for the same player and the same kind of refusal (milliseconds; 2 seconds by default). A held right click comes back every few ticks, and the click, the eating and the teleport of one attempt are one refusal; a new attempt after this delay speaks again. 0 = the message is said at every refusal.
bypassPermission	String	—	Permission that lets a player ignore all of these restrictions. Empty = nobody is exempt.
gameMode	Optional<GameMode>	—	Game mode the players are put in when they enter the dungeon; their own mode comes back when they leave it (end of the run, departure, expired reconnection delay, dungeon world left, closed run). Only the 'Dungeon Restrictions' of the dungeon instance counts: the one of a room is not used for this. Players holding the bypass permission keep their own mode. Empty = game modes are left alone. CREATIVE and SPECTATOR switch the combat statistics off: a player in one of those modes is not counted (no mob kills, no damage dealt or taken), so every member of the dungeon stops counting; use SURVIVAL or ADVENTURE to keep them.
limitInteractions	Boolean	false	Limits what the players may do to blocks and decorative entities. Ticked: a right click on a block is refused unless the block is in 'Allowed interactions', and the entities of 'Protected entities' cannot be used, hit (by the player or by what they shoot) or broken. Also refused, wherever it is aimed: placing a block, a bucket (emptying or filling), a boat, a minecart, an armor stand, an item frame or a painting, using a spawn egg, flint and steel, a fire charge or bone meal, using an axe, a hoe or a shovel on a block, and an arrow or a trident pressing a button or a plate. The loot chests of the dungeon and its NPCs are never affected, and players holding the bypass permission are not limited. Unticked (the default): nothing is limited, as before.
allowedInteractions	List<Material>	—	Blocks that can still be right-clicked while 'Limit interactions' is ticked (a chest, a barrel...). Every other block ignores the click: doors, buttons, levers, crafting tables, anvils, and placing a block against it (even by sneaking against an allowed chest).
protectedEntities	List<EntityType>	—	Entities protected while 'Limit interactions' is ticked: right-clicking, hitting or breaking them is refused (item frames keep their item, armor stands keep their equipment).

How to use it

Create the entry, then name it in restrictions of a Dungeon Instance (the whole dungeon) and, if needed, of a Dungeon Room. The room REPLACES the instance while the player stands in it, so a room whose entry has nothing ticked lifts the restrictions of the dungeon there. With no link, nothing is restricted. The blocking switches start ticked: you create the entry because you want to restrict. limitInteractions and gameMode are extras, off until you choose them.

Field	What to know
blockElytra	Gliding cannot start. A player already gliding when the run starts, or when they enter a room that blocks it, is brought down.
blockVehiclePlace	A boat or a minecart cannot be placed.
blockVehicleEnter	No vehicle (boat, minecart...) can be entered.
blockEnderPearl	A pearl cannot be thrown, and one already in flight does not teleport.
blockChorusFruit	The right click does nothing: the fruit is not bitten, not used up and does not teleport.
blockRiptide	The right click that starts the riptide charge does nothing; a trident thrown the ordinary way is not touched. On Paper 1.21.11 or later a launch that gets past the click is stopped too; on an older server only the click is refused and one warning is logged.
blockedCommands	Commands without the slash, one per line. Case and a plugin: prefix do not matter and only the first word counts, so list every alias.
deniedMessage	Sent to the player when something is refused. Placeholders and colours are accepted. Empty = silent.
messageRepeatDelay	How long the message is not repeated for the same player and the same kind of refusal. Default 2 seconds. A held right click and the click, eating and teleport of one attempt count as one refusal. 0 says the message at every refusal.
bypassPermission	A player who has this permission is not restricted. Empty = nobody is exempt. Holding it is the only exemption: no other status (creative mode, for example) exempts a player.
gameMode	Optional (for example ADVENTURE). The players are put in this mode when they enter the dungeon, and their own mode comes back when they leave it (end of the run, departure, expired reconnection delay, dungeon world left, closed run). Only the entry of the dungeon instance counts: the one of a room is not used. Players with the bypass permission keep their own mode. Empty = game modes are left alone. CREATIVE and SPECTATOR switch the combat statistics off for every member, so use SURVIVAL or ADVENTURE to keep them.
limitInteractions	Off by default. On: a right click on a block is refused unless the block is in allowedInteractions, and the entities of protectedEntities cannot be used, hit (by the player or by what they shoot) or broken. Also refused wherever it is aimed: placing a block (even sneaking against an allowed chest), a bucket, a boat, a minecart, an armor stand, an item frame or a painting, a spawn egg, flint and steel, a fire charge, bone meal, an axe, a hoe or a shovel on a block, and an arrow or trident pressing a button or a plate. The loot chests of the dungeon and its NPCs are never affected.
allowedInteractions	Blocks that can still be right-clicked while limitInteractions is on. Default CHEST, TRAPPED_CHEST and BARREL. Doors, buttons, levers, crafting tables and anvils ignore the click.
protectedEntities	Entities protected while limitInteractions is on. Default ITEM_FRAME, GLOW_ITEM_FRAME, ARMOR_STAND and PAINTING: they keep their item or equipment.

Operators and the bypass permission

bypassPermission is checked like any permission: an operator has every node that is not explicitly set to false, so an op is exempt by default as soon as a permission is named. To restrict an op during tests, set that node to false for them in your permissions plugin.

Only the members of a run that is playing, inside the world of their run, are concerned. In a SHARED_WORLD_SLOTS world that means inside their own slot, which is an approximation of its area.