Class DisplayNameSupport

java.lang.Object

com.hypixel.hytale.server.npc.role.support.DisplayNameSupport

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class DisplayNameSupport
extends Object
implements Component<EntityStore>

ECS component owning display-name state for the NPC entity.

Field Summary

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
DisplayNameSupport()

Method Summary

Modifier and Type	Method	Description
Component<EntityStore>	clone()
static DisplayNameSupport	get(Ref<EntityStore> ref, ComponentAccessor<EntityStore> accessor)
static ComponentType<EntityStore, DisplayNameSupport>	getComponentType()
String[]	getDisplayNames()
void	handleNominatedDisplayName(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)	Apply any nominated display name to the entity (deferred from a prior tick) and clear the nomination.
void	nominateDisplayName(String displayName)
void	pickRandomDisplayName(Holder<EntityStore> holder, boolean override)
void	pickRandomDisplayName(Ref<EntityStore> ref, boolean override, ComponentAccessor<EntityStore> componentAccessor)
static void	setDisplayName(Holder<EntityStore> holder, String displayName)
static void	setDisplayName(Holder<EntityStore> holder, String displayName, boolean override)
static void	setDisplayName(Ref<EntityStore> ref, String displayName, boolean override, ComponentAccessor<EntityStore> componentAccessor)
static void	setDisplayName(Ref<EntityStore> ref, String displayName, ComponentAccessor<EntityStore> componentAccessor)
void	setDisplayNames(String[] displayNames)	Initialize the candidate display-name pool.
static void	setRandomDisplayName(Holder<EntityStore> holder, String[] names, boolean override)
static void	setRandomDisplayName(Ref<EntityStore> ref, String[] names, boolean override, ComponentAccessor<EntityStore> componentAccessor)

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Constructor Details

DisplayNameSupport

public DisplayNameSupport()

Method Details

getComponentType

@Nonnull
public static ComponentType<EntityStore, DisplayNameSupport> getComponentType()

get

@Nonnull
public static DisplayNameSupport get(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> accessor)

setDisplayNames

public void setDisplayNames(@Nullable
 String[] displayNames)

Initialize the candidate display-name pool. Called once from Role.createAndAttach.

getDisplayNames

@Nullable
public String[] getDisplayNames()

nominateDisplayName

public void nominateDisplayName(@Nonnull
 String displayName)

handleNominatedDisplayName

public void handleNominatedDisplayName(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Apply any nominated display name to the entity (deferred from a prior tick) and clear the nomination. No-op if nothing was nominated.

pickRandomDisplayName

public void pickRandomDisplayName(@Nonnull
 Holder<EntityStore> holder,
 boolean override)

pickRandomDisplayName

public void pickRandomDisplayName(@Nonnull
 Ref<EntityStore> ref,
 boolean override,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

setDisplayName

public static void setDisplayName(@Nonnull
 Holder<EntityStore> holder,
 @Nonnull
 String displayName)

setDisplayName

public static void setDisplayName(@Nonnull
 Holder<EntityStore> holder,
 @Nullable
 String displayName,
 boolean override)

setRandomDisplayName

public static void setRandomDisplayName(@Nonnull
 Ref<EntityStore> ref,
 @Nullable
 String[] names,
 boolean override,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

setRandomDisplayName

public static void setRandomDisplayName(@Nonnull
 Holder<EntityStore> holder,
 @Nullable
 String[] names,
 boolean override)

setDisplayName

public static void setDisplayName(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 String displayName,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

setDisplayName

public static void setDisplayName(@Nonnull
 Ref<EntityStore> ref,
 @Nullable
 String displayName,
 boolean override,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

clone

public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.