Class Entity

java.lang.Object
net.minestom.server.entity.Entity
All Implemented Interfaces:
Identified, Pointered, Sound.Emitter, HoverEventSource<HoverEvent.ShowEntity>, Shape, DataComponent.Holder, EventHandler<EntityEvent>, Snapshotable, Taggable, TagReadable, TagWritable, AcquirableSource<Entity>, Tickable, Schedulable, Viewable
Direct Known Subclasses:
EntityProjectile, ExperienceOrb, ItemEntity, LivingEntity
public class Entity extends Object implements Viewable, Tickable, Schedulable, Snapshotable, EventHandler<EntityEvent>, Taggable, HoverEventSource<HoverEvent.ShowEntity>, Sound.Emitter, Shape, AcquirableSource<Entity>, DataComponent.Holder, Pointered, Identified
Could be a player, a monster, or an object.

To create your own entity you probably want to extend LivingEntity or EntityCreature instead.

  • Field Details

    • ENTITY_POINTERS_SUPPLIER

      protected static PointersSupplier<Entity> ENTITY_POINTERS_SUPPLIER

    • instance

      protected Instance instance

    • currentChunk

      protected Chunk currentChunk

    • position

      protected Pos position

    • headRotation

      protected float headRotation

    • previousPosition

      protected Pos previousPosition

    • lastSyncedPosition

      protected Pos lastSyncedPosition

    • onGround

      protected boolean onGround

    • boundingBox

      protected BoundingBox boundingBox

    • vehicle

      protected Entity vehicle

    • velocity

      protected Vec velocity

    • lastVelocityWasZero

      protected boolean lastVelocityWasZero

    • hasPhysics

      protected boolean hasPhysics

    • collidesWithEntities

      protected boolean collidesWithEntities

    • preventBlockPlacement

      protected boolean preventBlockPlacement

    • gravityTickCount

      protected int gravityTickCount

    • trackingUpdate

      protected final EntityTracker.Update<Entity> trackingUpdate

    • viewEngine

      protected final net.minestom.server.entity.EntityView viewEngine

    • viewers

      protected final Set<Player> viewers

    • removed

      protected boolean removed

    • entityType

      protected EntityType entityType

    • metadata

      protected MetadataHolder metadata

    • entityMeta

      protected EntityMeta entityMeta

  • Constructor Details

  • Method Details

    • setPositionInternal

      protected void setPositionInternal(Pos newPosition, float headRotation)

    • scheduleNextTick

      public void scheduleNextTick(Consumer<Entity> callback)
      Schedules a task to be run during the next entity tick.
      Parameters:
      callback - the task to execute during the next entity tick

    • generateId

      public static int generateId()
      Generate and return a new unique entity id.

      Useful if you want to spawn entities using packet but don't risk to have duplicated id.

      Returns:
      a newly generated entity id

    • update

      public void update(long time)
      Called each tick.
      Parameters:
      time - time of the update in milliseconds. This may only be used as a delta and has no meaning in the real world

    • spawn

      public void spawn()
      Called when a new instance is set.

    • despawn

      protected void despawn()
      Called right before an entity is removed

    • isOnGround

      public boolean isOnGround()

    • getEntityMeta

      public EntityMeta getEntityMeta()
      Gets metadata of this entity. You may want to cast it to specific implementation.
      Returns:
      metadata of this entity.

    • get

      @Nullable public <T> T get(DataComponent<T> component)
      Specified by:
      get in interface DataComponent.Holder

    • set

      public <T> void set(DataComponent<T> component, T value)

    • editEntityMeta

      public <TMeta extends EntityMeta> void editEntityMeta(Class<TMeta> metaClass, Consumer<TMeta> editor)
      Do a batch edit of this entity's metadata.

    • teleport

      public CompletableFuture<Void> teleport(Pos position)

    • teleport

      public CompletableFuture<Void> teleport(Pos position, Vec velocity)

    • teleport

      public CompletableFuture<Void> teleport(Pos position, long @Nullable [] chunks, @MagicConstant(flagsFromClass=RelativeFlags.class) int flags)

    • teleport

      public CompletableFuture<Void> teleport(Pos position, Vec velocity, long @Nullable [] chunks, @MagicConstant(flagsFromClass=RelativeFlags.class) int flags)

    • teleport

      public CompletableFuture<Void> teleport(Pos position, long @Nullable [] chunks, @MagicConstant(flagsFromClass=RelativeFlags.class) int flags, boolean shouldConfirm)

    • teleport

      public CompletableFuture<Void> teleport(Pos position, Vec velocity, long @Nullable [] chunks, @MagicConstant(flagsFromClass=RelativeFlags.class) int flags, boolean shouldConfirm)
      Teleports the entity only if the chunk at position is loaded or if Instance.hasEnabledAutoChunkLoad() returns true.
      Parameters:
      position - the teleport position
      chunks - the chunk indexes to load before teleporting the entity, indexes are from CoordConversion.chunkIndex(int, int), can be null or empty to only load the chunk at position
      flags - flags used to teleport the entity relatively rather than absolutely use RelativeFlags to see available flags
      shouldConfirm - if false, the teleportation will be done without confirmation
      Throws:
      IllegalStateException - if you try to teleport an entity before settings its instance

    • setView

      public void setView(float yaw, float pitch)
      Changes the view of the entity. The head rotation will be updated to the yaw value.
      Parameters:
      yaw - the new yaw
      pitch - the new pitch

    • setView

      public void setView(float yaw, float pitch, float headRotation)
      Changes the view and head rotation of the entity. This is only really useful for mobs whose heads are looking in a different direction than their body.

      The client has a lot of prediction on this front, so using your own logic for this might not produce the desired result. For example: if the entity is not moving, the body will automatically rotate towards the head after a few ticks.

      Parameters:
      yaw - the new yaw
      pitch - the new pitch
      headRotation - the new head rotation

    • lookAt

      public void lookAt(Point point)
      Changes the view of the entity so that it looks in a direction to the given position if it is different from the entity's current position.
      Parameters:
      point - the point to look at.

    • lookAt

      public void lookAt(Entity entity)
      Changes the view of the entity so that it looks in a direction to the given entity.
      Parameters:
      entity - the entity to look at.
      Throws:
      IllegalArgumentException - if the entities are not in the same instance

    • isAutoViewable

      public boolean isAutoViewable()
      Gets if this entity is automatically sent to surrounding players. True by default.
      Returns:
      true if the entity is automatically viewable for close players, false otherwise

    • setAutoViewable

      public void setAutoViewable(boolean autoViewable)
      Decides if this entity should be auto-viewable by nearby players.
      Parameters:
      autoViewable - true to add surrounding players, false to remove
      See Also:

    • updateViewableRule

      public void updateViewableRule(@Nullable @Nullable Predicate<Player> predicate)

    • updateViewableRule

      public void updateViewableRule()

    • autoViewEntities

      public boolean autoViewEntities()
      Gets if surrounding entities are automatically visible by this. True by default.
      Returns:
      true if surrounding entities are visible by this

    • setAutoViewEntities

      public void setAutoViewEntities(boolean autoViewer)
      Decides if surrounding entities must be visible.
      Parameters:
      autoViewer - true to add view surrounding entities, false to remove

    • updateViewerRule

      public void updateViewerRule(@Nullable @Nullable Predicate<Entity> predicate)

    • updateViewerRule

      public void updateViewerRule()

    • addViewer

      public final boolean addViewer(Player player)
      Description copied from interface: Viewable
      Adds a viewer.
      Specified by:
      addViewer in interface Viewable
      Parameters:
      player - the viewer to add
      Returns:
      true if the player has been added, false otherwise (could be because he is already a viewer)

    • removeViewer

      public final boolean removeViewer(Player player)
      Description copied from interface: Viewable
      Removes a viewer.
      Specified by:
      removeViewer in interface Viewable
      Parameters:
      player - the viewer to remove
      Returns:
      true if the player has been removed, false otherwise (could be because he was not a viewer)

    • updateNewViewer

      @Internal public void updateNewViewer(Player player)
      Called when a new viewer must be shown. Method can be subject to deadlocking if the target's viewers are also accessed.
      Parameters:
      player - the player to send the packets to

    • updateOldViewer

      @Internal public void updateOldViewer(Player player)
      Called when a viewer must be destroyed. Method can be subject to deadlocking if the target's viewers are also accessed.
      Parameters:
      player - the player to send the packets to

    • getViewers

      public Set<Player> getViewers()
      Description copied from interface: Viewable
      Gets all the viewers of this viewable element.
      Specified by:
      getViewers in interface Viewable
      Returns:
      A Set containing all the element's viewers

    • hasPredictableViewers

      public boolean hasPredictableViewers()
      Gets if this entity's viewers (surrounding players) can be predicted from surrounding chunks.

    • switchEntityType

      public void switchEntityType(EntityType entityType)
      Changes the entity type of this entity.

      Works by changing the internal entity type field and by calling removeViewer(Player) followed by addViewer(Player) to all current viewers.

      Be aware that this only change the visual of the entity, the BoundingBox will not be modified.

      Parameters:
      entityType - the new entity type

    • tick

      public void tick(long time)
      Updates the entity, called every tick.

      Ignored if getInstance() returns null.

      Specified by:
      tick in interface Tickable
      Parameters:
      time - the update time in milliseconds. This may only be used as a delta and has no meaning in the real world.

    • movementTick

      @Internal protected void movementTick()

    • getAliveTicks

      public long getAliveTicks()
      Gets the number of ticks this entity has been active for.
      Returns:
      the number of ticks this entity has been active for

    • getEntityId

      public int getEntityId()
      Each entity has an unique id (server-wide) which will change after a restart.
      Returns:
      the unique entity id
      See Also:

    • getEntityType

      public EntityType getEntityType()
      Returns the entity type.
      Returns:
      the entity type

    • getUuid

      public UUID getUuid()
      Gets the entity UUID.
      Returns:
      the entity unique id

    • isActive

      public boolean isActive()
      Returns false just after instantiation, set to true after calling setInstance(Instance).
      Returns:
      true if the entity has been linked to an instance, false otherwise

    • getBoundingBox

      public BoundingBox getBoundingBox()
      Returns the current bounding box (based on pose). Is used to check collision with coordinates or other blocks/entities.
      Returns:
      the entity bounding box

    • setBoundingBox

      public void setBoundingBox(double width, double height, double depth)
      Changes the internal entity standing bounding box. When the pose is not standing, a different bounding box may be used for collision.

      WARNING: this does not change the entity hit-box which is client-side.

      Parameters:
      width - the bounding box X size
      height - the bounding box Y size
      depth - the bounding box Z size

    • setBoundingBox

      public void setBoundingBox(BoundingBox boundingBox)
      Changes the internal entity standing bounding box. When the pose is not standing, a different bounding box may be used for collision.

      WARNING: this does not change the entity hit-box which is client-side.

      Parameters:
      boundingBox - the new bounding box

    • getChunk

      @Nullable public @Nullable Chunk getChunk()
      Convenient method to get the entity current chunk.
      Returns:
      the entity chunk, can be null even if unlikely

    • refreshCurrentChunk

      @Internal protected void refreshCurrentChunk(Chunk currentChunk)

    • getInstance

      public @UnknownNullability Instance getInstance()
      Gets the entity current instance.
      Returns:
      the entity instance, can be null if the entity doesn't have an instance yet

    • setInstance

      public CompletableFuture<Void> setInstance(Instance instance, Pos spawnPosition)
      Changes the entity instance, i.e. spawns it.
      Parameters:
      instance - the new instance of the entity
      spawnPosition - the spawn position for the entity.
      Returns:
      a CompletableFuture called once the entity's instance has been set, this is due to chunks needing to load
      Throws:
      IllegalStateException - if instance has not been registered in InstanceManager

    • setInstance

      public CompletableFuture<Void> setInstance(Instance instance, Point spawnPosition)

    • setInstance

      public CompletableFuture<Void> setInstance(Instance instance)
      Changes the entity instance.
      Parameters:
      instance - the new instance of the entity
      Returns:
      a CompletableFuture called once the entity's instance has been set, this is due to chunks needing to load
      Throws:
      NullPointerException - if instance is null
      IllegalStateException - if instance has not been registered in InstanceManager

    • getVelocity

      public Vec getVelocity()
      Gets the entity current velocity.
      Returns:
      the entity current velocity

    • setVelocity

      public void setVelocity(Vec velocity)
      Changes the entity velocity and calls EntityVelocityEvent.

      The final velocity can be cancelled or modified by the event.

      Parameters:
      velocity - the new entity velocity

    • hasVelocity

      public boolean hasVelocity()
      Gets if the entity currently has a velocity applied.
      Returns:
      true if the entity is moving

    • getAerodynamics

      public Aerodynamics getAerodynamics()
      Gets the aerodynamics; how the entity behaves in the air.
      Returns:
      the aerodynamic properties this entity is using

    • setAerodynamics

      public void setAerodynamics(Aerodynamics aerodynamics)
      Sets the aerodynamics; how the entity behaves in the air.
      Parameters:
      aerodynamics - the new aerodynamic properties

    • getGravityTickCount

      public int getGravityTickCount()
      Gets the number of tick this entity has been applied gravity.
      Returns:
      the number of tick of which gravity has been consequently applied

    • getDistance

      public double getDistance(Point point)

    • getDistance

      public double getDistance(Entity entity)
      Gets the distance between two entities.
      Parameters:
      entity - the entity to get the distance from
      Returns:
      the distance between this and entity

    • getDistanceSquared

      public double getDistanceSquared(Point point)

    • getDistanceSquared

      public double getDistanceSquared(Entity entity)
      Gets the distance squared between two entities.
      Parameters:
      entity - the entity to get the distance from
      Returns:
      the distance squared between this and entity

    • getVehicle

      @Nullable public @Nullable Entity getVehicle()
      Gets the entity vehicle or null.
      Returns:
      the entity vehicle, or null if there is not any

    • addPassenger

      public void addPassenger(Entity entity)
      Adds a new passenger to this entity.
      Parameters:
      entity - the new passenger
      Throws:
      NullPointerException - if entity is null
      IllegalStateException - if getInstance() returns null or the passenger cannot be added

    • removePassenger

      public void removePassenger(Entity entity)
      Removes a passenger to this entity.
      Parameters:
      entity - the passenger to remove
      Throws:
      NullPointerException - if entity is null
      IllegalStateException - if getInstance() returns null

    • hasPassenger

      public boolean hasPassenger()
      Gets if the entity has any passenger.
      Returns:
      true if the entity has any passenger, false otherwise

    • getPassengers

      public Set<Entity> getPassengers()
      Gets the entity passengers.
      Returns:
      an unmodifiable list containing all the entity passengers

    • getPassengersPacket

      protected SetPassengersPacket getPassengersPacket()

    • getLeashedEntities

      public Set<Entity> getLeashedEntities()
      Gets the entities that this entity is leashing.
      Returns:
      an unmodifiable list containing all the leashed entities

    • getLeashHolder

      @Nullable public @Nullable Entity getLeashHolder()
      Gets the current leash holder.
      Returns:
      the entity leashing this entity, null if no leash holder

    • setLeashHolder

      public void setLeashHolder(@Nullable @Nullable Entity entity)
      Sets the leash holder to this entity.
      Parameters:
      entity - the new leash holder

    • getAttachEntityPacket

      protected AttachEntityPacket getAttachEntityPacket()

    • triggerStatus

      public void triggerStatus(byte status)
      Entity statuses can be found here.
      Parameters:
      status - the status to trigger

    • isOnFire

      public boolean isOnFire()
      Gets if the entity is on fire.
      Returns:
      true if the entity is in fire, false otherwise

    • isSneaking

      public boolean isSneaking()
      Gets if the entity is sneaking.

      WARNING: this can be bypassed by hacked client, this is only what the client told the server.

      Returns:
      true if the player is sneaking

    • setSneaking

      public void setSneaking(boolean sneaking)
      Makes the entity sneak.

      WARNING: this will not work for the client itself.

      Parameters:
      sneaking - true to make the entity sneak

    • isSprinting

      public boolean isSprinting()
      Gets if the player is sprinting.

      WARNING: this can be bypassed by hacked client, this is only what the client told the server.

      Returns:
      true if the player is sprinting

    • setSprinting

      public void setSprinting(boolean sprinting)
      Makes the entity sprint.

      WARNING: this will not work on the client itself.

      Parameters:
      sprinting - true to make the entity sprint

    • isInvisible

      public boolean isInvisible()
      Gets if the entity is invisible or not.
      Returns:
      true if the entity is invisible, false otherwise

    • setInvisible

      public void setInvisible(boolean invisible)
      Changes the internal invisible value and send a EntityMetaDataPacket to make visible or invisible the entity to its viewers.
      Parameters:
      invisible - true to set the entity invisible, false otherwise

    • isGlowing

      public boolean isGlowing()
      Gets if the entity is glowing or not.
      Returns:
      true if the entity is glowing, false otherwise

    • setGlowing

      public void setGlowing(boolean glowing)
      Sets or remove the entity glowing effect.
      Parameters:
      glowing - true to make the entity glows, false otherwise

    • getPose

      public EntityPose getPose()
      Gets the current entity pose.
      Returns:
      the entity pose

    • setPose

      public void setPose(EntityPose pose)
      Changes the entity pose.

      The internal crouched and swimming field will be updated accordingly.

      Parameters:
      pose - the new entity pose

    • updatePose

      protected void updatePose()

    • getCustomName

      @Deprecated @Nullable public @Nullable Component getCustomName()
      Deprecated.
      use DataComponents.CUSTOM_NAME instead.
      Gets the entity custom name.
      Returns:
      the custom name of the entity, null if there is not

    • setCustomName

      @Deprecated public void setCustomName(@Nullable @Nullable Component customName)
      Deprecated.
      use DataComponents.CUSTOM_NAME instead.
      Changes the entity custom name.
      Parameters:
      customName - the custom name of the entity, null to remove it

    • isCustomNameVisible

      public boolean isCustomNameVisible()
      Gets the custom name visible metadata field.
      Returns:
      true if the custom name is visible, false otherwise

    • setCustomNameVisible

      public void setCustomNameVisible(boolean customNameVisible)
      Changes the internal custom name visible field and send a EntityMetaDataPacket to update the entity state to its viewers.
      Parameters:
      customNameVisible - true to make the custom name visible, false otherwise

    • isSilent

      public boolean isSilent()

    • setSilent

      public void setSilent(boolean silent)

    • hasNoGravity

      public boolean hasNoGravity()
      Gets the noGravity metadata field.
      Returns:
      true if the entity ignore gravity, false otherwise

    • setNoGravity

      public void setNoGravity(boolean noGravity)
      Changes the noGravity metadata field and change the gravity behaviour accordingly.
      Parameters:
      noGravity - should the entity ignore gravity

    • refreshPosition

      @Internal public void refreshPosition(Pos newPosition, boolean ignoreView, boolean sendPackets)
      Updates internal fields and sends updates.
      Parameters:
      newPosition - the new position

    • refreshPosition

      @Internal public void refreshPosition(Pos newPosition, boolean ignoreView)

    • refreshPosition

      @Internal public void refreshPosition(Pos newPosition)

    • refreshCoordinate

      @Internal protected void refreshCoordinate(Point newPosition)
      Used to refresh the entity and its passengers position - put the entity in the right instance chunk - update the viewable chunks (load and unload) - add/remove players from the viewers list if isAutoViewable() is enabled

      WARNING: unsafe, should only be used internally in Minestom. Use teleport(Pos) instead.

      Parameters:
      newPosition - the new position

    • getPosition

      public Pos getPosition()
      Gets the entity position.
      Returns:
      the current position of the entity

    • getHeadRotation

      public float getHeadRotation()
      Gets the entity head rotation. In most cases, this will be the same as their yaw. It might be different for mobs which are looking in a different direction than their body.

      The head rotation can be changed using setView(float, float, float).

      Returns:
      the head rotation

    • getPreviousPosition

      public Pos getPreviousPosition()
      Gets the previous entity position.
      Returns:
      the previous position of the entity

    • getEyeHeight

      public double getEyeHeight()
      Gets the entity eye height.
      Returns:
      the entity eye height

    • getActiveEffects

      public List<TimedPotion> getActiveEffects()
      Gets all the potion effect of this entity.
      Returns:
      an unmodifiable list of all this entity effects

    • addEffect

      public void addEffect(Potion potion)
      Adds an effect to an entity.
      Parameters:
      potion - The potion to add

    • removeEffect

      public void removeEffect(PotionEffect effect)
      Removes effect from entity, if it has it.
      Parameters:
      effect - The effect to remove

    • hasEffect

      public boolean hasEffect(PotionEffect effect)
      If the entity has the specified effect.
      Parameters:
      effect - the effect to check

    • getEffect

      @Nullable public @Nullable TimedPotion getEffect(PotionEffect effect)
      Gets the TimedPotion of the specified effect.
      Parameters:
      effect - the effect type
      Returns:
      the effect, null if not found

    • getEffectLevel

      public int getEffectLevel(PotionEffect effect)
      Gets the level of the specified effect.
      Parameters:
      effect - the effect type
      Returns:
      the effect level, -1 if not found

    • clearEffects

      public void clearEffects()
      Removes all the effects currently applied to the entity.

    • remove

      public void remove()
      Removes the entity from the server immediately.

      WARNING: this does not trigger EntityDeathEvent.

    • remove

      protected void remove(boolean permanent)

    • isRemoved

      public boolean isRemoved()
      Gets if this entity has been removed.
      Returns:
      true if this entity is removed

    • scheduleRemove

      public void scheduleRemove(long delay, TemporalUnit temporalUnit)
      Triggers remove() after the specified time.
      Parameters:
      delay - the time before removing the entity, 0 to cancel the removing
      temporalUnit - the unit of the delay

    • scheduleRemove

      public void scheduleRemove(Duration delay)
      Triggers remove() after the specified time.
      Parameters:
      delay - the time before removing the entity

    • getVelocityForPacket

      protected Vec getVelocityForPacket()

    • getSpawnPacket

      protected SpawnEntityPacket getSpawnPacket()

    • getVelocityPacket

      protected EntityVelocityPacket getVelocityPacket()

    • getMetadataPacket

      public EntityMetaDataPacket getMetadataPacket()
      Gets an EntityMetaDataPacket sent when adding viewers. Used for synchronization.
      Returns:
      The EntityMetaDataPacket related to this entity

    • synchronizePosition

      @Internal protected void synchronizePosition()
      Used to synchronize entity position with viewers by sending a full EntityPositionSyncPacket to viewers.

    • synchronizeNextTick

      public void synchronizeNextTick()
      Asks for a position synchronization to happen during next entity tick.

    • getSynchronizationTicks

      public long getSynchronizationTicks()
      Returns the current synchronization interval. The default value is ServerFlag.ENTITY_SYNCHRONIZATION_TICKS but can be overridden per entity with setSynchronizationTicks(long).
      Returns:
      The current synchronization ticks

    • setSynchronizationTicks

      public void setSynchronizationTicks(long ticks)
      Set the tick period until this entity's position is synchronized.
      Parameters:
      ticks - the new synchronization tick period

    • asHoverEvent

      public HoverEvent<HoverEvent.ShowEntity> asHoverEvent(UnaryOperator<HoverEvent.ShowEntity> op)
      Specified by:
      asHoverEvent in interface HoverEventSource<HoverEvent.ShowEntity>

    • tagHandler

      public TagHandler tagHandler()
      Specified by:
      tagHandler in interface Taggable

    • scheduler

      public Scheduler scheduler()
      Specified by:
      scheduler in interface Schedulable

    • updateSnapshot

      public EntitySnapshot updateSnapshot(SnapshotUpdater updater)
      Description copied from interface: Snapshotable
      Updates the currently cached snapshot if required. The updater can be used to retrieve references to other snapshots while avoiding circular dependency. Be careful to do not store updater anywhere as its data will change when building requested references.

      This method is not thread-safe, and targeted at internal use since its execution rely on safe-points (e.g. end of ticks)

      Specified by:
      updateSnapshot in interface Snapshotable
      Parameters:
      updater - the snapshot updater/context
      Returns:
      the updated snapshot

    • eventNode

      public EventNode<EntityEvent> eventNode()
      Specified by:
      eventNode in interface EventHandler<EntityEvent>

    • takeKnockback

      public void takeKnockback(float strength, double x, double z)
      Applies knockback to the entity
      Parameters:
      strength - the strength of the knockback, 0.4 is the vanilla value for a bare hand hit
      x - knockback on x axle, for default knockback use the following formula 
      sin(attacker.yaw * (pi/180))
      z - knockback on z axle, for default knockback use the following formula 
      -cos(attacker.yaw * (pi/180))

    • getLineOfSight

      public List<Point> getLineOfSight(int maxDistance)
      Gets the line of sight of the entity.
      Parameters:
      maxDistance - The max distance to scan
      Returns:
      A list of points in this entities line of sight

    • hasLineOfSight

      public boolean hasLineOfSight(Entity entity, boolean exactView)
      Raycasts current entity's eye position to target eye position.
      Parameters:
      entity - the entity to be checked.
      exactView - if set to TRUE, checks whether target is IN the line of sight of the current one; otherwise checks if the current entity can rotate so that target will be in its line of sight.
      Returns:
      true if the ray reaches the target bounding box before hitting a block.

    • hasLineOfSight

      public boolean hasLineOfSight(Entity entity)
      Parameters:
      entity - the entity to be checked.
      Returns:
      if the current entity has line of sight to the given one.
      See Also:

    • getLineOfSightEntity

      @Nullable public @Nullable Entity getLineOfSightEntity(double range, Predicate<Entity> predicate)
      Gets first entity on the line of sight of the current one that matches the given predicate.
      Parameters:
      range - max length of the line of sight of the current entity to be checked.
      predicate - optional predicate
      Returns:
      resulting entity whether there're any, null otherwise.

    • isOccluded

      public boolean isOccluded(Shape shape, BlockFace face)
      Specified by:
      isOccluded in interface Shape

    • intersectBox

      public boolean intersectBox(Point positionRelative, BoundingBox boundingBox)
      Description copied from interface: Shape
      Checks if two bounding boxes intersect.
      Specified by:
      intersectBox in interface Shape
      Parameters:
      positionRelative - Relative position of bounding box to check with
      boundingBox - Bounding box to check for intersections with
      Returns:
      is an intersection found

    • intersectBoxSwept

      public boolean intersectBoxSwept(Point rayStart, Point rayDirection, Point shapePos, BoundingBox moving, SweepResult finalResult)
      Description copied from interface: Shape
      Checks if a moving bounding box will hit this shape.
      Specified by:
      intersectBoxSwept in interface Shape
      Parameters:
      rayStart - Position of the moving shape
      rayDirection - Movement vector
      shapePos - Position of this shape
      moving - Bounding Box of moving shape
      finalResult - Stores final SweepResult
      Returns:
      is an intersection found

    • relativeStart

      public Point relativeStart()
      Description copied from interface: Shape
      Relative Start
      Specified by:
      relativeStart in interface Shape
      Returns:
      Start of shape

    • relativeEnd

      public Point relativeEnd()
      Description copied from interface: Shape
      Relative End
      Specified by:
      relativeEnd in interface Shape
      Returns:
      End of shape

    • hasEntityCollision

      public boolean hasEntityCollision()

    • preventBlockPlacement

      public boolean preventBlockPlacement()

    • updateCollisions

      protected void updateCollisions()

    • getAcquirable

      @Deprecated @Experimental public <T extends Entity> Acquirable<T> getAcquirable()
      Deprecated.
      It's preferred to use AcquirableSource.acquirable() instead, as it is overridden by subclasses
      Acquires this entity.
      Type Parameters:
      T - the type of object to be acquired
      Returns:
      the acquirable for this entity

    • acquirable

      @Experimental public Acquirable<? extends Entity> acquirable()
      Description copied from interface: AcquirableSource
      Obtains an Acquirable. To safely perform operations on this object, the user must call Acquirable.sync(Consumer), Acquirable.applySync(Function), or Acquirable.lock() (followed by a subsequent unlock) on the Acquirable instance.
      Specified by:
      acquirable in interface AcquirableSource<Entity>
      Returns:
      an Acquirable which can be used to synchronize access to this object

    • identity

      @Contract(pure=true) public Identity identity()
      Specified by:
      identity in interface Identified

    • pointers

      @Contract(pure=true) public Pointers pointers()
      Specified by:
      pointers in interface Pointered