Class Entity

java.lang.Object
com.hypixel.hytale.server.core.entity.Entity
All Implemented Interfaces:
Component<EntityStore>, Cloneable
Direct Known Subclasses:
LegacySpawnBeaconEntity, LivingEntity, PatrolPathMarkerEntity, SpawnBeacon
public abstract class Entity extends Object implements Component<EntityStore>
A class that represents a generic entity in the game world.

  • Field Details

    • LOGGER

      @Nonnull public static final HytaleLogger LOGGER
      The logger for this class.

    • VERSION

      public static final int VERSION
      The current version of the entity codec.
      See Also:

    • DISPLAY_NAME

      @Nonnull public static final KeyedCodec<String> DISPLAY_NAME
      The legacy display name codec for the entities.

    • UUID

      @Nonnull public static final KeyedCodec<UUID> UUID
      The legacy UUID codec for the entities.

    • CODEC

      @Nonnull public static final BuilderCodec<Entity> CODEC
      The codec used to parse Entity instances.

    • UNASSIGNED_ID

      public static final int UNASSIGNED_ID
      An unassigned network ID constant.
      See Also:

  • Constructor Details

    • Entity

      @Deprecated public Entity(@Nullable World world)
      Deprecated.
      Default Constructor for an Entity instance.
      Parameters:
      world - The world that this entity is in, or null if not in a world.

    • Entity

      public Entity()
      Empty Constructor for an Entity instance.

      Used by the codec to instantiate Entity instances.

  • Method Details

    • markNeedsSave

      @Deprecated(forRemoval=true) public void markNeedsSave()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use Dirty.markDirty() instead.
      Marks the chunk containing this entity as needing to be saved.

    • setLegacyUUID

      public void setLegacyUUID(@Nullable UUID uuid)
      Called to set the legacy UUID of this entity.
      Parameters:
      uuid - The legacy UUID to set.

    • remove

      public boolean remove()
      Called to remove this entity from the world.
      Returns:
      true if the entity was removed, false if it was already removed.

    • loadIntoWorld

      public void loadIntoWorld(@Nonnull World world)
      Called to load the entity into the given world.
      Parameters:
      world - The world to load the entity into.

    • unloadFromWorld

      public void unloadFromWorld()
      Called to unload the entity from its current world.

    • getNetworkId

      @Deprecated(forRemoval=true) public int getNetworkId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Access the network ID via the NetworkId component.
      Returns:
      the network ID of this entity.

    • getLegacyDisplayName

      @Deprecated(forRemoval=true) public String getLegacyDisplayName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Access the display name via the DisplayNameComponent component.
      Returns:
      the display name of the entity, or null if no display name is set.

    • getUuid

      @Nullable @Deprecated(forRemoval=true) public UUID getUuid()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Access the UUID via the UUIDComponent component.
      Returns:
      the legacy UUID of this entity.

    • moveTo

      @Deprecated public void moveTo(@Nonnull Ref<EntityStore> ref, double locX, double locY, double locZ, @Nonnull ComponentAccessor<EntityStore> componentAccessor)
      Deprecated.
      Use TransformComponent directly
      Parameters:
      ref - The entity reference of this entity.
      locX - The X coordinate to move to.
      locY - The Y coordinate to move to.
      locZ - The Z coordinate to move to.
      componentAccessor - The ComponentAccessor<EntityStore> for component access.

    • getWorld

      @Nullable public World getWorld()
      Returns:
      the world that this entity is in, or null if not in a world.

    • wasRemoved

      public boolean wasRemoved()
      Returns:
      true if this entity was removed, false otherwise.

    • isCollidable

      public boolean isCollidable()
      Returns:
      true if this entity is collidable, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • isHiddenFromLivingEntity

      public boolean isHiddenFromLivingEntity(@Nonnull Ref<EntityStore> ref, @Nonnull Ref<EntityStore> targetRef, @Nonnull ComponentAccessor<EntityStore> componentAccessor)
      Determines whether this entity is hidden from the given target entity
      Parameters:
      ref - The entity reference of this entity
      targetRef - The entity reference of the target entity
      componentAccessor - The ComponentAccessor for component access
      Returns:
      true if they are hidden from the target entity, false otherwise

    • setReference

      public void setReference(@Nonnull Ref<EntityStore> reference)
      Called to set the entity reference associated with this entity.
      Parameters:
      reference - The entity reference to set.

    • getReference

      @Nullable public Ref<EntityStore> getReference()
      Returns:
      the entity reference of this entity.

    • clearReference

      @Deprecated public void clearReference()
      Deprecated.
      Called to clear the entity reference associated with this entity.

    • clone

      public Component<EntityStore> clone()
      Specified by:
      clone in interface Component<EntityStore>
      Returns:
      a clone instance of the original component instance.

    • toHolder

      public Holder<EntityStore> toHolder()
      Called to convert and return this entity as an entity holder.
      Returns:
      the entity holder representation of this entity.