Package net.citizensnpcs.trait

Class HologramTrait.SingleEntityHologramRenderer

java.lang.Object

net.citizensnpcs.trait.HologramTrait.SingleEntityHologramRenderer

All Implemented Interfaces:

HologramTrait.HologramRenderer

Direct Known Subclasses:

HologramTrait.AreaEffectCloudRenderer, HologramTrait.ArmorstandRenderer, HologramTrait.ArmorstandVehicleRenderer, HologramTrait.InteractionVehicleRenderer, HologramTrait.ItemDisplayRenderer, HologramTrait.ItemRenderer, HologramTrait.TextDisplayRenderer

Enclosing class:

HologramTrait

public abstract static class HologramTrait.SingleEntityHologramRenderer
extends Object
implements HologramTrait.HologramRenderer

A helper class that models a hologram as a single entity that represents a single line in game.

Field Summary

Fields

Modifier and Type	Field	Description
protected NPC	hologram
protected String	text

Constructor Summary

Constructors

Constructor	Description
SingleEntityHologramRenderer()

Method Summary

Modifier and Type	Method	Description
protected abstract NPC	createNPC(NPC base, String text, org.joml.Vector3d offset)
void	destroy()	Destroy/teardown any rendered holograms.
Collection<Entity>	getEntities()	Gets hologram entities associated with the Hologram Trait.
String	getPerPlayerText(NPC npc, Player viewer)	If NPC.Metadata.HOLOGRAM_RENDERER is set on any entity and ProtocolLib is enabled, this method will be called to modify the name per-player.
protected NPCRegistry	registry()
void	render(NPC npc, org.joml.Vector3d offset)	Render the hologram at a given offset.
protected abstract void	render0(NPC npc, org.joml.Vector3d offset)	Hologram spawning is delegated to createNPC(NPC, String, Vector3d)
void	setRegistry(NPCRegistry registry)
void	setViewRange(int range)
protected void	spawnHologram(NPC npc, org.joml.Vector3d offset)
void	updateText(NPC npc, String raw)	Update the hologram text.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.citizensnpcs.trait.HologramTrait.HologramRenderer

isSneaking, onSeenByPlayer, setBackgroundColor, setTextShadow

Field Details

hologram

protected NPC hologram

text

protected String text

Constructor Details

SingleEntityHologramRenderer

public SingleEntityHologramRenderer()

Method Details

createNPC

protected abstract NPC createNPC(NPC base,
 String text,
 org.joml.Vector3d offset)

destroy

public void destroy()

Description copied from interface: HologramTrait.HologramRenderer

Destroy/teardown any rendered holograms.

Specified by:

destroy in interface HologramTrait.HologramRenderer

getEntities

public Collection<Entity> getEntities()

Description copied from interface: HologramTrait.HologramRenderer

Gets hologram entities associated with the Hologram Trait.

Specified by:

getEntities in interface HologramTrait.HologramRenderer

Returns:

Any associated hologram entities.

getPerPlayerText

public String getPerPlayerText(NPC npc,
 Player viewer)

Description copied from interface: HologramTrait.HologramRenderer

If NPC.Metadata.HOLOGRAM_RENDERER is set on any entity and ProtocolLib is enabled, this method will be called to modify the name per-player. Note: this should be async-safe. This method is fragile and may be moved elsewhere.

Specified by:

getPerPlayerText in interface HologramTrait.HologramRenderer

Parameters:

npc - the hologram NPC

viewer - the viewing Player

Returns:

the modified text per Player

registry

protected NPCRegistry registry()

render

public void render(NPC npc,
 org.joml.Vector3d offset)

Description copied from interface: HologramTrait.HologramRenderer

Render the hologram at a given offset. Any underlying hologram NPCs should be spawned at this point.

Specified by:

render in interface HologramTrait.HologramRenderer

Parameters:

npc - the parent NPC.

offset - the offset, in blocks

render0

protected abstract void render0(NPC npc,
 org.joml.Vector3d offset)

Hologram spawning is delegated to createNPC(NPC, String, Vector3d)

setRegistry

public void setRegistry(NPCRegistry registry)

setViewRange

public void setViewRange(int range)

spawnHologram

protected void spawnHologram(NPC npc,
 org.joml.Vector3d offset)

updateText

public void updateText(NPC npc,
 String raw)

Description copied from interface: HologramTrait.HologramRenderer

Update the hologram text. Will be called first before HologramTrait.HologramRenderer.render(NPC, Vector3d).

Specified by:

updateText in interface HologramTrait.HologramRenderer

Parameters:

npc - the parent NPC

raw - the new hologram text