mirror of https://github.com/Minestom/Minestom.git
1511 lines
49 KiB
Java
1511 lines
49 KiB
Java
package net.minestom.server.entity;
|
|
|
|
import com.google.common.collect.Queues;
|
|
import net.minestom.server.MinecraftServer;
|
|
import net.minestom.server.Viewable;
|
|
import net.minestom.server.chat.JsonMessage;
|
|
import net.minestom.server.collision.BoundingBox;
|
|
import net.minestom.server.collision.CollisionUtils;
|
|
import net.minestom.server.data.Data;
|
|
import net.minestom.server.data.DataContainer;
|
|
import net.minestom.server.event.Event;
|
|
import net.minestom.server.event.EventCallback;
|
|
import net.minestom.server.event.entity.*;
|
|
import net.minestom.server.event.handler.EventHandler;
|
|
import net.minestom.server.instance.Chunk;
|
|
import net.minestom.server.instance.Instance;
|
|
import net.minestom.server.instance.InstanceManager;
|
|
import net.minestom.server.instance.block.CustomBlock;
|
|
import net.minestom.server.network.packet.server.play.*;
|
|
import net.minestom.server.permission.Permission;
|
|
import net.minestom.server.permission.PermissionHandler;
|
|
import net.minestom.server.potion.Potion;
|
|
import net.minestom.server.potion.PotionEffect;
|
|
import net.minestom.server.potion.TimedPotion;
|
|
import net.minestom.server.thread.ThreadProvider;
|
|
import net.minestom.server.utils.BlockPosition;
|
|
import net.minestom.server.utils.Position;
|
|
import net.minestom.server.utils.Vector;
|
|
import net.minestom.server.utils.binary.BinaryWriter;
|
|
import net.minestom.server.utils.callback.OptionalCallback;
|
|
import net.minestom.server.utils.chunk.ChunkCallback;
|
|
import net.minestom.server.utils.chunk.ChunkUtils;
|
|
import net.minestom.server.utils.entity.EntityUtils;
|
|
import net.minestom.server.utils.player.PlayerUtils;
|
|
import net.minestom.server.utils.time.CooldownUtils;
|
|
import net.minestom.server.utils.time.TimeUnit;
|
|
import net.minestom.server.utils.time.UpdateOption;
|
|
import net.minestom.server.utils.validate.Check;
|
|
import org.jetbrains.annotations.NotNull;
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
import java.util.*;
|
|
import java.util.concurrent.ConcurrentHashMap;
|
|
import java.util.concurrent.CopyOnWriteArrayList;
|
|
import java.util.concurrent.CopyOnWriteArraySet;
|
|
import java.util.concurrent.atomic.AtomicInteger;
|
|
import java.util.function.Consumer;
|
|
|
|
/**
|
|
* Could be a player, a monster, or an object.
|
|
* <p>
|
|
* To create your own entity you probably want to extends {@link ObjectEntity} or {@link EntityCreature} instead.
|
|
*/
|
|
public abstract class Entity implements Viewable, EventHandler, DataContainer, PermissionHandler {
|
|
|
|
private static final Map<Integer, Entity> entityById = new ConcurrentHashMap<>();
|
|
private static final Map<UUID, Entity> entityByUuid = new ConcurrentHashMap<>();
|
|
private static final AtomicInteger lastEntityId = new AtomicInteger();
|
|
|
|
// Metadata
|
|
protected static final byte METADATA_BYTE = 0;
|
|
protected static final byte METADATA_VARINT = 1;
|
|
protected static final byte METADATA_FLOAT = 2;
|
|
protected static final byte METADATA_STRING = 3;
|
|
protected static final byte METADATA_CHAT = 4;
|
|
protected static final byte METADATA_OPTCHAT = 5;
|
|
protected static final byte METADATA_SLOT = 6;
|
|
protected static final byte METADATA_BOOLEAN = 7;
|
|
protected static final byte METADATA_ROTATION = 8;
|
|
protected static final byte METADATA_POSITION = 9;
|
|
protected static final byte METADATA_OPTPOSITION = 10;
|
|
protected static final byte METADATA_DIRECTION = 11;
|
|
protected static final byte METADATA_OPTUUID = 12;
|
|
protected static final byte METADATA_OPTBLOCKID = 13;
|
|
protected static final byte METADATA_NBT = 14;
|
|
protected static final byte METADATA_PARTICLE = 15;
|
|
protected static final byte METADATA_VILLAGERDATA = 16;
|
|
protected static final byte METADATA_OPTVARINT = 17;
|
|
protected static final byte METADATA_POSE = 18;
|
|
|
|
protected Instance instance;
|
|
protected final Position position;
|
|
protected float lastX, lastY, lastZ;
|
|
protected float cacheX, cacheY, cacheZ; // Used to synchronize with #getPosition
|
|
protected float lastYaw, lastPitch;
|
|
protected float cacheYaw, cachePitch;
|
|
protected boolean onGround;
|
|
|
|
private BoundingBox boundingBox;
|
|
|
|
protected Entity vehicle;
|
|
|
|
// Velocity
|
|
protected Vector velocity = new Vector(); // Movement in block per second
|
|
|
|
protected float gravityDragPerTick;
|
|
protected float gravityAcceleration;
|
|
protected float gravityTerminalVelocity;
|
|
protected int gravityTickCount; // Number of tick where gravity tick was applied
|
|
|
|
private boolean autoViewable;
|
|
private final int id;
|
|
protected final Set<Player> viewers = new CopyOnWriteArraySet<>();
|
|
private final Set<Player> unmodifiableViewers = Collections.unmodifiableSet(viewers);
|
|
private Data data;
|
|
private final Set<Permission> permissions = new CopyOnWriteArraySet<>();
|
|
|
|
protected UUID uuid;
|
|
private boolean isActive; // False if entity has only been instanced without being added somewhere
|
|
private boolean removed;
|
|
private boolean shouldRemove;
|
|
private long scheduledRemoveTime;
|
|
|
|
private final Set<Entity> passengers = new CopyOnWriteArraySet<>();
|
|
protected EntityType entityType; // UNSAFE to change, modify at your own risk
|
|
|
|
// Network synchronization, send the absolute position of the entity each X milliseconds
|
|
private static final UpdateOption SYNCHRONIZATION_COOLDOWN = new UpdateOption(1500, TimeUnit.MILLISECOND);
|
|
private long lastAbsoluteSynchronizationTime;
|
|
|
|
// Events
|
|
private final Map<Class<? extends Event>, Collection<EventCallback>> eventCallbacks = new ConcurrentHashMap<>();
|
|
|
|
// Metadata
|
|
protected boolean onFire;
|
|
protected boolean crouched;
|
|
protected boolean UNUSED_METADATA;
|
|
protected boolean sprinting;
|
|
protected boolean swimming;
|
|
protected boolean invisible;
|
|
protected boolean glowing;
|
|
protected boolean usingElytra;
|
|
protected int air = 300;
|
|
protected JsonMessage customName;
|
|
protected boolean customNameVisible;
|
|
protected boolean silent;
|
|
protected boolean noGravity;
|
|
protected Pose pose = Pose.STANDING;
|
|
|
|
private final List<TimedPotion> effects = new CopyOnWriteArrayList<>();
|
|
|
|
// list of scheduled tasks to be executed during the next entity tick
|
|
protected final Queue<Consumer<Entity>> nextTick = Queues.newConcurrentLinkedQueue();
|
|
|
|
// Tick related
|
|
private long ticks;
|
|
private final EntityTickEvent tickEvent = new EntityTickEvent(this);
|
|
|
|
public Entity(@NotNull EntityType entityType, @NotNull UUID uuid, @NotNull Position spawnPosition) {
|
|
this.id = generateId();
|
|
this.entityType = entityType;
|
|
this.uuid = uuid;
|
|
this.position = spawnPosition.clone();
|
|
|
|
setBoundingBox(0, 0, 0);
|
|
|
|
setAutoViewable(true);
|
|
|
|
Entity.entityById.put(id, this);
|
|
Entity.entityByUuid.put(uuid, this);
|
|
}
|
|
|
|
public Entity(@NotNull EntityType entityType, @NotNull Position spawnPosition) {
|
|
this(entityType, UUID.randomUUID(), spawnPosition);
|
|
}
|
|
|
|
public Entity(@NotNull EntityType entityType) {
|
|
this(entityType, new Position());
|
|
}
|
|
|
|
/**
|
|
* Schedules a task to be run during the next entity tick.
|
|
* It ensures that the task will be executed in the same thread as the entity (depending of the {@link ThreadProvider}).
|
|
*
|
|
* @param callback the task to execute during the next entity tick
|
|
*/
|
|
public void scheduleNextTick(@NotNull Consumer<Entity> callback) {
|
|
this.nextTick.add(callback);
|
|
}
|
|
|
|
/**
|
|
* Gets an entity based on its id (from {@link #getEntityId()}).
|
|
* <p>
|
|
* Entity id are unique server-wide.
|
|
*
|
|
* @param id the entity unique id
|
|
* @return the entity having the specified id, null if not found
|
|
*/
|
|
@Nullable
|
|
public static Entity getEntity(int id) {
|
|
return Entity.entityById.getOrDefault(id, null);
|
|
}
|
|
|
|
/**
|
|
* Gets an entity based on its UUID (from {@link #getUuid()}).
|
|
*
|
|
* @param uuid the entity UUID
|
|
* @return the entity having the specified uuid, null if not found
|
|
*/
|
|
@Nullable
|
|
public static Entity getEntity(@NotNull UUID uuid) {
|
|
return Entity.entityByUuid.getOrDefault(uuid, null);
|
|
}
|
|
|
|
|
|
/**
|
|
* Generate and return a new unique entity id.
|
|
* <p>
|
|
* Useful if you want to spawn entities using packet but don't risk to have duplicated id.
|
|
*
|
|
* @return a newly generated entity id
|
|
*/
|
|
public static int generateId() {
|
|
return lastEntityId.incrementAndGet();
|
|
}
|
|
|
|
/**
|
|
* Called each tick.
|
|
*
|
|
* @param time time of the update in milliseconds
|
|
*/
|
|
public abstract void update(long time);
|
|
|
|
/**
|
|
* Called when a new instance is set.
|
|
*/
|
|
public abstract void spawn();
|
|
|
|
public boolean isOnGround() {
|
|
return onGround || EntityUtils.isOnGround(this) /* backup for levitating entities */;
|
|
}
|
|
|
|
/**
|
|
* Teleports the entity only if the chunk at {@code position} is loaded or if
|
|
* {@link Instance#hasEnabledAutoChunkLoad()} returns true.
|
|
*
|
|
* @param position the teleport position
|
|
* @param chunks the chunk indexes to load before teleporting the entity,
|
|
* indexes are from {@link ChunkUtils#getChunkIndex(int, int)},
|
|
* can be null or empty to only load the chunk at {@code position}
|
|
* @param callback the optional callback executed, even if auto chunk is not enabled
|
|
* @throws IllegalStateException if you try to teleport an entity before settings its instance
|
|
*/
|
|
public void teleport(@NotNull Position position, @Nullable long[] chunks, @Nullable Runnable callback) {
|
|
Check.stateCondition(instance == null, "You need to use Entity#setInstance before teleporting an entity!");
|
|
|
|
final Position teleportPosition = position.clone(); // Prevent synchronization issue
|
|
|
|
final ChunkCallback endCallback = (chunk) -> {
|
|
refreshPosition(teleportPosition);
|
|
refreshView(teleportPosition.getYaw(), teleportPosition.getPitch());
|
|
|
|
sendSynchronization();
|
|
|
|
OptionalCallback.execute(callback);
|
|
};
|
|
|
|
if (chunks == null || chunks.length == 0) {
|
|
instance.loadOptionalChunk(teleportPosition, endCallback);
|
|
} else {
|
|
ChunkUtils.optionalLoadAll(instance, chunks, null, endCallback);
|
|
}
|
|
}
|
|
|
|
public void teleport(@NotNull Position position, @Nullable Runnable callback) {
|
|
teleport(position, null, callback);
|
|
}
|
|
|
|
public void teleport(@NotNull Position position) {
|
|
teleport(position, null);
|
|
}
|
|
|
|
/**
|
|
* Changes the view of the entity.
|
|
*
|
|
* @param yaw the new yaw
|
|
* @param pitch the new pitch
|
|
*/
|
|
public void setView(float yaw, float pitch) {
|
|
refreshView(yaw, pitch);
|
|
|
|
EntityRotationPacket entityRotationPacket = new EntityRotationPacket();
|
|
entityRotationPacket.entityId = getEntityId();
|
|
entityRotationPacket.yaw = yaw;
|
|
entityRotationPacket.pitch = pitch;
|
|
entityRotationPacket.onGround = onGround;
|
|
|
|
EntityHeadLookPacket entityHeadLookPacket = new EntityHeadLookPacket();
|
|
entityHeadLookPacket.entityId = getEntityId();
|
|
entityHeadLookPacket.yaw = yaw;
|
|
|
|
sendPacketToViewersAndSelf(entityHeadLookPacket);
|
|
sendPacketToViewersAndSelf(entityRotationPacket);
|
|
}
|
|
|
|
/**
|
|
* Changes the view of the entity.
|
|
* Only the yaw and pitch are used.
|
|
*
|
|
* @param position the new view
|
|
*/
|
|
public void setView(@NotNull Position position) {
|
|
setView(position.getYaw(), position.getPitch());
|
|
}
|
|
|
|
/**
|
|
* When set to true, the entity will automatically get new viewers when they come too close.
|
|
* This can be use to have complete control over which player can see it, without having to deal with
|
|
* raw packets.
|
|
* <p>
|
|
* True by default for all entities.
|
|
* When set to false, it is important to mention that the players will not be removed automatically from its viewers
|
|
* list, you would have to do that manually using {@link #addViewer(Player)} and {@link #removeViewer(Player)}..
|
|
*
|
|
* @return true if the entity is automatically viewable for close players, false otherwise
|
|
*/
|
|
public boolean isAutoViewable() {
|
|
return autoViewable;
|
|
}
|
|
|
|
/**
|
|
* Makes the entity auto viewable or only manually.
|
|
*
|
|
* @param autoViewable should the entity be automatically viewable for close players
|
|
* @see #isAutoViewable()
|
|
*/
|
|
public void setAutoViewable(boolean autoViewable) {
|
|
this.autoViewable = autoViewable;
|
|
}
|
|
|
|
@Override
|
|
public boolean addViewer(@NotNull Player player) {
|
|
boolean result = this.viewers.add(player);
|
|
if (!result)
|
|
return false;
|
|
player.viewableEntities.add(this);
|
|
return true;
|
|
}
|
|
|
|
@Override
|
|
public boolean removeViewer(@NotNull Player player) {
|
|
if (!viewers.remove(player))
|
|
return false;
|
|
|
|
DestroyEntitiesPacket destroyEntitiesPacket = new DestroyEntitiesPacket();
|
|
destroyEntitiesPacket.entityIds = new int[]{getEntityId()};
|
|
player.getPlayerConnection().sendPacket(destroyEntitiesPacket);
|
|
player.viewableEntities.remove(this);
|
|
return true;
|
|
}
|
|
|
|
@NotNull
|
|
@Override
|
|
public Set<Player> getViewers() {
|
|
return unmodifiableViewers;
|
|
}
|
|
|
|
@Override
|
|
public Data getData() {
|
|
return data;
|
|
}
|
|
|
|
@Override
|
|
public void setData(@Nullable Data data) {
|
|
this.data = data;
|
|
}
|
|
|
|
@NotNull
|
|
@Override
|
|
public Set<Permission> getAllPermissions() {
|
|
return permissions;
|
|
}
|
|
|
|
/**
|
|
* Updates the entity, called every tick.
|
|
* <p>
|
|
* Ignored if {@link #getInstance()} returns null.
|
|
*
|
|
* @param time the update time in milliseconds
|
|
*/
|
|
public void tick(long time) {
|
|
if (instance == null)
|
|
return;
|
|
|
|
// Scheduled remove
|
|
if (scheduledRemoveTime != 0) {
|
|
final boolean finished = time >= scheduledRemoveTime;
|
|
if (finished) {
|
|
remove();
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Instant remove
|
|
if (shouldRemove()) {
|
|
remove();
|
|
return;
|
|
}
|
|
|
|
// Check if the entity chunk is loaded
|
|
final Chunk currentChunk = getChunk();
|
|
if (!ChunkUtils.isLoaded(currentChunk)) {
|
|
// No update for entities in unloaded chunk
|
|
return;
|
|
}
|
|
|
|
// scheduled tasks
|
|
if (!nextTick.isEmpty()) {
|
|
Consumer<Entity> callback;
|
|
while ((callback = nextTick.poll()) != null) {
|
|
callback.accept(this);
|
|
}
|
|
}
|
|
|
|
// Synchronization with updated fields in #getPosition()
|
|
{
|
|
final boolean positionChange = cacheX != position.getX() ||
|
|
cacheY != position.getY() ||
|
|
cacheZ != position.getZ();
|
|
final boolean viewChange = cacheYaw != position.getYaw() ||
|
|
cachePitch != position.getPitch();
|
|
final float distance = positionChange ? position.getDistance(cacheX, cacheY, cacheZ) : 0;
|
|
|
|
if (distance >= 8 || (positionChange && PlayerUtils.isNettyClient(this))) {
|
|
// Teleport has the priority over everything else
|
|
teleport(position);
|
|
} else if (positionChange && viewChange) {
|
|
EntityPositionAndRotationPacket positionAndRotationPacket =
|
|
EntityPositionAndRotationPacket.getPacket(getEntityId(),
|
|
position, new Position(cacheX, cacheY, cacheZ), isOnGround());
|
|
|
|
sendPacketToViewersAndSelf(positionAndRotationPacket);
|
|
|
|
refreshPosition(position.clone());
|
|
|
|
// Fix head rotation
|
|
EntityHeadLookPacket entityHeadLookPacket = new EntityHeadLookPacket();
|
|
entityHeadLookPacket.entityId = getEntityId();
|
|
entityHeadLookPacket.yaw = position.getYaw();
|
|
|
|
sendPacketToViewersAndSelf(entityHeadLookPacket);
|
|
|
|
} else if (positionChange) {
|
|
EntityPositionPacket entityPositionPacket = EntityPositionPacket.getPacket(getEntityId(),
|
|
position, new Position(cacheX, cacheY, cacheZ), isOnGround());
|
|
|
|
sendPacketToViewersAndSelf(entityPositionPacket);
|
|
|
|
refreshPosition(position.clone());
|
|
|
|
} else if (viewChange) {
|
|
// Yaw/Pitch
|
|
setView(position);
|
|
}
|
|
|
|
}
|
|
|
|
// Entity tick
|
|
{
|
|
|
|
// Cache the number of "gravity tick"
|
|
if (!onGround) {
|
|
gravityTickCount++;
|
|
} else {
|
|
gravityTickCount = 0;
|
|
}
|
|
|
|
// Velocity
|
|
boolean applyVelocity;
|
|
// Non-player entities with either velocity or gravity enabled
|
|
applyVelocity = !PlayerUtils.isNettyClient(this) && (hasVelocity() || !hasNoGravity());
|
|
// Players with a velocity applied (client is responsible for gravity)
|
|
applyVelocity |= PlayerUtils.isNettyClient(this) && hasVelocity();
|
|
|
|
if (applyVelocity) {
|
|
final float tps = MinecraftServer.TICK_PER_SECOND;
|
|
final float newX = position.getX() + velocity.getX() / tps;
|
|
final float newY = position.getY() + velocity.getY() / tps;
|
|
final float newZ = position.getZ() + velocity.getZ() / tps;
|
|
Position newPosition = new Position(newX, newY, newZ);
|
|
|
|
Vector newVelocityOut = new Vector();
|
|
|
|
// Gravity force
|
|
final float gravityY = !noGravity ? Math.min(
|
|
gravityDragPerTick + (gravityAcceleration * (float) gravityTickCount),
|
|
gravityTerminalVelocity) : 0f;
|
|
|
|
final Vector deltaPos = new Vector(
|
|
getVelocity().getX() / tps,
|
|
(getVelocity().getY() - gravityY) / tps,
|
|
getVelocity().getZ() / tps
|
|
);
|
|
|
|
this.onGround = CollisionUtils.handlePhysics(this, deltaPos, newPosition, newVelocityOut);
|
|
|
|
// World border collision
|
|
final Position finalVelocityPosition = CollisionUtils.applyWorldBorder(instance, position, newPosition);
|
|
final Chunk finalChunk = instance.getChunkAt(finalVelocityPosition);
|
|
|
|
// Entity shouldn't be updated when moving in an unloaded chunk
|
|
if (!ChunkUtils.isLoaded(finalChunk)) {
|
|
return;
|
|
}
|
|
|
|
// Apply the position if changed
|
|
if (!newPosition.isSimilar(position)) {
|
|
refreshPosition(finalVelocityPosition);
|
|
}
|
|
|
|
|
|
// Update velocity
|
|
{
|
|
this.velocity.copy(newVelocityOut);
|
|
this.velocity.multiply(tps);
|
|
|
|
float drag;
|
|
if (onGround) {
|
|
final BlockPosition blockPosition = position.toBlockPosition();
|
|
final CustomBlock customBlock = finalChunk.getCustomBlock(
|
|
blockPosition.getX(),
|
|
blockPosition.getY(),
|
|
blockPosition.getZ());
|
|
if (customBlock != null) {
|
|
// Custom drag
|
|
drag = customBlock.getDrag(instance, blockPosition);
|
|
} else {
|
|
// Default ground drag
|
|
drag = 0.5f;
|
|
}
|
|
|
|
// Stop player velocity
|
|
if (PlayerUtils.isNettyClient(this)) {
|
|
this.velocity.zero();
|
|
}
|
|
} else {
|
|
drag = 0.98f; // air drag
|
|
}
|
|
|
|
this.velocity.setX(velocity.getX() * drag);
|
|
this.velocity.setZ(velocity.getZ() * drag);
|
|
}
|
|
|
|
// Synchronization and packets...
|
|
sendSynchronization();
|
|
// Verify if velocity packet has to be sent
|
|
if (hasVelocity() || gravityTickCount > 0) {
|
|
sendPacketsToViewers(getVelocityPacket());
|
|
}
|
|
}
|
|
|
|
// handle block contacts
|
|
// TODO do not call every tick (it is pretty expensive)
|
|
final int minX = (int) Math.floor(boundingBox.getMinX());
|
|
final int maxX = (int) Math.ceil(boundingBox.getMaxX());
|
|
final int minY = (int) Math.floor(boundingBox.getMinY());
|
|
final int maxY = (int) Math.ceil(boundingBox.getMaxY());
|
|
final int minZ = (int) Math.floor(boundingBox.getMinZ());
|
|
final int maxZ = (int) Math.ceil(boundingBox.getMaxZ());
|
|
final BlockPosition tmpPosition = new BlockPosition(0, 0, 0); // allow reuse
|
|
for (int y = minY; y <= maxY; y++) {
|
|
for (int x = minX; x <= maxX; x++) {
|
|
for (int z = minZ; z <= maxZ; z++) {
|
|
final Chunk chunk = instance.getChunkAt(x, z);
|
|
if (!ChunkUtils.isLoaded(chunk))
|
|
continue;
|
|
|
|
final CustomBlock customBlock = chunk.getCustomBlock(x, y, z);
|
|
if (customBlock != null) {
|
|
tmpPosition.setX(x);
|
|
tmpPosition.setY(y);
|
|
tmpPosition.setZ(z);
|
|
// checks that we are actually in the block, and not just here because of a rounding error
|
|
if (boundingBox.intersect(tmpPosition)) {
|
|
// TODO: replace with check with custom block bounding box
|
|
customBlock.handleContact(instance, tmpPosition, this);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
handleVoid();
|
|
|
|
// Call the abstract update method
|
|
update(time);
|
|
|
|
ticks++;
|
|
callEvent(EntityTickEvent.class, tickEvent); // reuse tickEvent to avoid recreating it each tick
|
|
|
|
// remove expired effects
|
|
{
|
|
this.effects.removeIf(timedPotion -> {
|
|
final long potionTime = (long) timedPotion.getPotion().getDuration() * MinecraftServer.TICK_MS;
|
|
// Remove if the potion should be expired
|
|
if (time >= timedPotion.getStartingTime() + potionTime) {
|
|
// Send the packet that the potion should no longer be applied
|
|
timedPotion.getPotion().sendRemovePacket(this);
|
|
callEvent(EntityPotionRemoveEvent.class, new EntityPotionRemoveEvent(
|
|
this,
|
|
timedPotion.getPotion()
|
|
));
|
|
return true;
|
|
}
|
|
return false;
|
|
});
|
|
}
|
|
}
|
|
|
|
// Scheduled synchronization
|
|
if (!CooldownUtils.hasCooldown(time, lastAbsoluteSynchronizationTime, SYNCHRONIZATION_COOLDOWN)) {
|
|
this.lastAbsoluteSynchronizationTime = time;
|
|
sendSynchronization();
|
|
}
|
|
|
|
if (shouldRemove() && !MinecraftServer.isStopping()) {
|
|
remove();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the number of ticks this entity has been active for.
|
|
*
|
|
* @return the number of ticks this entity has been active for
|
|
*/
|
|
public long getAliveTicks() {
|
|
return ticks;
|
|
}
|
|
|
|
/**
|
|
* How does this entity handle being in the void?
|
|
*/
|
|
protected void handleVoid() {
|
|
// Kill if in void
|
|
if (getInstance().isInVoid(this.position)) {
|
|
remove();
|
|
}
|
|
}
|
|
|
|
@NotNull
|
|
@Override
|
|
public Map<Class<? extends Event>, Collection<EventCallback>> getEventCallbacksMap() {
|
|
return eventCallbacks;
|
|
}
|
|
|
|
/**
|
|
* Each entity has an unique id (server-wide) which will change after a restart.
|
|
*
|
|
* @return the unique entity id
|
|
* @see Entity#getEntity(int) to retrive an entity based on its id
|
|
*/
|
|
public int getEntityId() {
|
|
return id;
|
|
}
|
|
|
|
/**
|
|
* Returns the entity type.
|
|
*
|
|
* @return the entity type
|
|
*/
|
|
public EntityType getEntityType() {
|
|
return entityType;
|
|
}
|
|
|
|
/**
|
|
* Gets the entity {@link UUID}.
|
|
*
|
|
* @return the entity unique id
|
|
*/
|
|
@NotNull
|
|
public UUID getUuid() {
|
|
return uuid;
|
|
}
|
|
|
|
/**
|
|
* Changes the internal entity UUID, mostly unsafe.
|
|
*
|
|
* @param uuid the new entity uuid
|
|
*/
|
|
public void setUuid(@NotNull UUID uuid) {
|
|
// Refresh internal map
|
|
Entity.entityByUuid.remove(this.uuid);
|
|
Entity.entityByUuid.put(uuid, this);
|
|
|
|
this.uuid = uuid;
|
|
}
|
|
|
|
/**
|
|
* Returns false just after instantiation, set to true after calling {@link #setInstance(Instance)}.
|
|
*
|
|
* @return true if the entity has been linked to an instance, false otherwise
|
|
*/
|
|
public boolean isActive() {
|
|
return isActive;
|
|
}
|
|
|
|
/**
|
|
* Is used to check collision with coordinates or other blocks/entities.
|
|
*
|
|
* @return the entity bounding box
|
|
*/
|
|
@NotNull
|
|
public BoundingBox getBoundingBox() {
|
|
return boundingBox;
|
|
}
|
|
|
|
/**
|
|
* Changes the internal entity bounding box.
|
|
* <p>
|
|
* WARNING: this does not change the entity hit-box which is client-side.
|
|
*
|
|
* @param x the bounding box X size
|
|
* @param y the bounding box Y size
|
|
* @param z the bounding box Z size
|
|
*/
|
|
public void setBoundingBox(float x, float y, float z) {
|
|
this.boundingBox = new BoundingBox(this, x, y, z);
|
|
}
|
|
|
|
/**
|
|
* Changes the internal entity bounding box.
|
|
* <p>
|
|
* WARNING: this does not change the entity hit-box which is client-side.
|
|
*
|
|
* @param boundingBox the new bounding box
|
|
*/
|
|
public void setBoundingBox(BoundingBox boundingBox) {
|
|
this.boundingBox = boundingBox;
|
|
}
|
|
|
|
/**
|
|
* Convenient method to get the entity current chunk.
|
|
*
|
|
* @return the entity chunk, can be null even if unlikely
|
|
*/
|
|
@Nullable
|
|
public Chunk getChunk() {
|
|
return instance.getChunkAt(position.getX(), position.getZ());
|
|
}
|
|
|
|
/**
|
|
* Gets the entity current instance.
|
|
*
|
|
* @return the entity instance, can be null if the entity doesn't have an instance yet
|
|
*/
|
|
@Nullable
|
|
public Instance getInstance() {
|
|
return instance;
|
|
}
|
|
|
|
/**
|
|
* Changes the entity instance.
|
|
*
|
|
* @param instance the new instance of the entity
|
|
* @throws NullPointerException if {@code instance} is null
|
|
* @throws IllegalStateException if {@code instance} has not been registered in {@link InstanceManager}
|
|
*/
|
|
public void setInstance(@NotNull Instance instance) {
|
|
Check.stateCondition(!instance.isRegistered(),
|
|
"Instances need to be registered, please use InstanceManager#registerInstance or InstanceManager#registerSharedInstance");
|
|
|
|
if (this.instance != null) {
|
|
this.instance.UNSAFE_removeEntity(this);
|
|
}
|
|
|
|
this.isActive = true;
|
|
this.instance = instance;
|
|
instance.UNSAFE_addEntity(this);
|
|
spawn();
|
|
EntitySpawnEvent entitySpawnEvent = new EntitySpawnEvent(this, instance);
|
|
callEvent(EntitySpawnEvent.class, entitySpawnEvent);
|
|
}
|
|
|
|
/**
|
|
* Gets the entity current velocity.
|
|
*
|
|
* @return the entity current velocity
|
|
*/
|
|
@NotNull
|
|
public Vector getVelocity() {
|
|
return velocity;
|
|
}
|
|
|
|
/**
|
|
* Changes the entity velocity and calls {@link EntityVelocityEvent}.
|
|
* <p>
|
|
* The final velocity can be cancelled or modified by the event.
|
|
*
|
|
* @param velocity the new entity velocity
|
|
*/
|
|
public void setVelocity(@NotNull Vector velocity) {
|
|
EntityVelocityEvent entityVelocityEvent = new EntityVelocityEvent(this, velocity);
|
|
callCancellableEvent(EntityVelocityEvent.class, entityVelocityEvent, () -> {
|
|
this.velocity.copy(entityVelocityEvent.getVelocity());
|
|
sendPacketToViewersAndSelf(getVelocityPacket());
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity currently has a velocity applied.
|
|
*
|
|
* @return true if velocity is not set to 0
|
|
*/
|
|
public boolean hasVelocity() {
|
|
return velocity.getX() != 0 ||
|
|
velocity.getY() != 0 ||
|
|
velocity.getZ() != 0;
|
|
}
|
|
|
|
/**
|
|
* Gets the gravity drag per tick.
|
|
*
|
|
* @return the gravity drag per tick in block
|
|
*/
|
|
public float getGravityDragPerTick() {
|
|
return gravityDragPerTick;
|
|
}
|
|
|
|
/**
|
|
* Gets the gravity acceleration.
|
|
*
|
|
* @return the gravity acceleration in block
|
|
*/
|
|
public float getGravityAcceleration() {
|
|
return gravityAcceleration;
|
|
}
|
|
|
|
/**
|
|
* Gets the maximum gravity velocity.
|
|
*
|
|
* @return the maximum gravity velocity in block
|
|
*/
|
|
public float getGravityTerminalVelocity() {
|
|
return gravityTerminalVelocity;
|
|
}
|
|
|
|
/**
|
|
* Gets the number of tick this entity has been applied gravity.
|
|
*
|
|
* @return the number of tick of which gravity has been consequently applied
|
|
*/
|
|
public int getGravityTickCount() {
|
|
return gravityTickCount;
|
|
}
|
|
|
|
/**
|
|
* Changes the gravity of the entity.
|
|
*
|
|
* @param gravityDragPerTick the gravity drag per tick in block
|
|
* @param gravityAcceleration the gravity acceleration in block
|
|
* @param gravityTerminalVelocity the gravity terminal velocity (maximum) in block
|
|
* @see <a href="https://minecraft.gamepedia.com/Entity#Motion_of_entities">Entities motion</a>
|
|
*/
|
|
public void setGravity(float gravityDragPerTick, float gravityAcceleration, float gravityTerminalVelocity) {
|
|
this.gravityDragPerTick = gravityDragPerTick;
|
|
this.gravityAcceleration = gravityAcceleration;
|
|
this.gravityTerminalVelocity = gravityTerminalVelocity;
|
|
}
|
|
|
|
/**
|
|
* Gets the distance between two entities.
|
|
*
|
|
* @param entity the entity to get the distance from
|
|
* @return the distance between this and {@code entity}
|
|
*/
|
|
public float getDistance(@NotNull Entity entity) {
|
|
return getPosition().getDistance(entity.getPosition());
|
|
}
|
|
|
|
/**
|
|
* Gets the entity vehicle or null.
|
|
*
|
|
* @return the entity vehicle, or null if there is not any
|
|
*/
|
|
@Nullable
|
|
public Entity getVehicle() {
|
|
return vehicle;
|
|
}
|
|
|
|
/**
|
|
* Adds a new passenger to this entity.
|
|
*
|
|
* @param entity the new passenger
|
|
* @throws NullPointerException if {@code entity} is null
|
|
* @throws IllegalStateException if {@link #getInstance()} returns null
|
|
*/
|
|
public void addPassenger(@NotNull Entity entity) {
|
|
Check.stateCondition(instance == null, "You need to set an instance using Entity#setInstance");
|
|
|
|
if (entity.getVehicle() != null) {
|
|
entity.getVehicle().removePassenger(entity);
|
|
}
|
|
|
|
this.passengers.add(entity);
|
|
entity.vehicle = this;
|
|
|
|
sendPacketToViewersAndSelf(getPassengersPacket());
|
|
}
|
|
|
|
/**
|
|
* Removes a passenger to this entity.
|
|
*
|
|
* @param entity the passenger to remove
|
|
* @throws NullPointerException if {@code entity} is null
|
|
* @throws IllegalStateException if {@link #getInstance()} returns null
|
|
*/
|
|
public void removePassenger(@NotNull Entity entity) {
|
|
Check.stateCondition(instance == null, "You need to set an instance using Entity#setInstance");
|
|
|
|
if (!passengers.remove(entity))
|
|
return;
|
|
entity.vehicle = null;
|
|
sendPacketToViewersAndSelf(getPassengersPacket());
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity has any passenger.
|
|
*
|
|
* @return true if the entity has any passenger, false otherwise
|
|
*/
|
|
public boolean hasPassenger() {
|
|
return !passengers.isEmpty();
|
|
}
|
|
|
|
/**
|
|
* Gets the entity passengers.
|
|
*
|
|
* @return an unmodifiable list containing all the entity passengers
|
|
*/
|
|
@NotNull
|
|
public Set<Entity> getPassengers() {
|
|
return Collections.unmodifiableSet(passengers);
|
|
}
|
|
|
|
@NotNull
|
|
protected SetPassengersPacket getPassengersPacket() {
|
|
SetPassengersPacket passengersPacket = new SetPassengersPacket();
|
|
passengersPacket.vehicleEntityId = getEntityId();
|
|
|
|
int[] passengers = new int[this.passengers.size()];
|
|
int counter = 0;
|
|
for (Entity passenger : this.passengers) {
|
|
passengers[counter++] = passenger.getEntityId();
|
|
}
|
|
|
|
passengersPacket.passengersId = passengers;
|
|
return passengersPacket;
|
|
}
|
|
|
|
/**
|
|
* Entity statuses can be found <a href="https://wiki.vg/Entity_statuses">here</a>.
|
|
*
|
|
* @param status the status to trigger
|
|
*/
|
|
public void triggerStatus(byte status) {
|
|
EntityStatusPacket statusPacket = new EntityStatusPacket();
|
|
statusPacket.entityId = getEntityId();
|
|
statusPacket.status = status;
|
|
sendPacketToViewersAndSelf(statusPacket);
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity is on fire.
|
|
*
|
|
* @return true if the entity is in fire, false otherwise
|
|
*/
|
|
public boolean isOnFire() {
|
|
return onFire;
|
|
}
|
|
|
|
/**
|
|
* Sets the entity in fire visually.
|
|
* <p>
|
|
* WARNING: if you want to apply damage or specify a duration,
|
|
* see {@link LivingEntity#setFireForDuration(int, TimeUnit)}.
|
|
*
|
|
* @param fire should the entity be set in fire
|
|
*/
|
|
public void setOnFire(boolean fire) {
|
|
this.onFire = fire;
|
|
sendMetadataIndex(0);
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity is invisible or not.
|
|
*
|
|
* @return true if the entity is invisible, false otherwise
|
|
*/
|
|
public boolean isInvisible() {
|
|
return invisible;
|
|
}
|
|
|
|
/**
|
|
* Changes the internal invisible value and send a {@link EntityMetaDataPacket}
|
|
* to make visible or invisible the entity to its viewers.
|
|
*
|
|
* @param invisible true to set the entity invisible, false otherwise
|
|
*/
|
|
public void setInvisible(boolean invisible) {
|
|
this.invisible = invisible;
|
|
sendMetadataIndex(0);
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity is glowing or not.
|
|
*
|
|
* @return true if the entity is glowing, false otherwise
|
|
*/
|
|
public boolean isGlowing() {
|
|
return glowing;
|
|
}
|
|
|
|
/**
|
|
* Sets or remove the entity glowing effect.
|
|
*
|
|
* @param glowing true to make the entity glows, false otherwise
|
|
*/
|
|
public void setGlowing(boolean glowing) {
|
|
this.glowing = glowing;
|
|
sendMetadataIndex(0);
|
|
}
|
|
|
|
/**
|
|
* Gets the entity custom name.
|
|
*
|
|
* @return the custom name of the entity, null if there is not
|
|
*/
|
|
public JsonMessage getCustomName() {
|
|
return customName;
|
|
}
|
|
|
|
/**
|
|
* Changes the entity custom name.
|
|
*
|
|
* @param customName the custom name of the entity, null to remove it
|
|
*/
|
|
public void setCustomName(JsonMessage customName) {
|
|
this.customName = customName;
|
|
sendMetadataIndex(2);
|
|
}
|
|
|
|
/**
|
|
* Gets the custom name visible metadata field.
|
|
*
|
|
* @return true if the custom name is visible, false otherwise
|
|
*/
|
|
public boolean isCustomNameVisible() {
|
|
return customNameVisible;
|
|
}
|
|
|
|
/**
|
|
* Changes the internal custom name visible field and send a {@link EntityMetaDataPacket}
|
|
* to update the entity state to its viewers.
|
|
*
|
|
* @param customNameVisible true to make the custom name visible, false otherwise
|
|
*/
|
|
public void setCustomNameVisible(boolean customNameVisible) {
|
|
this.customNameVisible = customNameVisible;
|
|
sendMetadataIndex(3);
|
|
}
|
|
|
|
public boolean isSilent() {
|
|
return silent;
|
|
}
|
|
|
|
public void setSilent(boolean silent) {
|
|
this.silent = silent;
|
|
sendMetadataIndex(4);
|
|
}
|
|
|
|
/**
|
|
* Changes the noGravity metadata field and change the gravity behaviour accordingly.
|
|
*
|
|
* @param noGravity should the entity ignore gravity
|
|
*/
|
|
public void setNoGravity(boolean noGravity) {
|
|
this.noGravity = noGravity;
|
|
sendMetadataIndex(5);
|
|
}
|
|
|
|
/**
|
|
* Gets the noGravity metadata field.
|
|
*
|
|
* @return true if the entity ignore gravity, false otherwise
|
|
*/
|
|
public boolean hasNoGravity() {
|
|
return noGravity;
|
|
}
|
|
|
|
/**
|
|
* 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 {@link #isAutoViewable()} is enabled
|
|
* <p>
|
|
* WARNING: unsafe, should only be used internally in Minestom. Use {@link #teleport(Position)} instead.
|
|
*
|
|
* @param x new position X
|
|
* @param y new position Y
|
|
* @param z new position Z
|
|
*/
|
|
public void refreshPosition(float x, float y, float z) {
|
|
this.lastX = position.getX();
|
|
this.lastY = position.getY();
|
|
this.lastZ = position.getZ();
|
|
position.setX(x);
|
|
position.setY(y);
|
|
position.setZ(z);
|
|
this.cacheX = x;
|
|
this.cacheY = y;
|
|
this.cacheZ = z;
|
|
|
|
if (hasPassenger()) {
|
|
for (Entity passenger : getPassengers()) {
|
|
passenger.refreshPosition(x, y, z);
|
|
}
|
|
}
|
|
|
|
final Instance instance = getInstance();
|
|
if (instance != null) {
|
|
|
|
// Needed to refresh the client chunks when connecting for the first time
|
|
final boolean forceUpdate = this instanceof Player && ((Player) this).getViewableChunks().isEmpty();
|
|
|
|
final Chunk lastChunk = instance.getChunkAt(lastX, lastZ);
|
|
final Chunk newChunk = instance.getChunkAt(x, z);
|
|
|
|
Check.notNull(lastChunk, "The entity " + getEntityId() + " was in an unloaded chunk at " + lastX + ";" + lastZ);
|
|
Check.notNull(newChunk, "The entity " + getEntityId() + " tried to move in an unloaded chunk at " + x + ";" + z);
|
|
|
|
final boolean chunkChange = lastChunk != newChunk;
|
|
if (forceUpdate || chunkChange) {
|
|
instance.switchEntityChunk(this, lastChunk, newChunk);
|
|
if (this instanceof Player) {
|
|
// Refresh player view
|
|
final Player player = (Player) this;
|
|
player.refreshVisibleChunks(newChunk);
|
|
player.refreshVisibleEntities(newChunk);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param position the new position
|
|
* @see #refreshPosition(float, float, float)
|
|
*/
|
|
public void refreshPosition(@NotNull Position position) {
|
|
refreshPosition(position.getX(), position.getY(), position.getZ());
|
|
}
|
|
|
|
/**
|
|
* Updates the entity view internally.
|
|
* <p>
|
|
* Warning: you probably want to use {@link #setView(float, float)}.
|
|
*
|
|
* @param yaw the yaw
|
|
* @param pitch the pitch
|
|
*/
|
|
public void refreshView(float yaw, float pitch) {
|
|
this.lastYaw = position.getYaw();
|
|
this.lastPitch = position.getPitch();
|
|
position.setYaw(yaw);
|
|
position.setPitch(pitch);
|
|
this.cacheYaw = yaw;
|
|
this.cachePitch = pitch;
|
|
}
|
|
|
|
/**
|
|
* Makes the entity sneak.
|
|
* <p>
|
|
* WARNING: this will not work for the client itself.
|
|
*
|
|
* @param sneaking true to make the entity sneak
|
|
*/
|
|
public void setSneaking(boolean sneaking) {
|
|
setPose(sneaking ? Pose.SNEAKING : Pose.STANDING);
|
|
sendMetadataIndex(0); // update the crouched metadata
|
|
}
|
|
|
|
/**
|
|
* Gets the current entity pose.
|
|
*
|
|
* @return the entity pose
|
|
*/
|
|
@NotNull
|
|
public Pose getPose() {
|
|
return pose;
|
|
}
|
|
|
|
/**
|
|
* Changes the entity pose.
|
|
* <p>
|
|
* The internal {@code crouched} and {@code swimming} field will be
|
|
* updated accordingly.
|
|
*
|
|
* @param pose the new entity pose
|
|
*/
|
|
@NotNull
|
|
public void setPose(@NotNull Pose pose) {
|
|
this.crouched = pose == Pose.SNEAKING;
|
|
this.swimming = pose == Pose.SWIMMING;
|
|
this.pose = pose;
|
|
sendMetadataIndex(6);
|
|
}
|
|
|
|
/**
|
|
* Makes the entity sprint.
|
|
* <p>
|
|
* WARNING: this will not work on the client itself.
|
|
*
|
|
* @param sprinting true to make the entity sprint
|
|
*/
|
|
public void setSprinting(boolean sprinting) {
|
|
this.sprinting = sprinting;
|
|
sendMetadataIndex(0);
|
|
}
|
|
|
|
/**
|
|
* Gets the entity position.
|
|
*
|
|
* @return the current position of the entity
|
|
*/
|
|
@NotNull
|
|
public Position getPosition() {
|
|
return position;
|
|
}
|
|
|
|
/**
|
|
* Gets the entity eye height.
|
|
* <p>
|
|
* Default to {@link BoundingBox#getHeight()}x0.85
|
|
*
|
|
* @return the entity eye height
|
|
*/
|
|
public float getEyeHeight() {
|
|
return boundingBox.getHeight() * 0.85f;
|
|
}
|
|
|
|
/**
|
|
* Gets all the potion effect of this entity.
|
|
*
|
|
* @return an unmodifiable list of all this entity effects
|
|
*/
|
|
@NotNull
|
|
public List<TimedPotion> getActiveEffects() {
|
|
return Collections.unmodifiableList(effects);
|
|
}
|
|
|
|
/**
|
|
* Removes effect from entity, if it has it.
|
|
*
|
|
* @param effect The effect to remove
|
|
*/
|
|
public void removeEffect(@NotNull PotionEffect effect) {
|
|
this.effects.removeIf(timedPotion -> {
|
|
if (timedPotion.getPotion().getEffect() == effect) {
|
|
timedPotion.getPotion().sendRemovePacket(this);
|
|
callEvent(EntityPotionRemoveEvent.class, new EntityPotionRemoveEvent(
|
|
this,
|
|
timedPotion.getPotion()
|
|
));
|
|
return true;
|
|
}
|
|
return false;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Adds an effect to an entity.
|
|
*
|
|
* @param potion The potion to add
|
|
*/
|
|
public void addEffect(@NotNull Potion potion) {
|
|
removeEffect(potion.getEffect());
|
|
this.effects.add(new TimedPotion(potion, System.currentTimeMillis()));
|
|
potion.sendAddPacket(this);
|
|
callEvent(EntityPotionAddEvent.class, new EntityPotionAddEvent(this, potion));
|
|
}
|
|
|
|
/**
|
|
* Removes the entity from the server immediately.
|
|
* <p>
|
|
* WARNING: this does not trigger {@link EntityDeathEvent}.
|
|
*/
|
|
public void remove() {
|
|
this.removed = true;
|
|
this.shouldRemove = true;
|
|
Entity.entityById.remove(id);
|
|
Entity.entityByUuid.remove(uuid);
|
|
if (instance != null)
|
|
instance.UNSAFE_removeEntity(this);
|
|
}
|
|
|
|
/**
|
|
* Gets if this entity has been removed.
|
|
*
|
|
* @return true if this entity is removed
|
|
*/
|
|
public boolean isRemoved() {
|
|
return removed;
|
|
}
|
|
|
|
/**
|
|
* Triggers {@link #remove()} after the specified time.
|
|
*
|
|
* @param delay the time before removing the entity,
|
|
* 0 to cancel the removing
|
|
* @param timeUnit the unit of the delay
|
|
*/
|
|
public void scheduleRemove(long delay, @NotNull TimeUnit timeUnit) {
|
|
if (delay == 0) { // Cancel the scheduled remove
|
|
this.scheduledRemoveTime = 0;
|
|
return;
|
|
}
|
|
this.scheduledRemoveTime = System.currentTimeMillis() + timeUnit.toMilliseconds(delay);
|
|
}
|
|
|
|
/**
|
|
* Gets if the entity removal has been scheduled with {@link #scheduleRemove(long, TimeUnit)}.
|
|
*
|
|
* @return true if the entity removal has been scheduled
|
|
*/
|
|
public boolean isRemoveScheduled() {
|
|
return scheduledRemoveTime != 0;
|
|
}
|
|
|
|
@NotNull
|
|
protected EntityVelocityPacket getVelocityPacket() {
|
|
final float strength = 8000f / MinecraftServer.TICK_PER_SECOND;
|
|
EntityVelocityPacket velocityPacket = new EntityVelocityPacket();
|
|
velocityPacket.entityId = getEntityId();
|
|
velocityPacket.velocityX = (short) (velocity.getX() * strength);
|
|
velocityPacket.velocityY = (short) (velocity.getY() * strength);
|
|
velocityPacket.velocityZ = (short) (velocity.getZ() * strength);
|
|
return velocityPacket;
|
|
}
|
|
|
|
/**
|
|
* Gets an {@link EntityMetaDataPacket} sent when adding viewers. Used for synchronization.
|
|
*
|
|
* @return The {@link EntityMetaDataPacket} related to this entity
|
|
*/
|
|
@NotNull
|
|
public EntityMetaDataPacket getMetadataPacket() {
|
|
EntityMetaDataPacket metaDataPacket = new EntityMetaDataPacket();
|
|
metaDataPacket.entityId = getEntityId();
|
|
metaDataPacket.consumer = getMetadataConsumer();
|
|
return metaDataPacket;
|
|
}
|
|
|
|
/**
|
|
* Should be override when wanting to add a new metadata index
|
|
*
|
|
* @return The consumer used to write {@link EntityMetaDataPacket} in {@link #getMetadataPacket()}
|
|
*/
|
|
@NotNull
|
|
public Consumer<BinaryWriter> getMetadataConsumer() {
|
|
return packet -> {
|
|
fillMetadataIndex(packet, 0);
|
|
fillMetadataIndex(packet, 1);
|
|
fillMetadataIndex(packet, 2);
|
|
fillMetadataIndex(packet, 3);
|
|
fillMetadataIndex(packet, 4);
|
|
fillMetadataIndex(packet, 5);
|
|
fillMetadataIndex(packet, 6);
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Sends a {@link EntityMetaDataPacket} containing only the specified index
|
|
* The index is wrote using {@link #fillMetadataIndex(BinaryWriter, int)}.
|
|
*
|
|
* @param index the metadata index
|
|
*/
|
|
protected void sendMetadataIndex(int index) {
|
|
EntityMetaDataPacket metaDataPacket = new EntityMetaDataPacket();
|
|
metaDataPacket.entityId = getEntityId();
|
|
metaDataPacket.consumer = packet -> fillMetadataIndex(packet, index);
|
|
|
|
sendPacketToViewersAndSelf(metaDataPacket);
|
|
}
|
|
|
|
/**
|
|
* Used to fill/write a specific metadata index.
|
|
* The proper use to add a new metadata index is to override this and add your case.
|
|
* Then you can also override {@link #getMetadataConsumer()} and fill your newly added index.
|
|
*
|
|
* @param packet the packet writer
|
|
* @param index the index to fill/write
|
|
*/
|
|
protected void fillMetadataIndex(@NotNull BinaryWriter packet, int index) {
|
|
switch (index) {
|
|
case 0:
|
|
fillStateMetadata(packet);
|
|
break;
|
|
case 1:
|
|
fillAirTickMetaData(packet);
|
|
break;
|
|
case 2:
|
|
fillCustomNameMetaData(packet);
|
|
break;
|
|
case 3:
|
|
fillCustomNameVisibleMetaData(packet);
|
|
break;
|
|
case 4:
|
|
fillSilentMetaData(packet);
|
|
break;
|
|
case 5:
|
|
fillNoGravityMetaData(packet);
|
|
break;
|
|
case 6:
|
|
fillPoseMetaData(packet);
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void fillStateMetadata(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 0);
|
|
packet.writeByte(METADATA_BYTE);
|
|
byte index0 = 0;
|
|
if (onFire)
|
|
index0 += 1;
|
|
if (crouched)
|
|
index0 += 2;
|
|
if (UNUSED_METADATA)
|
|
index0 += 4;
|
|
if (sprinting)
|
|
index0 += 8;
|
|
if (swimming)
|
|
index0 += 16;
|
|
if (invisible)
|
|
index0 += 32;
|
|
if (glowing)
|
|
index0 += 64;
|
|
if (usingElytra)
|
|
index0 += 128;
|
|
packet.writeByte(index0);
|
|
}
|
|
|
|
private void fillAirTickMetaData(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 1);
|
|
packet.writeByte(METADATA_VARINT);
|
|
packet.writeVarInt(air);
|
|
}
|
|
|
|
private void fillCustomNameMetaData(@NotNull BinaryWriter packet) {
|
|
boolean hasCustomName = customName != null;
|
|
|
|
packet.writeByte((byte) 2);
|
|
packet.writeByte(METADATA_OPTCHAT);
|
|
packet.writeBoolean(hasCustomName);
|
|
if (hasCustomName) {
|
|
packet.writeSizedString(customName.toString());
|
|
}
|
|
}
|
|
|
|
private void fillCustomNameVisibleMetaData(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 3);
|
|
packet.writeByte(METADATA_BOOLEAN);
|
|
packet.writeBoolean(customNameVisible);
|
|
}
|
|
|
|
private void fillSilentMetaData(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 4);
|
|
packet.writeByte(METADATA_BOOLEAN);
|
|
packet.writeBoolean(silent);
|
|
}
|
|
|
|
private void fillNoGravityMetaData(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 5);
|
|
packet.writeByte(METADATA_BOOLEAN);
|
|
packet.writeBoolean(noGravity);
|
|
}
|
|
|
|
private void fillPoseMetaData(@NotNull BinaryWriter packet) {
|
|
packet.writeByte((byte) 6);
|
|
packet.writeByte(METADATA_POSE);
|
|
packet.writeVarInt(pose.ordinal());
|
|
}
|
|
|
|
protected void sendSynchronization() {
|
|
EntityTeleportPacket entityTeleportPacket = new EntityTeleportPacket();
|
|
entityTeleportPacket.entityId = getEntityId();
|
|
entityTeleportPacket.position = getPosition().clone();
|
|
entityTeleportPacket.onGround = isOnGround();
|
|
sendPacketToViewers(entityTeleportPacket);
|
|
}
|
|
|
|
/**
|
|
* Asks for a synchronization (position) to happen during next entity tick.
|
|
*/
|
|
public void askSynchronization() {
|
|
this.lastAbsoluteSynchronizationTime = 0;
|
|
}
|
|
|
|
public enum Pose {
|
|
STANDING,
|
|
FALL_FLYING,
|
|
SLEEPING,
|
|
SWIMMING,
|
|
SPIN_ATTACK,
|
|
SNEAKING,
|
|
DYING
|
|
}
|
|
|
|
protected boolean shouldRemove() {
|
|
return shouldRemove;
|
|
}
|
|
}
|