net.citizensnpcs.trait

Class HologramTrait

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.trait.HologramTrait

All Implemented Interfaces:

Runnable, org.bukkit.event.Listener

public class HologramTrait
extends Trait

Persists a hologram attached to the NPC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HologramTrait.HologramDirection

Field Summary

Fields inherited from class net.citizensnpcs.api.trait.Trait

npc

Constructor Summary

Constructors

Constructor and Description
HologramTrait()

Method Summary

Modifier and Type	Method and Description
void	addLine(String text) Adds a new hologram line which will displayed over an NPC's head.
void	clear() Clears all hologram lines
HologramTrait.HologramDirection	getDirection()
Collection<org.bukkit.entity.ArmorStand>	getHologramEntities() Note: this is implementation-specific and may be removed at a later date.
double	getLineHeight()
List<String>	getLines()
org.bukkit.entity.ArmorStand	getNameEntity() Note: this is implementation-specific and may be removed at a later date.
void	onDespawn() Called just before the attached NPC is despawned.
void	onRemove() Called when a trait is removed from the attached NPC.
void	onSpawn() Called when an NPC is spawned.
void	removeLine(int idx) Removes the line at the specified index
void	run() Called every tick if overridden.
void	setDirection(HologramTrait.HologramDirection direction)
void	setLine(int idx, String text) Sets the hologram line at a specific index
void	setLineHeight(double height) Sets the line height

Methods inherited from class net.citizensnpcs.api.trait.Trait

getName, getNPC, isRunImplemented, linkToNPC, load, onAttach, onCopy, onPreSpawn, save

Methods inherited from class java.lang.Object

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

Constructor Detail

HologramTrait

public HologramTrait()

Method Detail

addLine

public void addLine(String text)

Adds a new hologram line which will displayed over an NPC's head.

Parameters:

text - The new line to add

clear

public void clear()

Clears all hologram lines

getDirection

public HologramTrait.HologramDirection getDirection()

Returns:

The direction that hologram lines are displayed in

getHologramEntities

public Collection<org.bukkit.entity.ArmorStand> getHologramEntities()

Note: this is implementation-specific and may be removed at a later date.

getLineHeight

public double getLineHeight()

Returns:

The line height between each hologram line, in blocks

getLines

public List<String> getLines()

Returns:

the hologram lines, in bottom-up order

getNameEntity

public org.bukkit.entity.ArmorStand getNameEntity()

Note: this is implementation-specific and may be removed at a later date.

onDespawn

public void onDespawn()

Description copied from class: Trait

Called just before the attached NPC is despawned. NPC.getEntity() will be non-null.

Overrides:

onDespawn in class Trait

onRemove

public void onRemove()

Description copied from class: Trait

Called when a trait is removed from the attached NPC.

Overrides:

onRemove in class Trait

onSpawn

public void onSpawn()

Description copied from class: Trait

Called when an NPC is spawned. NPC.getEntity() will return null until this is called. This is also called onAttach when the NPC is already spawned.

Overrides:

onSpawn in class Trait

removeLine

public void removeLine(int idx)

Removes the line at the specified index

Parameters:

idx -

run

public void run()

Description copied from class: Trait

Called every tick if overridden.

Specified by:

run in interface Runnable

Overrides:

run in class Trait

setDirection

public void setDirection(HologramTrait.HologramDirection direction)

Parameters:

direction - The new direction

See Also:

getDirection()

setLine

public void setLine(int idx,
                    String text)

Sets the hologram line at a specific index

Parameters:

idx - The index

text - The new line

setLineHeight

public void setLineHeight(double height)

Sets the line height

Parameters:

height - The line height in blocks

See Also:

getLineHeight()