Skip to content

API Reference

wjddusrb03 edited this page Mar 29, 2026 · 1 revision

API Reference

Entry Point: DisplayAPI

All API access starts from the static DisplayAPI class.

Factory Methods

DisplayAPI.text(Location) → TextDisplayBuilderDisplayAPI.block(Location) → BlockDisplayBuilderDisplayAPI.item(Location) → ItemDisplayBuilderDisplayAPI.popup(Location) → PopupBuilderDisplayAPI.interactive(Location) → InteractiveBuilderDisplayAPI.animate(SpawnedDisplay) → AnimationBuilderDisplayAPI.follow(SpawnedDisplay, Entity) → FollowDisplayDisplayAPI.leaderboard(Location) → LeaderboardDisplayAPI.group(Stringid, Location) → DisplayGroup

Management

DisplayAPI.getById(Stringid) → SpawnedDisplayDisplayAPI.remove(Stringid) → voidDisplayAPI.removeAll() → voidDisplayAPI.getManager() → DisplayManagerDisplayAPI.getPersistenceManager() → PersistenceManagerDisplayAPI.getPlugin() → PluginDisplayAPI.getDefaultViewRange() → float

Class Overview

Builders (com.wjddusrb03.displayapi.builder)

ClassDescription
AbstractDisplayBuilder<T>Base builder with common properties
TextDisplayBuilderText hologram builder
BlockDisplayBuilderBlock display builder
ItemDisplayBuilderItem display builder
PopupBuilderAnimated popup builder
InteractiveBuilderClickable display builder

Display (com.wjddusrb03.displayapi.display)

ClassDescription
SpawnedDisplayWrapper around a spawned Display entity
DisplayGroupGroups multiple displays
InteractiveDisplayDisplay + Interaction entity pair
FollowDisplayDisplay that follows an entity
LeaderboardAuto-updating ranked display

Animation (com.wjddusrb03.displayapi.animation)

ClassDescription
AnimationBuilderBuilder for animations (presets + custom)
DisplayAnimationRunning animation controller
KeyframeSingle animation keyframe
Easing12 easing function enum

Manager (com.wjddusrb03.displayapi.manager)

ClassDescription
DisplayManagerTracks all active displays, groups, interactives
PersistenceManagerYAML save/load for persistent displays

Utility (com.wjddusrb03.displayapi.util)

ClassDescription
PlaceholderUtilSafe PlaceholderAPI integration

Listener (com.wjddusrb03.displayapi.listener)

ClassDescription
DisplayListenerPer-player visibility on join
InteractionListenerRoutes click events to InteractiveDisplay

Package Structure

com.wjddusrb03.displayapi
├── DisplayAPI.java (static entry point)
├── DisplayAPIPlugin.java (plugin main class)
├── builder/
│ ├── AbstractDisplayBuilder (base builder)
│ ├── TextDisplayBuilder
│ ├── BlockDisplayBuilder
│ ├── ItemDisplayBuilder
│ ├── PopupBuilder
│ └── InteractiveBuilder
├── display/
│ ├── SpawnedDisplay (spawned entity wrapper)
│ ├── DisplayGroup (group management)
│ ├── InteractiveDisplay (click detection)
│ ├── FollowDisplay (entity tracking)
│ └── Leaderboard (ranked display)
├── animation/
│ ├── AnimationBuilder (animation factory)
│ ├── DisplayAnimation (animation runner)
│ ├── Keyframe (animation data)
│ └── Easing (12 easing curves)
├── manager/
│ ├── DisplayManager (display tracking)
│ └── PersistenceManager (YAML persistence)
├── listener/
│ ├── DisplayListener (visibility events)
│ └── InteractionListener (click events)
├── util/
│ └── PlaceholderUtil (PlaceholderAPI)
└── command/
└── DisplayAPICommand (admin commands)

Clone this wiki locally