DUXPLIMA Documentation

Reference

The uxmclaims expansion, the path syntax, the modifiers and the tokens in plugin files.

uxmClaims has one placeholder engine. PlaceholderAPI reaches it through the uxmclaims expansion; messages.yml, webhooks.yml, the menus, the dialogs, the holograms and the map tooltips use it directly, without the uxmclaims_ prefix.

The expansion registers when generalSettings.placeholderSupport is true (the default) and PlaceholderAPI is installed. The tokens in uxmClaims' own files work either way.

How a PlaceholderAPI placeholder resolves

Everything after uxmclaims_ is a path that starts at the claim:

%uxmclaims_claim_name%          →  Iron Hollow
%uxmclaims_claim_owner_name%    →  Steve
%uxmclaims_claim_expireDate%    →  2026-11-14 18:02:11

The claim is the first of these that exists:

  1. The claim the player selected with /claim select
  2. The claim the player stands in
  3. The player's only claim, when they own exactly one

With none of them, the expansion answers from placeholderDefaults at the end of messages.yml, keyed by the full name without the percent signs:

placeholderDefaults:
  uxmclaims_claim_name: 'Wilderness'
  uxmclaims_claim_owner_name: 'None'

A placeholder with no entry there stays in the text as you typed it. Add an entry for anything you put on a permanent scoreboard. A request without an online player returns an empty string.

The path rules

RuleExample
. and _ are the same separatorclaim_owner_name and claim.owner.name
Each step calls getStep(), then step(), then reads the field stepclaim_spawnLocation_x calls getSpawnLocation().getX()
A member, invitation or ban falls through to that playerclaim_owner_name reads the owner's player name
A step that resolves to nothing renders nullclaim_nmae renders null

Because the path is resolved against the domain model, any getter is reachable, not only the ones below.

Placeholders

PlaceholderRenders
%uxmclaims_is_claimable%true when no claim covers the player's position, else false
%uxmclaims_claim_name%The claim's name
%uxmclaims_claim_id%Its UUID
%uxmclaims_claim_ownerUid%The owner's UUID
%uxmclaims_claim_owner_name%The owner's name
%uxmclaims_count:claim_chunks%How many chunks it holds
%uxmclaims_count:claim_members%How many members, the owner included
%uxmclaims_count:claim_warps%How many warps
%uxmclaims_count:claim_roles%How many roles
%uxmclaims_count:claim_bans%How many bans
%uxmclaims_count:claim_invites%How many pending invitations
%uxmclaims_count:claim_flags%How many flags are on
%uxmclaims_count:claim_vault_items%How many items are in the vault
%uxmclaims_time:claim_remainTime%Time left before expiry, in timeFormat
%uxmclaims_date:claim_expireDate%The expiry date, in dateFormat
%uxmclaims_date:claim_creationDate%When it was created, in dateFormat
%uxmclaims_claim_spawnLocation_world%The world its spawn is in
%uxmclaims_claim_spawnLocation_x%Spawn x, likewise _y and _z
%uxmclaims_claim_block_keyId%The claim block's style key, such as block1
%uxmclaims_status:claim_block_placed%Whether the claim block is placed
%uxmclaims_status:claim_isExpired%Whether the claim has expired

%uxmclaims_is_claimable% is answered before the claim is resolved, so it works anywhere.

Values without a modifier

ValueRenders as
Text, whole number, UUID, enumAs is: Iron Hollow, 7, PVP
DecimalTwo places: 128.50
BooleanYes or No
Instant (expireDate, creationDate)yyyy-MM-dd HH:mm:ss
Duration (remainTime)Java's own form, PT295H41M2S: use time:
Locationworld:x:y:z, with two decimals
List, set or mapIts raw contents: use count:

Modifiers

A modifier goes before a colon and transforms the value.

ModifierTakesGives
count:A list, set or mapIts size
time:A duration, or a number of millisecondstimeFormat from messages.yml
date:An instant, a date, or a millisecond timestampdateFormat from messages.yml
status:A boolean, or an integer (0 is off)statusActive or statusPassive
float:A numberTwo decimal places
upper:AnythingUpper case
lower:AnythingLower case

A modifier that does not fit the value, or an unknown one, renders the value as plain text.

%uxmclaims_count:claim_members%           →  7
%uxmclaims_time:claim_remainTime%         →  12 days 06 hours 41 minutes 02 seconds
%uxmclaims_status:claim_block_placed%     →  Enabled

The formats sit at the top of messages.yml:

KeyDefaultNotes
timeFormatdd days HH hours mm minutes ss secondsdd, HH, mm and ss are replaced; days are not capped
dateFormatdd-MM-yyyy HH:mm:ssA Java DateTimeFormatter pattern, in the server's time zone
statusActive<green>Enabled</green>What status: renders for on
statusPassive<red>Disabled</red>What status: renders for off

Tokens inside plugin files

Inside uxmClaims' own files the path starts at an object the plugin puts in context. Which objects exist depends on where the text is shown.

Token rootIsAvailable in
claimThe claim: every path above, without uxmclaims_Messages about a claim, claim menus, holograms, map tooltips, webhooks
playerThe viewer: %player.name%Every menu, claim chat, claimSettings.defaultName, messages that name a player
memberA member: name, texture, uid, joinDate, roleIdMember menus and messages
roleA role: name, priority, type, permissionsRole and member menus, role messages
warpA warp: name, location, isPublic, createdAt, createdBy (a UUID)Warp menus and messages
creatorThe warp creator's name, or their UUID when the player is unknown: %creator%The public warp list
inviteAn invitation: name, texture, invitedAtInvitation menus
banA ban: name, texture, reason, bannedAtThe ban list
chunkA chunk: world, x, z, center.x, center.z, and centerX, centerZ (the middle block, whole numbers)The chunk map
targetThe inspected player: %target.name%/claim admin view
eventThe event that firedwebhooks.yml

Some texts carry plain values instead of objects:

TokenIsAvailable in
%flag%, %permission%, %status%The flag or permission, and its new stateFlag and permission messages; %status% also in the flag and permission menus
%cost%A price; %float:cost% for two decimalsMain menu, chunk map, time menu
%costPerDay%, %totalMillis%One day's price, the chosen extensionThe time menu
%ownedClaimAmount%, %memberedClaimAmount%Claims you own, claims you belong toThe general main menu (common_main.yml)
%maximum%The viewer's member limitThe invitation list
%permissionCount%How many permissions the role hasThe role list
%seconds%The teleport warmupThe teleport countdown message
%message%The chat lineclaimChatFormat
%time%Seconds left to typeChat text input titles

%member.texture%, %invite.texture% and %ban.texture% resolve to the player's skin, which is how menu heads are drawn.

Other plugins' placeholders do not work in uxmClaims' files

uxmClaims does not pass its own messages, menus or holograms through PlaceholderAPI. A token such as %vault_eco_balance% in messages.yml renders null.