Class DisplayNameComponent

java.lang.Object

com.hypixel.hytale.server.core.modules.entity.component.DisplayNameComponent

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class DisplayNameComponent
extends Object
implements Component<EntityStore>

A component that represents the display name of an entity.

Utilised for logs or kill-feed entries for different entity archetypes.

Field Summary

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
DisplayNameComponent()	Empty Constructor for a DisplayNameComponent instance.
DisplayNameComponent(Message displayName)	Default Constructor for a DisplayNameComponent instance.

Method Summary

Modifier and Type	Method	Description
Component<EntityStore>	clone()
static ComponentType<EntityStore, DisplayNameComponent>	getComponentType()
Message	getDisplayName()

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Constructor Details

DisplayNameComponent

public DisplayNameComponent()

Empty Constructor for a DisplayNameComponent instance.

Used by the codec to parse DisplayNameComponent instances.

DisplayNameComponent

public DisplayNameComponent(@Nullable
 Message displayName)

Default Constructor for a DisplayNameComponent instance.

Parameters:

displayName - The display name to associate with this component.

Method Details

getComponentType

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

Returns:

the component type for the DisplayNameComponent component.

getDisplayName

@Nullable
public Message getDisplayName()

Returns:

the display name of the entity, or null if no display name is set.

clone

@Nullable
public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.