DUXPLIMA Documentation

Claim commands

The root command and the subcommands that create, run and leave a claim.

These commands sit directly under /claim. They cover the life of a claim, flags, spawn, the vault and claim chat, plus short forms of the member commands. "Current claim" means the selected claim or the one you stand in: see Overview.

Commands

The bare command

With generalSettings.smartCommand: true, /claim on its own decides what you meant:

Where you standResult
In a claim you own or belong toOpens the claim management menu
In someone else's claimOpens your personal menu
On free land next to (north, south, east or west of) a claim you ownAdds this chunk to that claim at once, at the normal chunk price
On free land anywhere elseAsks for confirmation, then creates a claim and selects it

With smartCommand: false, the first two rows still apply and free land opens your personal menu. /claim menu always opens the personal menu.

Lifecycle

CommandWhat it doesClaim accessAbility node
/claim create [name]Creates a claim on the chunk you stand in and selects itnoneuxmclaims.ability.claim.create
/claim deleteDeletes the current claim, after confirmationowneruxmclaims.ability.claim.delete
/claim rename <name>Renames itMANAGE_RENAMEuxmclaims.ability.claim.rename
/claim extend <duration>Adds time before the claim expiresMANAGE_TIMEuxmclaims.ability.claim.reschedule
/claim setspawnSets the claim spawn to your positionMANAGE_RELOCATEuxmclaims.ability.claim.relocate
/claim transfer <player>Hands ownership to a member, after confirmationowneruxmclaims.ability.claim.transfer
/claim leaveLeaves a claim you belong tomembernone
  • create without a name uses claimSettings.defaultName. A claim name needs at least three characters. Creation is refused on claimed land, within claimSettings.minDistance chunks of another player's claim, inside a WorldGuard region or a world in generalSettings.disabledWorlds, over the claim limit, or without the money for the claim cost.
  • extend takes a compound duration such as 30m, 12h, 7d or 1d12h30m, with units d, h, m and s in any case. It is refused when claimSettings.expireMode is false, and when the remaining time would pass the owner's uxmclaims.limit.time.
  • setspawn and the warp commands only accept a position inside the claim's chunks.
  • transfer checks that you are the owner (an admin who is not the owner is refused too), that the target is not you, and that the target is already a member. The new owner's claim limit applies. You keep membership with the Member role.
  • The owner cannot leave; transfer the claim or delete it.

Selection

CommandWhat it does
/claim selectOpens a picker of the claims you own or belong to
/claim select <name>Selects one of those claims by name
/claim listOpens the list of your claims, where you can also deselect

Members and bans

CommandWhat it doesClaim accessAbility node
/claim trust <player>Sends an invite, same as /claim invite sendMANAGE_INVITESuxmclaims.ability.member.invite
/claim kick <player>Removes a member, after confirmationMANAGE_BANSuxmclaims.ability.member.kick
/claim ban <player>Bans a player at once and removes them if they are a memberMANAGE_BANSuxmclaims.ability.member.ban
/claim unban <player>Lifts a banMANAGE_BANSuxmclaims.ability.member.unban

The owner cannot be kicked or banned. A banned player cannot enter, teleport into, or be invited to the claim. The rest of member management is on Members and Invites.

Flags

CommandWhat it doesClaim accessAbility node
/claim setflag <flag> <true|false>Turns one flag on or offowneruxmclaims.ability.claim.flag.<flag>
/claim toggleflag <flag>Flips one flagowneruxmclaims.ability.claim.flag.<flag>

<flag> is one of the 32 flag names, such as PVP or TNT_EXPLOSIONS. The ability node uses the lower-case name, for example uxmclaims.ability.claim.flag.pvp, and uxmclaims.ability.claim.flag.* covers all of them.

Spawn, warps and the vault

CommandWhat it doesClaim accessAbility node
/claim spawnTeleports you to the current claim's spawnnonenone
/claim spawn <name>Teleports you to a warp or a claim by namenonenone
/claim warpsOpens the list of public warpsnonenone
/claim vaultOpens the claim vaultMANAGE_VAULTuxmclaims.ability.vault.access

/claim spawn <name> looks for a public warp, then a warp in a claim you own, then a warp in a claim you belong to, then a claim you own or belong to, and takes the first match. A public warp in a claim with PVP on asks for confirmation first. Warp teleports cost what Warps lists. Every teleport waits out the warmup, and moving cancels it.

One player at a time can have a claim's vault open; anyone else gets errorVaultAlreadyInUse.

Chat

CommandWhat it does
/claim chatTurns claim chat mode on or off for the current claim
/claim chat <message>Sends one message to the claim without changing the mode

Both need the CLAIM_CHAT role permission, which only the owner has in the shipped roles.yml. A message reaches online players who have claim chat mode on and hold CLAIM_CHAT in that claim, plus every online admin. When nobody receives it you get errorClaimChatNoOnlineMembers. The format is claimChatFormat in messages.yml.

Utility

CommandWhat it does
/claim menuOpens your personal menu
/claim showbordersShows or hides the borders of the claim or chunk you stand in
/claim invitesOpens your invitation inbox
/claim confirmRuns the pending confirmation
/claim cancelDrops the pending confirmation
/claim reloadReloads the configuration, see Admin

Permissions

NodeApplies toDefault
uxmclaims.limit.claim.<n>Claims a player may own, checked on create and for the transfer target1
uxmclaims.cost.claim.<level>.<price>Price of a new claim0.0
uxmclaims.cost.rename.<price>Price of a rename0.0
uxmclaims.cost.time.<price>Price of extend, per second and per chunk5.0
uxmclaims.limit.time.<n>Most seconds a claim may have left after extend2592000
uxmclaims.limit.ban.<n>Bans per claim25
uxmclaims.delay.rename.<n>Seconds between renames30
uxmclaims.delay.relocate.<n>Seconds between setspawn uses60
uxmclaims.delay.transfer.<n>Seconds between transfers300
uxmclaims.delay.flags.<n>Seconds between flag changes5
uxmclaims.delay.teleport.<n>Teleport warmup in seconds3

Limits on a claim use the owner's nodes; costs and cooldowns use the nodes of the player who runs the command. See Limits, costs and delays.

Extending a claim is expensive by default

uxmclaims.cost.time ships at 5.0 per second per chunk, so one extra day on a one-chunk claim costs 432000. Set a lower defaultValue in entitlements.yml before players use /claim extend or the time menu.

Settings

Key in config.ymlDefaultEffect
generalSettings.smartCommandtrueWhat a bare /claim does on free land
claimSettings.defaultNameClaim of %player.name%Name of a claim created without one
claimSettings.minDistance2Chunks kept free between your claim and another player's
claimSettings.expireModetrueClaims expire; false also disables extend
border.autoCloseSeconds30When showborders hides the borders again, 0 never

Notes

  • /claim spawn with no name costs nothing. A warp teleport charges after the warmup.
  • /claim extend prints a fixed English line, Invalid duration format!, when nothing in the input parses as a duration. Every other reply comes from messages.yml.
  • The menus run the same checks as these commands: see Claim management.

Related: Overview, Chunks and the claim block, Flags