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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract NPCvoiddestroy()Destroy/teardown any rendered holograms.getPerPlayerText(NPC npc, Player viewer) Ifis set on any entity and ProtocolLib is enabled, this method will be called to modify the name per-player.invalid reference
NPC.Metadata.HOLOGRAM_RENDERERprotected NPCRegistryregistry()voidRender the hologram at a given offset.protected abstract voidHologram spawning is delegated toinvalid reference
#createNPC(Entity, String, Vector3d)voidsetRegistry(NPCRegistry registry) voidsetViewRange(int range) protected voidspawnHologram(NPC npc, org.joml.Vector3d offset) voidupdateText(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, waitMethods inherited from interface net.citizensnpcs.trait.HologramTrait.HologramRenderer
isSneaking, onSeenByPlayer, setBackgroundColor, setTextShadow
-
Field Details
-
hologram
-
text
-
-
Constructor Details
-
SingleEntityHologramRenderer
public SingleEntityHologramRenderer()
-
-
Method Details
-
createNPC
-
destroy
public void destroy()Description copied from interface:HologramTrait.HologramRendererDestroy/teardown any rendered holograms.- Specified by:
destroyin interfaceHologramTrait.HologramRenderer
-
getEntities
- Specified by:
getEntitiesin interfaceHologramTrait.HologramRenderer- Returns:
- Any associated hologram entities. Used in
HologramTrait.HologramRenderer.getEntities().
-
getPerPlayerText
Description copied from interface:HologramTrait.HologramRendererIfis 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.invalid reference
NPC.Metadata.HOLOGRAM_RENDERER- Specified by:
getPerPlayerTextin interfaceHologramTrait.HologramRenderer- Parameters:
npc- the hologram NPCviewer- the viewing Player- Returns:
- the modified text per Player
-
registry
-
render
Description copied from interface:HologramTrait.HologramRendererRender the hologram at a given offset. Any underlying hologram NPCs should be spawned at this point.- Specified by:
renderin interfaceHologramTrait.HologramRenderer- Parameters:
npc- the parent NPC.offset- the offset, in blocks
-
render0
Hologram spawning is delegated toinvalid reference
#createNPC(Entity, String, Vector3d) -
setRegistry
-
setViewRange
public void setViewRange(int range) -
spawnHologram
-
updateText
Description copied from interface:HologramTrait.HologramRendererUpdate the hologram text. Will be called first beforeHologramTrait.HologramRenderer.render(NPC, Vector3d).- Specified by:
updateTextin interfaceHologramTrait.HologramRenderer- Parameters:
npc- the parent NPCraw- the new hologram text
-