Index

A B C D E F H I L N O R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addBlockLine(BlockData) - Method in interface com.cotani.display.api.HologramBuilder

Appends a block display line.

addItemLine(ItemStack) - Method in interface com.cotani.display.api.HologramBuilder

Appends a floating item line.

addItemLine(ItemStack, float) - Method in interface com.cotani.display.api.HologramBuilder

Appends a floating item line with custom scale.

addLine(HologramLine) - Method in interface com.cotani.display.api.HologramBuilder

Appends a custom hologram line.

addLine(String) - Method in interface com.cotani.display.api.HologramBuilder

Appends a text line parsed via MiniMessage.

addLine(Component) - Method in interface com.cotani.display.api.HologramBuilder

Appends a text line using an Adventure Component.

addLineAsync(HologramLine) - Method in interface com.cotani.display.api.Hologram

Appends a new line to the bottom of the hologram.

addLineAsync(Component) - Method in interface com.cotani.display.api.Hologram

Appends a new text line to the bottom of the hologram.

addLineAsync(ItemStack) - Method in interface com.cotani.display.api.Hologram

Appends a new item line to the bottom of the hologram.

all() - Method in interface com.cotani.display.api.HologramService

Returns an immutable snapshot of all registered holograms.

B

backgroundColor() - Method in record class com.cotani.display.api.TextLine

Returns the value of the backgroundColor record component.

billboard() - Method in record class com.cotani.display.api.BlockLine

Returns the value of the billboard record component.

billboard() - Method in interface com.cotani.display.api.HologramLine

The billboard orientation for this line.

billboard() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the billboard record component.

billboard() - Method in record class com.cotani.display.api.TextLine

Returns the value of the billboard record component.

billboard(DisplayBillboard) - Method in interface com.cotani.display.api.HologramBuilder

Sets the default billboard mode for all lines in this hologram.

blockData() - Method in record class com.cotani.display.api.BlockLine

Returns the value of the blockData record component.

BlockLine - Record Class in com.cotani.display.api

An immutable block display line rendered via a BlockDisplay entity.

BlockLine(BlockData, DisplayBillboard, float, float, double) - Constructor for record class com.cotani.display.api.BlockLine

Creates an instance of a BlockLine record class.

build() - Method in interface com.cotani.display.api.HologramBuilder

Builds the unspawned Hologram instance.

builder() - Method in interface com.cotani.display.api.HologramService

Creates a new fluent HologramBuilder.

builder(String) - Method in interface com.cotani.display.api.HologramService

Creates a new fluent HologramBuilder with a predefined name.

C

CENTER - Enum constant in enum class com.cotani.display.api.DisplayBillboard

Center orientation: the entity always faces the viewer.

clearAsync() - Method in interface com.cotani.display.api.HologramService

Despawns and unregisters all holograms.

clearLinesAsync() - Method in interface com.cotani.display.api.Hologram

Clears all lines and destroys the spawned display entities.

clickable(boolean) - Method in interface com.cotani.display.api.HologramBuilder

Sets whether this hologram spawns a clickable hitbox.

clickHandler() - Method in interface com.cotani.display.api.Hologram

Returns the click handler callback if configured.

close() - Method in interface com.cotani.display.api.DisplayModule

Synchronously closes the module.

closeAsync() - Method in interface com.cotani.display.api.DisplayModule

Asynchronously closes the module and destroys all spawned holograms.

com.cotani.display - package com.cotani.display

com.cotani.display.api - package com.cotani.display.api

CotaniDisplays - Class in com.cotani.display

Main factory for bootstrapping and configuring the Cotani Display module.

create(Plugin, PaperTaskScheduler) - Static method in class com.cotani.display.CotaniDisplays

Creates and registers a new DisplayModule instance.

D

DEFAULT_BLOCK_HEIGHT_OFFSET - Static variable in record class com.cotani.display.api.BlockLine

DEFAULT_HEIGHT_OFFSET - Static variable in record class com.cotani.display.api.TextLine

DEFAULT_ITEM_HEIGHT_OFFSET - Static variable in record class com.cotani.display.api.ItemLine

destroyAsync() - Method in interface com.cotani.display.api.Hologram

Despawns and destroys all entities belonging to this hologram.

DisplayBillboard - Enum Class in com.cotani.display.api

Defines the billboard orientation of a display entity.

DisplayModule - Interface in com.cotani.display.api

Top-level contract for the Cotani Display module lifecycle and services.

E

entityIds() - Method in interface com.cotani.display.api.Hologram

An immutable list of Bukkit entity UUIDs associated with this hologram.

equals(Object) - Method in record class com.cotani.display.api.BlockLine

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.cotani.display.api.ItemLine

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.cotani.display.api.TextLine

Indicates whether some other object is "equal to" this one.

F

find(String) - Method in interface com.cotani.display.api.HologramService

Finds a registered hologram by its unique custom name.

find(UUID) - Method in interface com.cotani.display.api.HologramService

Finds a registered hologram by its UUID.

findByEntityId(UUID) - Method in interface com.cotani.display.api.HologramService

Finds a hologram containing an entity with the specified UUID.

FIXED - Enum constant in enum class com.cotani.display.api.DisplayBillboard

Fixed orientation: the entity maintains its spawn rotation.

fromBukkit(Display.Billboard) - Static method in enum class com.cotani.display.api.DisplayBillboard

Converts a Bukkit Display.Billboard to a DisplayBillboard.

H

handleClick(Player, Hologram, HologramClickType) - Method in interface com.cotani.display.api.HologramClickHandler

Handles an interaction with a hologram.

hashCode() - Method in record class com.cotani.display.api.BlockLine

Returns a hash code value for this object.

hashCode() - Method in record class com.cotani.display.api.ItemLine

Returns a hash code value for this object.

hashCode() - Method in record class com.cotani.display.api.TextLine

Returns a hash code value for this object.

heightOffset() - Method in record class com.cotani.display.api.BlockLine

Returns the value of the heightOffset record component.

heightOffset() - Method in interface com.cotani.display.api.HologramLine

The vertical height offset of this line in blocks.

heightOffset() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the heightOffset record component.

heightOffset() - Method in record class com.cotani.display.api.TextLine

Returns the value of the heightOffset record component.

Hologram - Interface in com.cotani.display.api

Represents an active or unspawned multi-line Display Entity Hologram.

HologramBuilder - Interface in com.cotani.display.api

Fluent builder for configuring and spawning a Hologram.

HologramClickHandler - Interface in com.cotani.display.api

Functional callback invoked when a player interacts with a clickable hologram.

HologramClickType - Enum Class in com.cotani.display.api

Defines the type of interaction performed on a hologram.

HologramLine - Interface in com.cotani.display.api

Common sealed contract representing an individual line or layer inside a Hologram.

holograms() - Method in interface com.cotani.display.api.DisplayModule

Returns the HologramService instance.

HologramService - Interface in com.cotani.display.api

Service managing the lifecycle, registration, and discovery of Hologram instances.

HORIZONTAL - Enum constant in enum class com.cotani.display.api.DisplayBillboard

Horizontal orientation: the entity rotates around its horizontal axis to face the viewer.

I

id() - Method in interface com.cotani.display.api.Hologram

The unique identifier of this hologram.

interactionEntityId() - Method in interface com.cotani.display.api.Hologram

Returns the UUID of the clickable interaction hitbox entity, if spawned and clickable.

isLeftClick() - Method in enum class com.cotani.display.api.HologramClickType

Determines whether this is a left click.

isRightClick() - Method in enum class com.cotani.display.api.HologramClickType

Determines whether this is a right click.

isShiftClick() - Method in enum class com.cotani.display.api.HologramClickType

Determines whether this click includes the shift modifier.

isSpawned() - Method in interface com.cotani.display.api.Hologram

Checks if this hologram is currently spawned in the world.

item() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the item record component.

ItemLine - Record Class in com.cotani.display.api

An immutable item display line rendered via an ItemDisplay entity.

ItemLine(ItemStack, ItemDisplay.ItemDisplayTransform, DisplayBillboard, float, float, double, boolean) - Constructor for record class com.cotani.display.api.ItemLine

Creates an instance of a ItemLine record class.

itemTransform() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the itemTransform record component.

L

LEFT_CLICK - Enum constant in enum class com.cotani.display.api.HologramClickType

lineCount() - Method in interface com.cotani.display.api.Hologram

Returns the number of lines currently configured.

lines() - Method in interface com.cotani.display.api.Hologram

An immutable snapshot of the lines in this hologram, ordered top to bottom.

lineSpacing(double) - Method in interface com.cotani.display.api.HologramBuilder

Sets the vertical spacing multiplier between lines in blocks.

location() - Method in interface com.cotani.display.api.Hologram

The base location of this hologram.

N

name() - Method in interface com.cotani.display.api.Hologram

The optional custom name/identifier of this hologram.

name(String) - Method in interface com.cotani.display.api.HologramBuilder

Sets a custom name identifier for the hologram.

O

of(String) - Static method in record class com.cotani.display.api.TextLine

Creates a text line parsed from a MiniMessage string.

of(Component) - Static method in record class com.cotani.display.api.TextLine

Creates a standard text line with default display properties.

of(Component, DisplayBillboard, float) - Static method in record class com.cotani.display.api.TextLine

Creates a text line with specified billboard and scale.

of(BlockData) - Static method in record class com.cotani.display.api.BlockLine

Creates a block display line.

of(BlockData, DisplayBillboard, float) - Static method in record class com.cotani.display.api.BlockLine

Creates a block display line with specific scale and billboard.

of(ItemStack) - Static method in record class com.cotani.display.api.ItemLine

Creates a standard floating item line.

of(ItemStack, float) - Static method in record class com.cotani.display.api.ItemLine

Creates a spinning floating item line.

onClick(HologramClickHandler) - Method in interface com.cotani.display.api.HologramBuilder

Configures a click interaction callback and enables the clickable hitbox.

R

removeAsync(Hologram) - Method in interface com.cotani.display.api.HologramService

Removes and despawns the specified hologram.

removeAsync(String) - Method in interface com.cotani.display.api.HologramService

Removes and despawns a hologram by its name.

removeAsync(UUID) - Method in interface com.cotani.display.api.HologramService

Removes and despawns a hologram by its UUID.

removeLineAsync(int) - Method in interface com.cotani.display.api.Hologram

Removes a line at the specified index.

RIGHT_CLICK - Enum constant in enum class com.cotani.display.api.HologramClickType

S

scale() - Method in record class com.cotani.display.api.BlockLine

Returns the value of the scale record component.

scale() - Method in interface com.cotani.display.api.HologramLine

The uniform scaling multiplier for this line.

scale() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the scale record component.

scale() - Method in record class com.cotani.display.api.TextLine

Returns the value of the scale record component.

seeThrough() - Method in record class com.cotani.display.api.TextLine

Returns the value of the seeThrough record component.

setClickHandler(HologramClickHandler) - Method in interface com.cotani.display.api.Hologram

Updates the click handler callback for this hologram.

shadow() - Method in record class com.cotani.display.api.TextLine

Returns the value of the shadow record component.

SHIFT_LEFT_CLICK - Enum constant in enum class com.cotani.display.api.HologramClickType

SHIFT_RIGHT_CLICK - Enum constant in enum class com.cotani.display.api.HologramClickType

spawnAsync(Location) - Method in interface com.cotani.display.api.Hologram

Spawns this hologram at the specified location safely on the region thread.

spawnAsync(Location) - Method in interface com.cotani.display.api.HologramBuilder

Builds and spawns the hologram at the specified location safely on the region thread.

spin() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the spin record component.

T

teleportAsync(Location) - Method in interface com.cotani.display.api.Hologram

Teleports this hologram to a new location.

text() - Method in record class com.cotani.display.api.TextLine

Returns the value of the text record component.

TextLine - Record Class in com.cotani.display.api

An immutable text line rendered via a TextDisplay entity.

TextLine(Component, DisplayBillboard, Color, boolean, boolean, byte, float, float, double) - Constructor for record class com.cotani.display.api.TextLine

Creates an instance of a TextLine record class.

textOpacity() - Method in record class com.cotani.display.api.TextLine

Returns the value of the textOpacity record component.

toBukkit() - Method in enum class com.cotani.display.api.DisplayBillboard

Returns the corresponding Bukkit Display.Billboard representation.

toString() - Method in record class com.cotani.display.api.BlockLine

Returns a string representation of this record class.

toString() - Method in record class com.cotani.display.api.ItemLine

Returns a string representation of this record class.

toString() - Method in record class com.cotani.display.api.TextLine

Returns a string representation of this record class.

U

updateLineAsync(int, HologramLine) - Method in interface com.cotani.display.api.Hologram

Updates an existing line at the specified index.

updateLineAsync(int, Component) - Method in interface com.cotani.display.api.Hologram

Updates an existing text line with a new Component.

updateLineAsync(int, ItemStack) - Method in interface com.cotani.display.api.Hologram

Updates an existing item line with a new ItemStack.

V

valueOf(String) - Static method in enum class com.cotani.display.api.DisplayBillboard

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.cotani.display.api.HologramClickType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.cotani.display.api.DisplayBillboard

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.cotani.display.api.HologramClickType

Returns an array containing the constants of this enum class, in the order they are declared.

VERTICAL - Enum constant in enum class com.cotani.display.api.DisplayBillboard

Vertical orientation: the entity rotates around its vertical axis to face the viewer.

viewRange() - Method in record class com.cotani.display.api.BlockLine

Returns the value of the viewRange record component.

viewRange() - Method in interface com.cotani.display.api.HologramLine

The maximum view distance range ratio for this line.

viewRange() - Method in record class com.cotani.display.api.ItemLine

Returns the value of the viewRange record component.

viewRange() - Method in record class com.cotani.display.api.TextLine

Returns the value of the viewRange record component.

W

withBackground(Color) - Method in record class com.cotani.display.api.TextLine

Returns a copy with the specified background color.

withBillboard(DisplayBillboard) - Method in record class com.cotani.display.api.BlockLine

Returns a copy with the specified billboard mode.

withBillboard(DisplayBillboard) - Method in record class com.cotani.display.api.ItemLine

Returns a copy with the specified billboard mode.

withBillboard(DisplayBillboard) - Method in record class com.cotani.display.api.TextLine

Returns a copy with the specified billboard mode.

withBlockData(BlockData) - Method in record class com.cotani.display.api.BlockLine

Returns a copy with the updated block data.

withHeightOffset(double) - Method in record class com.cotani.display.api.BlockLine

Returns a copy with the specified height offset.

withHeightOffset(double) - Method in record class com.cotani.display.api.ItemLine

Returns a copy with the specified height offset.

withHeightOffset(double) - Method in record class com.cotani.display.api.TextLine

Returns a copy with the specified height offset.

withItem(ItemStack) - Method in record class com.cotani.display.api.ItemLine

Returns a copy with the updated item stack.

withOpacity(byte) - Method in record class com.cotani.display.api.TextLine

Returns a copy with the specified text opacity.

withScale(float) - Method in record class com.cotani.display.api.BlockLine

Returns a copy with the specified scale.

withScale(float) - Method in record class com.cotani.display.api.ItemLine

Returns a copy with the specified scale.

withScale(float) - Method in record class com.cotani.display.api.TextLine

Returns a copy with the specified scale.

withText(Component) - Method in record class com.cotani.display.api.TextLine

Returns a copy of this text line with the updated text component.

A B C D E F H I L N O R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values