Package me.ulrich.outpost.data

Class OptimalHologram

java.lang.Object

me.ulrich.outpost.data.OptimalHologram

All Implemented Interfaces:

Hologram

public final class OptimalHologram
extends Object
implements Hologram

The default implementation of the Hologram

Constructor Summary

Constructors

Constructor	Description
OptimalHologram(HologramAPI connector, Object hologramObject, org.bukkit.Location location, String id, Object extra)	Create a new hologram

Method Summary

Modifier and Type	Method	Description
ItemLine	appendItemLine(org.bukkit.inventory.ItemStack itemStack)	Append an ItemLine to the Hologram with an ItemStack display
void	appendLine(Line line)	Append a Line to the Hologram
TextLine	appendTextLine(String text)	Append a TextLine to the Hologram with a String display
void	delete()	Delete the Hologram, and all attached entities
Object	getExtra()
Object	getHologramAsObject()	Get the Hologram as a Object from the HologramAPI source
String	getId()
Line	getLineAt(int index)	Get a Line at an index
int	getLineIndex(Line line)	Get the index of a Line
List<Line>	getLines()	Get the Collection of Lines that the Hologram has displayed
org.bukkit.Location	getLocation()	Get the Holograms current Location
VisibilityManager	getVisibilityManager()	Get the VisibilityManager for the Hologram
void	setLineAt(int index, Line line)	Set a Line at an index
int	size()	Get the size of all the attached Lines
void	teleport(org.bukkit.Location location)	Teleport the Hologram to a different location
void	updateLine(int index, Line line)	Update a Line at an index

Methods inherited from class java.lang.Object

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

Constructor Details

OptimalHologram

public OptimalHologram(HologramAPI connector,
 Object hologramObject,
 org.bukkit.Location location,
 String id,
 Object extra)

Create a new hologram

Parameters:

connector - The connector to use

hologramObject - The hologram object for the connector

location - The starting location

Method Details

getLines

public List<Line> getLines()

Description copied from interface: Hologram

Get the Collection of Lines that the Hologram has displayed

Specified by:

getLines in interface Hologram

Returns:

The Collection of Hologram Lines

getLineAt

public Line getLineAt(int index)

Description copied from interface: Hologram

Get a Line at an index

Specified by:

getLineAt in interface Hologram

Parameters:

index - The index to use to fetch the line

Returns:

The Line

getLineIndex

public int getLineIndex(Line line)

Description copied from interface: Hologram

Get the index of a Line

Specified by:

getLineIndex in interface Hologram

Parameters:

line - The Line to find the index for

Returns:

The Line index

setLineAt

public void setLineAt(int index,
 Line line)

Description copied from interface: Hologram

Set a Line at an index

Specified by:

setLineAt in interface Hologram

Parameters:

index - The index to set

line - The Line to set at that index

updateLine

public void updateLine(int index,
 Line line)

Description copied from interface: Hologram

Update a Line at an index

Specified by:

updateLine in interface Hologram

Parameters:

index - The index to update

line - The Line to change it to

appendLine

public void appendLine(Line line)

Description copied from interface: Hologram

Append a Line to the Hologram

Specified by:

appendLine in interface Hologram

Parameters:

line - The Line to append

appendItemLine

public ItemLine appendItemLine(org.bukkit.inventory.ItemStack itemStack)

Description copied from interface: Hologram

Append an ItemLine to the Hologram with an ItemStack display

Specified by:

appendItemLine in interface Hologram

Parameters:

itemStack - The ItemStack to display

Returns:

The ItemLine created

appendTextLine

public TextLine appendTextLine(String text)

Description copied from interface: Hologram

Append a TextLine to the Hologram with a String display

Specified by:

appendTextLine in interface Hologram

Parameters:

text - The String to display

Returns:

The TextLine created

getVisibilityManager

public VisibilityManager getVisibilityManager()

Description copied from interface: Hologram

Get the VisibilityManager for the Hologram

Specified by:

getVisibilityManager in interface Hologram

Returns:

The VisibilityManager

getLocation

public org.bukkit.Location getLocation()

Description copied from interface: Hologram

Get the Holograms current Location

Specified by:

getLocation in interface Hologram

Returns:

The Location

teleport

public void teleport(org.bukkit.Location location)

Description copied from interface: Hologram

Teleport the Hologram to a different location

Specified by:

teleport in interface Hologram

Parameters:

location - The new Hologram Location

delete

public void delete()

Description copied from interface: Hologram

Delete the Hologram, and all attached entities

Specified by:

delete in interface Hologram

size

public int size()

Description copied from interface: Hologram

Get the size of all the attached Lines

Specified by:

size in interface Hologram

Returns:

The size of the Hologram Lines

getHologramAsObject

public Object getHologramAsObject()

Description copied from interface: Hologram

Get the Hologram as a Object from the HologramAPI source

Specified by:

getHologramAsObject in interface Hologram

Returns:

The Object

getId

public String getId()

Specified by:

getId in interface Hologram

getExtra

public Object getExtra()

Specified by:

getExtra in interface Hologram