Visuals
In-world screens and utilities
Spatial 3D menus, stages, the crate scene, guides, abilities, action bars, build zones and runtime commands.
Newer modules for screens drawn in the world and for small services plugins share. All are packet-only or server-side: no resource pack.
| Module | Entry point | Since | What it is for |
|---|---|---|---|
| Spatial | SpatialMenus.of(plugin) | 1.406.0 | In-world 3D menus: glass panels, lists, grids, a carousel of plinths and a live preview, laid out in YAML and moved in game. Looked at to aim, clicked to choose, scrolled to page, sneaked out of. Includes SpatialCatalog, a cosmetic shop and wardrobe. |
| Stage | Stage | 1.356.0 | Per-player screens built from packet displays: a board in front of a seat, buttons picked by looking, a dark room round the player, a countdown with boss bars, cards and dice. |
| Crate scene | CrateScene | 1.418.0 | The in-world crate opening, turned on per crate with crate.opening: SPATIAL (default INVENTORY): a reel slows onto the prize, then the prize is tried on where the crate stood, with "open another" and "done". |
| Guide | Guides.of(plugin) | 1.391.0 | Showing one player where to go: a companion text ahead of their eyes, beacons, ground trails, locator-bar and modded waypoints, per-viewer glow. |
| Abilities | Abilities.of(plugin) | 1.385.0 | Triggered abilities from YAML (trigger, conditions, chance, cooldown, effects scaled by level) with an in-game editor, plus AreaBreaks (3x3, 3x3x3, veins, trees). |
| Action bars | ActionBars.register(plugin, id, priority, supplier) | 1.323.0 | One action bar line per player shared by every plugin: each plugin hands over a segment, drawn in order and separated by ` |
| Build zones | BuildZones.canBuild(player, block) | 1.432.0 | One answer to "may this player build, break, use or open this block" across WorldGuard, ExyliaLib regions, ExyliaProtections, Lands, GriefPrevention, Towny and SuperiorSkyblock2. |
| Runtime commands | RuntimeCommands.of(plugin) | 1.333.0 | Commands named by a plugin's data (a shop opened with /blocks, a currency with /gems), installed into the command map and replaced as a set. |
Notes
- Build zones is for actions outside a block event (a menu opening a block's storage, a remote sell). Inside
a block event at
ignoreCancelled = truethe claim plugins have already spoken. A server owner can limit which sources count;deniedByreports which one refused. - Runtime commands:
install(commands)replaces everything the plugin installed before. A name another plugin holds still answers under the plugin's prefix. - Action bars: call
ActionBars.refresh(player)when a segment changed and should not wait for the next refresh. - Guides, stages and spatial menus need PacketEvents, like the rest of the library's packet features.
Something missing on this page? Tell us on Discord