Package me.bimmr.bimmcore.hologram

Class HologramLine

java.lang.Object

me.bimmr.bimmcore.utils.timed.TimedObject

me.bimmr.bimmcore.hologram.HologramLine

public class HologramLine
extends TimedObject

HologramLine Class - Should only be used by Holograms

Field Summary

Fields inherited from class me.bimmr.bimmcore.utils.timed.TimedObject

timedEvent

Constructor Summary

Constructors

Constructor	Description
HologramLine(Hologram hologram, org.bukkit.Location location, java.lang.String text)	Create a HologramLine - Should only be used by Holograms TimedEvent is null
HologramLine(Hologram hologram, org.bukkit.Location location, java.lang.String text, TimedEvent timedEvent)	Create a HologramLine - Should only be used by Holograms Doesn't start TimedEvent right away
HologramLine(Hologram hologram, org.bukkit.Location location, java.lang.String text, TimedEvent timedEvent, boolean startTimedEvent)	Create a HologramLine - Should only be used by Holograms

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getHologramObject()
int	getId()
org.bukkit.Location	getLocation()
java.lang.String	getText()
void	remove()	Remove the HologramLine from every player
void	removePlayer(java.lang.String player)	Remove the HologramLine from a specific player Calls removePlayer(Player)
void	removePlayer(org.bukkit.entity.Player player)	Remove the HologramLine from a specific player
void	setText(java.lang.String text)	Set the HologramLine's text
void	showPlayer(java.lang.String player)	Show the HologramLine to the player Calls showPlayer(Player)
void	showPlayer(org.bukkit.entity.Player player)	Show the HologramLine to the player

Methods inherited from class me.bimmr.bimmcore.utils.timed.TimedObject

getTimedEvent, isTaskRunning, onTaskRun, setTimedEvent, setTimedEvent, setTimedEvent, setTimedEvent, startTask, stopTask

Methods inherited from class java.lang.Object

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

Constructor Detail

HologramLine

public HologramLine(Hologram hologram,
                    org.bukkit.Location location,
                    java.lang.String text)

Create a HologramLine - Should only be used by Holograms TimedEvent is null

Parameters:

hologram - The Hologram

location - The location for the hologram line

text - The text for the hologram line

HologramLine

public HologramLine(Hologram hologram,
                    org.bukkit.Location location,
                    java.lang.String text,
                    TimedEvent timedEvent)

Create a HologramLine - Should only be used by Holograms Doesn't start TimedEvent right away

Parameters:

hologram - The Hologram

location - The location for the hologram line

text - The text for the hologram line

timedEvent - The timed event to run

HologramLine

public HologramLine(Hologram hologram,
                    org.bukkit.Location location,
                    java.lang.String text,
                    TimedEvent timedEvent,
                    boolean startTimedEvent)

Create a HologramLine - Should only be used by Holograms

Parameters:

hologram - The Hologram

location - The location for the hologram line

text - The text for the hologram line

timedEvent - The timed event to run

startTimedEvent - If timed even is starting right away

Method Detail

getId

public int getId()

Returns:

Get Bukiit Entity's ID

getHologramObject

public java.lang.Object getHologramObject()

Returns:

Get the HologramAPI Object

getLocation

public org.bukkit.Location getLocation()

Returns:

Get the HologramLine's Location

getText

public java.lang.String getText()

Returns:

Get the HologramLine's Text

setText

public void setText(java.lang.String text)

Set the HologramLine's text

Parameters:

text - The Text to set

showPlayer

public void showPlayer(java.lang.String player)

Show the HologramLine to the player Calls showPlayer(Player)

Parameters:

player - Player's Name

showPlayer

public void showPlayer(org.bukkit.entity.Player player)

Show the HologramLine to the player

Parameters:

player - The player

remove

public void remove()

Remove the HologramLine from every player

removePlayer

public void removePlayer(java.lang.String player)

Remove the HologramLine from a specific player Calls removePlayer(Player)

Parameters:

player - The player's name

removePlayer

public void removePlayer(org.bukkit.entity.Player player)

Remove the HologramLine from a specific player

Parameters:

player - The player