Placeholders
AstralTown registers nine placeholder namespaces with AstralCore. For the placeholder syntax itself (%a_b_c%, %a_{b_c}%, $e(...)) see Placeholders.
towns_* (root)
Network-wide and per-viewer queries.
Placeholder | Type | Description |
|---|---|---|
| ItemProvider<Town> | Every cached town — use as a layout |
| ItemProvider<Warp> | Every warp on the network, sorted by weekly visits. |
| ItemProvider<Town> | Towns the viewer belongs to. |
| Town | The viewer's selected town (or null). |
| String | Selected town name, or |
| Boolean | Town chat toggle on the viewer's |
| ItemProvider<Warp> | Warps the viewer has pinned. |
town_*
A Town placeholder. Returned by %towns_player_selected%, layout entries from %towns_towns%, or any service that hands a Town to a placeholder container.
Placeholder | Type | Description |
|---|---|---|
| UUID | Primary key. |
| String | Town name. |
| UUID | Owner ID. |
| int | Raw balance. |
| String | Thousands-separated. |
| ItemProvider<TownMember> | All members. |
| TownMember | One member by id. |
| ItemProvider<TownRole> | All roles. |
| ItemProvider | Setting toggles for the settings menu. |
| int | Claim count. |
| ItemProvider<SubZone> | Subzones. |
| Boolean | True when the town has at least one warp. |
| Warp | Lookup by name. |
| Boolean | Whether the viewer holds the permission. |
role_*
A TownRole placeholder.
Placeholder | Type | Description |
|---|---|---|
| UUID | — |
| String | Internal name. |
| Component | MiniMessage component. |
| String | — |
| Boolean | Default role marker. |
| ItemProvider | Permission toggle items. |
| UUID? | Subzone id for scoped roles. |
| Boolean | True for subzone-scoped roles. |
| SubZone? | The subzone, when scoped. |
| Boolean | True when the viewer's weight is strictly greater than this role's. |
member_*
A TownMember or SubZoneMember. Keys overlap intentionally.
Placeholder | Type | Description |
|---|---|---|
| UUID | Player id. |
| String | Display name. |
| TownRole | Role assignment. |
| MinecraftPlayer | Network-aware player handle. |
warp_*
A Warp placeholder.
Placeholder | Type | Description |
|---|---|---|
| String | Warp name. |
| Town | Owning town. |
| int | Visit counter. |
| Boolean | True when the viewer has pinned this warp. |
subzone_*
A SubZone placeholder.
Placeholder | Type | Description |
|---|---|---|
| UUID | — |
| UUID | Parent town. |
| String | — |
| String | — |
| Boolean | — |
| EnumSet<TownSettings> | Subzone overrides. |
| List<SubZoneMember> | — |
| List<TownRole> | Subzone-scoped roles. |
| Cuboid | Region. |
| int | Corner coordinates. |
ban_*
A TownBan placeholder.
Placeholder | Type | Description |
|---|---|---|
| UUID | — |
| UUID | — |
| UUID | Banned player. |
| MinecraftPlayer | Resolved player. |
| String? | Optional reason. |
| String | Formatted timestamp. |
invitation_*
A TownInvitation placeholder.
Placeholder | Type | Description |
|---|---|---|
| UUID | — |
| MinecraftPlayer | — |
| MinecraftPlayer | — |
| long | Epoch ms. |
| long | Epoch ms. |
log_*
A TownLog placeholder — see Logs.
Placeholder | Type | Description |
|---|---|---|
| UUID | — |
| UUID | — |
| TownMember? | Acting member. |
| LogType | — |
| String | Type-aware formatted summary. |
| ItemStackWrapper | From |
| String | Formatted timestamp. |