me.lucko.helper.hologram.individual

Interface IndividualHologram

All Superinterfaces:

AutoCloseable, BaseHologram, Terminable

public interface IndividualHologram
extends BaseHologram

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
void	addViewer(org.bukkit.entity.Player player) Adds a viewer to the hologram.
static IndividualHologram	create(Position position, List<HologramLine> lines) Creates and returns a new individual hologram
Set<org.bukkit.entity.Player>	getViewers() Returns a copy of the available viewers of the hologram.
default boolean	hasViewers() Check if there are any viewers for the hologram.
void	removeViewer(org.bukkit.entity.Player player) Removes a viewer from the hologram.
void	updateLines(List<HologramLine> lines) Updates the lines displayed by this hologram

Methods inherited from interface me.lucko.helper.hologram.BaseHologram

despawn, getArmorStand, getArmorStands, isSpawned, setClickCallback, spawn, updatePosition

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

bindWith, close, closeAndReportException, closeSilently, isClosed

Method Detail

create

@Nonnull
static IndividualHologram create(@Nonnull
                                          Position position,
                                          @Nonnull
                                          List<HologramLine> lines)

Creates and returns a new individual hologram

Note: the hologram will not be spawned automatically.

Parameters:

position - the position of the hologram

lines - the initial lines to display

Returns:

the new hologram.

updateLines

void updateLines(@Nonnull
                 List<HologramLine> lines)

Updates the lines displayed by this hologram

This method does not refresh the actual hologram display. BaseHologram.spawn() must be called for these changes to apply.

Parameters:

lines - the new lines

getViewers

@Nonnull
Set<org.bukkit.entity.Player> getViewers()

Returns a copy of the available viewers of the hologram.

Returns:

a Set of players.

addViewer

void addViewer(@Nonnull
               org.bukkit.entity.Player player)

Adds a viewer to the hologram.

Parameters:

player - the player

removeViewer

void removeViewer(@Nonnull
                  org.bukkit.entity.Player player)

Removes a viewer from the hologram.

Parameters:

player - the player

hasViewers

default boolean hasViewers()

Check if there are any viewers for the hologram.

Returns:

any viewers