DUXPLIMA Documentation

Role permissions

All 48 role permissions, what each one gates, and which the built-in roles hold.

A role permission decides what one player may do inside one claim. The owner grants it to a role with /claim role setperm <role> <permission> <true|false>, or overrides it for one member with /claim member setperm <player> <permission> <true|false>. Changing either also needs the ability node uxmclaims.ability.role.permissions.<permission> or uxmclaims.ability.member.permissions.<permission>, in lower case.

The Member column is whether the built-in Member role holds the permission in the shipped roles.yml. Owner holds everything implicitly. Default, the role of everyone who is not a member, holds MOVE_INSIDE and nothing else. A custom role starts with nothing.

Management

Nine permissions let a member run part of the claim. Changing flags, roles, member roles and overrides, transferring and deleting stay with the owner whatever a role holds.

PermissionGrantsMember
MANAGE_CHUNKSAdd and remove chunksno
MANAGE_TIMEExtend the claim's timeno
MANAGE_BANSBan, unban and kick playersno
MANAGE_INVITESSend and revoke invitesno
MANAGE_VAULTOpen the shared vault at allno
MANAGE_BLOCKPlace, change and destroy the claim blockno
MANAGE_RENAMERename the claimno
MANAGE_RELOCATEMove the claim spawn with /claim setspawnno
MANAGE_WARPSCreate, move, rename and delete warps, and make them public or privateno

Build and blocks

PermissionGrantsMember
BLOCK_PLACEPlace blocks, armor stands and end crystals; use bone mealyes
BLOCK_BREAKBreak blocks; pick sweet berries; trample turtle eggsyes
SIGN_EDITWrite on signsyes
BUCKET_FILLFill a bucketyes
BUCKET_EMPTYEmpty a bucketyes
HANGING_PLACEHang paintings and item framesyes
HANGING_BREAKBreak paintings and item framesyes
TRAMPLE_CROPSTurn farmland back to dirt by jumping on itno
SPAWNER_PLACEPlace a spawner, or change its mob with a spawn eggno
SPAWNER_DESTROYBreak a spawnerno

Interaction

PermissionGrantsMember
CONTAINER_OPENOpen and use any block with an inventory: chests, barrels, shulker boxes, furnaces, hoppers, dispensers, brewing stands; fill and empty cauldronsyes
USE_REDSTONEButtons, levers, pressure plates, tripwire, repeaters, comparators, note blocks, daylight detectors, targets; also a player's arrow setting one offyes
USE_MECHANISMSDoors, trapdoors, fence gates, bells, and other right-click blocks: cakes, candles, campfires, composters, flower pots, jukeboxes, lecterns, beehives, decorated pots, chiseled bookshelves, respawn anchors, the dragon eggyes
ARMOR_STAND_MANIPULATETake from, dress and hit armor standsyes
SLEEPUse a bedyes
IGNITEStart a fire with flint and steel or a fire chargeno
TAKE_LECTERN_BOOKTake the book off a lecternno

Entities

PermissionGrantsMember
ANIMAL_DAMAGEHurt animals and every other mob that is not hostile, villagers and golems included; knock an item out of an item frameyes
MONSTER_DAMAGEHurt hostile mobsyes
ANIMAL_INTERACTRight-click, feed, breed, tame, leash, tempt and bucket animals; put or turn an item in an item frameyes
SHEAR_ENTITYShear sheep, mooshrooms and other shearable mobsyes
VILLAGER_TRADERight-click villagers to tradeyes
VEHICLE_INTERACTPlace, enter, hit and break boats and minecartsyes
RIDE_ENTITYMount horses, pigs, striders, camels and other rideable mobsyes
POTION_USEThrow splash and lingering potionsyes

Movement and miscellaneous

PermissionGrantsMember
MOVE_INSIDEBe inside the claim at allyes
TELEPORTArrive by a teleport from another plugin or a command, such as /tp or a home. The claim's own spawn and warp teleports do not check it, and portals are never refusedyes
USE_WARPSTeleport to the claim's private warps, by command or from the warp manage menu. Public warps need nothingyes
ENDERPEARL_USELand an ender pearl in the claimyes
CHORUS_TELEPORTTeleport into the claim by eating a chorus fruityes
ELYTRA_USEStart gliding with an elytrayes
WIND_BURSTLet a mace's Wind Burst affect blocks hereyes
WIND_CHARGEThrow wind charges, and let them affect blocks hereyes
ITEM_DROPDrop items, swap hands, and move items into the armor or offhand slotsyes
ITEM_PICKUPPick items upyes
FISHINGFish, and hook entities with a rodyes
RAID_TRIGGERStart a raid by arriving with Bad Omenno
CLAIM_CHATUse /claim chatno
FLYRead by other plugins, such as a fly addon, through the API. uxmClaims itself does not act on itno

Notes

  • MOVE_INSIDE is the strongest one there is. A player without it is bounced at the border and ejected by the access guard, see How protection works. Take it off Default and the claim becomes a no-entry zone for everyone who is not a member.
  • ITEM_DROP also guards armor and the offhand. A role without it cannot put armor on or swap hands inside the claim.
  • CONTAINER_OPEN is one permission for every container. A role that may use a furnace may also open the chest next to it.
  • Item frames span three permissions. HANGING_BREAK breaks the frame, ANIMAL_DAMAGE knocks the item out, ANIMAL_INTERACT puts an item in or turns it.
  • SPAWNER_PLACE and SPAWNER_DESTROY are separate from BLOCK_PLACE and BLOCK_BREAK, and Member holds neither. A member who may build still cannot take the spawner out of a grinder.
  • A member override is relative to the role. setperm ... false records a deny only when the member's role grants the permission, and setperm ... true records an allow only when it does not. Recorded overrides stay when the member changes role, and a deny beats any role.