Content generated with AI — it may contain mistakes.

Modules

Banned items

Rules that stop chosen items from being eaten, worn, thrown, placed and more, everywhere, in a whole world or in a region: the rule editor, item and place entries, whitelist rules, bypass permissions and the import from ExyliaSurvivalCore.

A banned-items rule says which items may not do which things, and where. Use it to forbid golden apples or pearls in a warzone, keep elytra and totems out of a duel arena, or allow only a short list of items inside a region. Rules are made in game and stored in the database; the check runs on every matching action, so a refusal is instant and the player is told why.

The module is on by default (modules.banned-items in config.yml; a restart applies a change). Rules are edited from /banneditemsadmin (alias /banitemsadmin, permission exyliawarzone.banneditems.admin) or the Banned items card of /warzoneadmin.

Making a rule

Create it

In /banneditemsadmin, click Create and type an id. The rule starts enabled and empty, and an empty rule bans nothing.

Items

Add the items the rule is about: hold one and add it, or type an entry (see below).

Actions

Pick what those items may not do. Each action is a toggle on the Actions screen.

Places

Pick where the rule holds: the regions you stand in, a region by name, or this whole world.

The rule screen also has Mode (blacklist or whitelist), Message (what the player reads when refused) and a switch to turn the rule off without deleting it. A rule with no actions or no places, or a blacklist with no items, does nothing.

Item entries

EntryMatches
GOLDEN_APPLEThat item.
DIAMOND_SWORD:1001That item with that custom model data.
#swordsEvery item in that item tag.
potion:strengthAny potion, splash or lingering potion or tipped arrow carrying that effect.
enchant:sharpness:5Anything carrying that enchantment at that level or higher, enchanted books included. The level may be left out.

An entry that names nothing is refused when you add it.

Actions

ActionStops
useRight-clicking with the item at all, from buckets to spawn eggs.
consumeEating or drinking it.
throwThrowing it: pearls, potions, snowballs, wind charges, tridents.
shootShooting with it, as the bow or as the arrow.
attackHitting anything with it in hand.
mineBreaking blocks with it in hand.
placePlacing it: blocks, buckets, boats, frames, armour stands, end crystals.
breakBreaking a block of it.
wearWearing it. Someone who walks in wearing it has it taken off.
glideGliding with it. Someone who walks in wearing it lands.
totemA totem saving its holder from death.
dropDropping it.
pickupPicking it up.
craftCrafting it.

Places

EntryCovers
*Everywhere on the server.
world:*The whole world world.
world:spawnThe region spawn of world.
spawnA region with that id in any world.

Regions are WorldGuard regions. Entries cannot contain spaces.

Whitelist rules

Mode turns a rule around. As a blacklist, the listed items cannot do the chosen actions inside its places. As a whitelist, only the listed items may do them there and every other item is refused. A whitelist with no items refuses every item.

Messages and bypass

A refused player reads the rule's Message, or, when it is empty, the default line for that action from modules/banned-items/messages.yml. The line is shown at most once every 1.5 seconds, however many clicks.

PermissionDefaultEffect
exyliawarzone.banneditems.adminoperators/banneditemsadmin and the rule editor. Included in exyliawarzone.admin.
exyliawarzone.banneditems.bypassnobodyNever stopped by any rule.
exyliawarzone.banneditems.bypass.<rule id>nobodyLet off that one rule.
Operators meet the rules

Neither bypass is given to operators, so you can test a rule with your own account. Grant a node on purpose to staff who should be exempt.

Rule creation and deletion are written to the staff log (/exylialib logs). Each server only loads and lists the rules it created, so servers sharing a database keep their own.

Coming from ExyliaSurvivalCore

The first time the module starts, it reads plugins/ExyliaSurvivalCore/modules/blocked-items/rules.yml if it exists. Each old rule becomes a rule here with the same name (a suffix is added when the name is taken), use: true becomes every action a held item does (use, consume, throw, shoot, attack, mine, place, wear, glide and totem), craft: true becomes craft, whole worlds become world:* and global: true becomes *. The old file is renamed to rules.yml.imported, so the next start leaves it alone. See Moving from ExyliaSurvivalCore.

Something missing on this page? Tell us on Discord