me.lucko.helper.hologram

Interface BaseHologram

All Superinterfaces:

AutoCloseable, Terminable

All Known Subinterfaces:

Hologram, IndividualHologram

public interface BaseHologram
extends Terminable

Base interface for holograms.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	despawn() Despawns the hologram
org.bukkit.entity.ArmorStand	getArmorStand(int line) Gets the ArmorStand holding the specified line
Collection<org.bukkit.entity.ArmorStand>	getArmorStands() Gets the ArmorStands that hold the lines for this hologram
boolean	isSpawned() Check if the hologram is currently spawned
void	setClickCallback(Consumer<org.bukkit.entity.Player> clickCallback) Sets a click callback for this hologram
void	spawn() Spawns the hologram
void	updatePosition(Position position) Updates the position of the hologram and respawns it

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, closeAndReportException, closeSilently, isClosed

Method Detail

spawn

void spawn()

Spawns the hologram

despawn

void despawn()

Despawns the hologram

isSpawned

boolean isSpawned()

Check if the hologram is currently spawned

Returns:

true if spawned and active, or false otherwise

getArmorStands

@Nonnull
Collection<org.bukkit.entity.ArmorStand> getArmorStands()

Gets the ArmorStands that hold the lines for this hologram

Returns:

the ArmorStands holding the lines

getArmorStand

@Nullable
org.bukkit.entity.ArmorStand getArmorStand(int line)

Gets the ArmorStand holding the specified line

Parameters:

line - the line

Returns:

the ArmorStand holding this line

updatePosition

void updatePosition(@Nonnull
                    Position position)

Updates the position of the hologram and respawns it

Parameters:

position - the new position

setClickCallback

void setClickCallback(@Nullable
                      Consumer<org.bukkit.entity.Player> clickCallback)

Sets a click callback for this hologram

Parameters:

clickCallback - the click callback, or null to unregister any existing callback