Package io.github.thebusybiscuit.slimefun4.core.services.holograms

Class HologramsService

java.lang.Object

io.github.thebusybiscuit.slimefun4.core.services.holograms.HologramsService

public class HologramsService
extends Object

This service is responsible for handling holograms.

Author:

TheBusyBiscuit

See Also:

• HologramOwner

Constructor Summary

Constructors

Constructor	Description
HologramsService(Plugin plugin)	This constructs a new HologramsService.

Method Summary

Modifier and Type	Method	Description
Vector	getDefaultOffset()	This returns the default Hologram offset.
boolean	removeHologram(Location loc)	This removes the Hologram at that given Location.
void	setHologramLabel(Location loc, String label)	This will update the label of the Hologram.
void	start()	This will start the HologramsService and schedule a repeating purge-task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HologramsService

public HologramsService(@Nonnull
 Plugin plugin)

This constructs a new HologramsService.

Parameters:

plugin - Our Plugin instance

Method Details

start

public void start()

This will start the HologramsService and schedule a repeating purge-task.

getDefaultOffset

@Nonnull
public Vector getDefaultOffset()

This returns the default Hologram offset.

Returns:

The default offset

removeHologram

public boolean removeHologram(@Nonnull
 Location loc)

This removes the Hologram at that given Location.

This method must be executed on the main Server Thread.

Parameters:

loc - The Location

Returns:

Whether the Hologram could be removed, false if the Hologram does not exist or was already removed

setHologramLabel

public void setHologramLabel(@Nonnull
 Location loc,
 @Nullable
 String label)

This will update the label of the Hologram.

Parameters:

loc - The Location of this Hologram

label - The label to set, can be null