me.lucko.helper.hologram

Interface Hologram

All Superinterfaces:

AutoCloseable, GsonSerializable, Terminable

public interface Hologram
extends Terminable, GsonSerializable

A simple hologram utility. Should only be used from the server thread.

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
static Hologram	create(Position position, List<String> lines) Creates and returns a new hologram
static Hologram	deserialize(JsonElement element)
void	despawn() Despawns the hologram
void	setClickCallback(Consumer<Player> clickCallback) Sets a click callback for this hologram
void	spawn() Spawns the hologram
void	updateLines(List<String> lines) Updates the lines displayed by this 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, hasTerminated, of, terminate

Methods inherited from interface me.lucko.helper.gson.GsonSerializable

deserialize, deserializeRaw, getDeserializeMethod, serialize

Method Detail

create

@Nonnull
static Hologram create(@Nonnull
                                 Position position,
                                 @Nonnull
                                 List<String> lines)

Creates and returns a new 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.

deserialize

static Hologram deserialize(JsonElement element)

spawn

void spawn()

Spawns the hologram

despawn

void despawn()

Despawns the hologram

updatePosition

void updatePosition(@Nonnull
                    Position position)

Updates the position of the hologram and respawns it

Parameters:

position - the new position

updateLines

void updateLines(@Nonnull
                 List<String> lines)

Updates the lines displayed by this hologram

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

Parameters:

lines - the new lines

setClickCallback

void setClickCallback(@Nullable
                      Consumer<Player> clickCallback)

Sets a click callback for this hologram

Parameters:

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