mirror of https://github.com/GeyserMC/Geyser.git
434 lines
20 KiB
Java
434 lines
20 KiB
Java
/*
|
||
* Copyright (c) 2019-2021 GeyserMC. http://geysermc.org
|
||
*
|
||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
* of this software and associated documentation files (the "Software"), to deal
|
||
* in the Software without restriction, including without limitation the rights
|
||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
* copies of the Software, and to permit persons to whom the Software is
|
||
* furnished to do so, subject to the following conditions:
|
||
*
|
||
* The above copyright notice and this permission notice shall be included in
|
||
* all copies or substantial portions of the Software.
|
||
*
|
||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
* THE SOFTWARE.
|
||
*
|
||
* @author GeyserMC
|
||
* @link https://github.com/GeyserMC/Geyser
|
||
*/
|
||
|
||
package org.geysermc.connector.network.translators.collision;
|
||
|
||
import com.nukkitx.math.vector.Vector3d;
|
||
import com.nukkitx.math.vector.Vector3f;
|
||
import com.nukkitx.math.vector.Vector3i;
|
||
import com.nukkitx.protocol.bedrock.data.entity.EntityData;
|
||
import com.nukkitx.protocol.bedrock.data.entity.EntityFlag;
|
||
import com.nukkitx.protocol.bedrock.data.entity.EntityFlags;
|
||
import com.nukkitx.protocol.bedrock.packet.MovePlayerPacket;
|
||
import com.nukkitx.protocol.bedrock.packet.SetEntityDataPacket;
|
||
import lombok.Getter;
|
||
import lombok.Setter;
|
||
import org.geysermc.connector.entity.player.PlayerEntity;
|
||
import org.geysermc.connector.entity.type.EntityType;
|
||
import org.geysermc.connector.network.session.GeyserSession;
|
||
import org.geysermc.connector.network.session.cache.PistonCache;
|
||
import org.geysermc.connector.network.translators.collision.translators.BlockCollision;
|
||
import org.geysermc.connector.network.translators.collision.translators.ScaffoldingCollision;
|
||
import org.geysermc.connector.network.translators.world.block.BlockStateValues;
|
||
import org.geysermc.connector.utils.BlockUtils;
|
||
import org.geysermc.connector.utils.Axis;
|
||
|
||
import java.text.DecimalFormat;
|
||
import java.text.DecimalFormatSymbols;
|
||
import java.util.ArrayList;
|
||
import java.util.List;
|
||
import java.util.Locale;
|
||
|
||
public class CollisionManager {
|
||
|
||
private final GeyserSession session;
|
||
|
||
@Getter
|
||
private final BoundingBox playerBoundingBox;
|
||
|
||
/**
|
||
* Whether the player is inside scaffolding
|
||
*/
|
||
@Setter
|
||
private boolean touchingScaffolding;
|
||
|
||
/**
|
||
* Whether the player is on top of scaffolding
|
||
*/
|
||
@Setter
|
||
private boolean onScaffolding;
|
||
|
||
/**
|
||
* Additional space where blocks are checked, which is helpful for fixing NoCheatPlus's Passable check.
|
||
* This check doesn't allow players right up against the block, so they must be pushed slightly away.
|
||
*/
|
||
public static final double COLLISION_TOLERANCE = 0.00001;
|
||
/**
|
||
* Trims Y coordinates when jumping to prevent rounding issues being sent to the server.
|
||
* The locale used is necessary so other regions don't use <code>,</code> as their decimal separator.
|
||
*/
|
||
private static final DecimalFormat DECIMAL_FORMAT = new DecimalFormat("#.#####", new DecimalFormatSymbols(Locale.ENGLISH));
|
||
|
||
private static final double PLAYER_STEP_UP = 0.6;
|
||
|
||
/**
|
||
* The maximum squared distance between a Bedrock players' movement and our predicted movement before
|
||
* the player is teleported to the correct position
|
||
*/
|
||
private static final double INCORRECT_MOVEMENT_THRESHOLD = 0.08;
|
||
|
||
public CollisionManager(GeyserSession session) {
|
||
this.session = session;
|
||
this.playerBoundingBox = new BoundingBox(0, 0, 0, 0.6, 1.8, 0.6);
|
||
}
|
||
|
||
/**
|
||
* Updates the stored bounding box
|
||
* @param position The new position of the player
|
||
*/
|
||
public void updatePlayerBoundingBox(Vector3f position) {
|
||
updatePlayerBoundingBox(position.toDouble());
|
||
}
|
||
|
||
/**
|
||
* Updates the stored bounding box
|
||
* @param position The new position of the player
|
||
*/
|
||
public void updatePlayerBoundingBox(Vector3d position) {
|
||
updatePlayerBoundingBox();
|
||
|
||
playerBoundingBox.setMiddleX(position.getX());
|
||
playerBoundingBox.setMiddleY(position.getY() + (playerBoundingBox.getSizeY() / 2));
|
||
playerBoundingBox.setMiddleZ(position.getZ());
|
||
}
|
||
|
||
/**
|
||
* Updates the height of the stored bounding box
|
||
*/
|
||
public void updatePlayerBoundingBox() {
|
||
// According to the Minecraft Wiki, when sneaking:
|
||
// - In Bedrock Edition, the height becomes 1.65 blocks, allowing movement through spaces as small as 1.75 (2 - 1⁄4) blocks high.
|
||
// - In Java Edition, the height becomes 1.5 blocks.
|
||
// Other instances have the player's bounding box become as small as 0.6 or 0.2.
|
||
double playerHeight = session.getPlayerEntity().getMetadata().getFloat(EntityData.BOUNDING_BOX_HEIGHT);
|
||
playerBoundingBox.setMiddleY(playerBoundingBox.getMiddleY() - (playerBoundingBox.getSizeY() / 2.0) + (playerHeight / 2.0));
|
||
playerBoundingBox.setSizeY(playerHeight);
|
||
}
|
||
|
||
/**
|
||
* Adjust the Bedrock position before sending to the Java server to account for inaccuracies in movement between
|
||
* the two versions. Will also send corrected movement packets back to Bedrock if they collide with pistons.
|
||
*
|
||
* @param bedrockPosition the current Bedrock position of the client
|
||
* @param onGround whether the Bedrock player is on the ground
|
||
* @return the position to send to the Java server, or null to cancel sending the packet
|
||
*/
|
||
public Vector3d adjustBedrockPosition(Vector3f bedrockPosition, boolean onGround) {
|
||
PistonCache pistonCache = session.getPistonCache();
|
||
// Bedrock clients tend to fall off of honey blocks, so we need to teleport them to the new position
|
||
if (pistonCache.isPlayerAttachedToHoney()) {
|
||
return null;
|
||
}
|
||
// We need to parse the float as a string since casting a float to a double causes us to
|
||
// lose precision and thus, causes players to get stuck when walking near walls
|
||
double javaY = bedrockPosition.getY() - EntityType.PLAYER.getOffset();
|
||
|
||
Vector3d position = Vector3d.from(Double.parseDouble(Float.toString(bedrockPosition.getX())), javaY,
|
||
Double.parseDouble(Float.toString(bedrockPosition.getZ())));
|
||
|
||
Vector3d startingPos = playerBoundingBox.getBottomCenter();
|
||
Vector3d movement = position.sub(startingPos);
|
||
Vector3d adjustedMovement = correctPlayerMovement(movement, false);
|
||
playerBoundingBox.translate(adjustedMovement.getX(), adjustedMovement.getY(), adjustedMovement.getZ());
|
||
playerBoundingBox.translate(pistonCache.getPlayerMotion().getX(), pistonCache.getPlayerMotion().getY(), pistonCache.getPlayerMotion().getZ());
|
||
// Correct player position
|
||
if (!correctPlayerPosition()) {
|
||
// Cancel the movement if it needs to be cancelled
|
||
recalculatePosition();
|
||
return null;
|
||
}
|
||
// The server can't complain about our movement if we never send it
|
||
// TODO get rid of this and handle teleports smoothly
|
||
if (pistonCache.isPlayerCollided()) {
|
||
return null;
|
||
}
|
||
|
||
position = playerBoundingBox.getBottomCenter();
|
||
|
||
boolean newOnGround = adjustedMovement.getY() != movement.getY() && movement.getY() < 0 || onGround;
|
||
// Send corrected position to Bedrock if they differ by too much to prevent de-syncs
|
||
if (onGround != newOnGround || movement.distanceSquared(adjustedMovement) > INCORRECT_MOVEMENT_THRESHOLD) {
|
||
PlayerEntity playerEntity = session.getPlayerEntity();
|
||
if (pistonCache.getPlayerMotion().equals(Vector3f.ZERO) && !pistonCache.isPlayerSlimeCollision()) {
|
||
playerEntity.moveAbsolute(session, position.toFloat(), playerEntity.getRotation(), newOnGround, true);
|
||
}
|
||
}
|
||
|
||
if (!onGround) {
|
||
// Trim the position to prevent rounding errors that make Java think we are clipping into a block
|
||
position = Vector3d.from(position.getX(), Double.parseDouble(DECIMAL_FORMAT.format(position.getY())), position.getZ());
|
||
}
|
||
|
||
return position;
|
||
}
|
||
|
||
// TODO: This makes the player look upwards for some reason, rotation values must be wrong
|
||
public void recalculatePosition() {
|
||
PlayerEntity entity = session.getPlayerEntity();
|
||
// Gravity might need to be reset...
|
||
SetEntityDataPacket entityDataPacket = new SetEntityDataPacket();
|
||
entityDataPacket.setRuntimeEntityId(entity.getGeyserId());
|
||
entityDataPacket.getMetadata().putAll(entity.getMetadata());
|
||
session.sendUpstreamPacket(entityDataPacket);
|
||
|
||
MovePlayerPacket movePlayerPacket = new MovePlayerPacket();
|
||
movePlayerPacket.setRuntimeEntityId(entity.getGeyserId());
|
||
movePlayerPacket.setPosition(entity.getPosition());
|
||
movePlayerPacket.setRotation(entity.getBedrockRotation());
|
||
movePlayerPacket.setMode(MovePlayerPacket.Mode.NORMAL);
|
||
session.sendUpstreamPacket(movePlayerPacket);
|
||
}
|
||
|
||
public List<Vector3i> getCollidableBlocks(BoundingBox box) {
|
||
List<Vector3i> blocks = new ArrayList<>();
|
||
|
||
Vector3d position = Vector3d.from(box.getMiddleX(),
|
||
box.getMiddleY() - (box.getSizeY() / 2),
|
||
box.getMiddleZ());
|
||
|
||
// Expand volume by 1 in each direction to include moving blocks
|
||
double pistonExpand = session.getPistonCache().getPistons().isEmpty() ? 0 : 1;
|
||
|
||
// Loop through all blocks that could collide
|
||
int minCollisionX = (int) Math.floor(position.getX() - ((box.getSizeX() / 2) + COLLISION_TOLERANCE + pistonExpand));
|
||
int maxCollisionX = (int) Math.floor(position.getX() + (box.getSizeX() / 2) + COLLISION_TOLERANCE + pistonExpand);
|
||
|
||
// Y extends 0.5 blocks down because of fence hitboxes
|
||
int minCollisionY = (int) Math.floor(position.getY() - 0.5 - COLLISION_TOLERANCE - pistonExpand / 2.0);
|
||
|
||
int maxCollisionY = (int) Math.floor(position.getY() + box.getSizeY() + pistonExpand);
|
||
|
||
int minCollisionZ = (int) Math.floor(position.getZ() - ((box.getSizeZ() / 2) + COLLISION_TOLERANCE + pistonExpand));
|
||
int maxCollisionZ = (int) Math.floor(position.getZ() + (box.getSizeZ() / 2) + COLLISION_TOLERANCE + pistonExpand);
|
||
|
||
for (int y = minCollisionY; y < maxCollisionY + 1; y++) {
|
||
for (int x = minCollisionX; x < maxCollisionX + 1; x++) {
|
||
for (int z = minCollisionZ; z < maxCollisionZ + 1; z++) {
|
||
blocks.add(Vector3i.from(x, y, z));
|
||
}
|
||
}
|
||
}
|
||
|
||
return blocks;
|
||
}
|
||
|
||
public List<Vector3i> getPlayerCollidableBlocks() {
|
||
return getCollidableBlocks(playerBoundingBox);
|
||
}
|
||
|
||
/**
|
||
* Returns false if the movement is invalid, and in this case it shouldn't be sent to the server and should be
|
||
* cancelled
|
||
* See {@link BlockCollision#correctPosition(GeyserSession, BoundingBox)} for more info
|
||
*/
|
||
public boolean correctPlayerPosition() {
|
||
|
||
// These may be set to true by the correctPosition method in ScaffoldingCollision
|
||
touchingScaffolding = false;
|
||
onScaffolding = false;
|
||
|
||
List<Vector3i> collidableBlocks = getPlayerCollidableBlocks();
|
||
|
||
// Used when correction code needs to be run before the main correction
|
||
for (Vector3i blockPos : collidableBlocks) {
|
||
BlockCollision blockCollision = BlockUtils.getCollisionAt(session, blockPos);
|
||
if (blockCollision != null) {
|
||
blockCollision.beforeCorrectPosition(playerBoundingBox);
|
||
blockCollision.reset();
|
||
}
|
||
}
|
||
|
||
// Main correction code
|
||
for (Vector3i blockPos : collidableBlocks) {
|
||
BlockCollision blockCollision = BlockUtils.getCollisionAt(session, blockPos);
|
||
if (blockCollision != null) {
|
||
if (!blockCollision.correctPosition(session, playerBoundingBox)) {
|
||
return false;
|
||
}
|
||
blockCollision.reset();
|
||
}
|
||
}
|
||
|
||
updateScaffoldingFlags(true);
|
||
|
||
return true;
|
||
}
|
||
|
||
public Vector3d correctPlayerMovement(Vector3d movement, boolean checkWorld) {
|
||
if (!checkWorld && session.getPistonCache().getPistons().isEmpty()) { // There is nothing to check
|
||
return movement;
|
||
}
|
||
return correctMovement(movement, playerBoundingBox, session.getPlayerEntity().isOnGround(), PLAYER_STEP_UP, checkWorld);
|
||
}
|
||
|
||
public Vector3d correctMovement(Vector3d movement, BoundingBox boundingBox, boolean onGround, double stepUp, boolean checkWorld) {
|
||
Vector3d adjustedMovement = movement;
|
||
if (!movement.equals(Vector3d.ZERO)) {
|
||
adjustedMovement = correctMovementForCollisions(movement, boundingBox, checkWorld);
|
||
}
|
||
|
||
boolean verticalCollision = adjustedMovement.getY() != movement.getY();
|
||
boolean horizontalCollision = adjustedMovement.getX() != movement.getX() || adjustedMovement.getZ() != movement.getZ();
|
||
boolean falling = movement.getY() < 0;
|
||
onGround = onGround || (verticalCollision && falling);
|
||
if (onGround && horizontalCollision) {
|
||
Vector3d horizontalMovement = Vector3d.from(movement.getX(), 0, movement.getZ());
|
||
Vector3d stepUpMovement = correctMovementForCollisions(horizontalMovement.up(stepUp), boundingBox, checkWorld);
|
||
|
||
BoundingBox stretchedBoundingBox = boundingBox.clone();
|
||
stretchedBoundingBox.extend(horizontalMovement);
|
||
double maxStepUp = correctMovementForCollisions(Vector3d.from(0, stepUp, 0), stretchedBoundingBox, checkWorld).getY();
|
||
if (maxStepUp < stepUp) { // The player collided with a block above them
|
||
boundingBox.translate(0, maxStepUp, 0);
|
||
Vector3d adjustedStepUpMovement = correctMovementForCollisions(horizontalMovement, boundingBox, checkWorld);
|
||
boundingBox.translate(0, -maxStepUp, 0);
|
||
|
||
if (squaredHorizontalLength(adjustedStepUpMovement) > squaredHorizontalLength(stepUpMovement)) {
|
||
stepUpMovement = adjustedStepUpMovement.up(maxStepUp);
|
||
}
|
||
}
|
||
|
||
if (squaredHorizontalLength(stepUpMovement) > squaredHorizontalLength(adjustedMovement)) {
|
||
boundingBox.translate(stepUpMovement.getX(), stepUpMovement.getY(), stepUpMovement.getZ());
|
||
// Apply the player's remaining vertical movement
|
||
double verticalMovement = correctMovementForCollisions(Vector3d.from(0, movement.getY() - stepUpMovement.getY(), 0), boundingBox, checkWorld).getY();
|
||
boundingBox.translate(-stepUpMovement.getX(), -stepUpMovement.getY(), -stepUpMovement.getZ());
|
||
|
||
stepUpMovement = stepUpMovement.up(verticalMovement);
|
||
adjustedMovement = stepUpMovement;
|
||
}
|
||
}
|
||
return adjustedMovement;
|
||
}
|
||
|
||
private double squaredHorizontalLength(Vector3d vector) {
|
||
return vector.getX() * vector.getX() + vector.getZ() * vector.getZ();
|
||
}
|
||
|
||
private Vector3d correctMovementForCollisions(Vector3d movement, BoundingBox boundingBox, boolean checkWorld) {
|
||
double movementX = movement.getX();
|
||
double movementY = movement.getY();
|
||
double movementZ = movement.getZ();
|
||
|
||
BoundingBox movementBoundingBox = boundingBox.clone();
|
||
movementBoundingBox.extend(movement);
|
||
|
||
List<Vector3i> collidableBlocks = getCollidableBlocks(movementBoundingBox);
|
||
|
||
if (Math.abs(movementY) > CollisionManager.COLLISION_TOLERANCE) {
|
||
movementY = computeCollisionOffset(boundingBox, Axis.Y, movementY, collidableBlocks, checkWorld);
|
||
boundingBox.translate(0, movementY, 0);
|
||
}
|
||
boolean checkZFirst = Math.abs(movementZ) > Math.abs(movementX);
|
||
if (checkZFirst && Math.abs(movementZ) > CollisionManager.COLLISION_TOLERANCE) {
|
||
movementZ = computeCollisionOffset(boundingBox, Axis.Z, movementZ, collidableBlocks, checkWorld);
|
||
boundingBox.translate(0, 0, movementZ);
|
||
}
|
||
if (Math.abs(movementX) > CollisionManager.COLLISION_TOLERANCE) {
|
||
movementX = computeCollisionOffset(boundingBox, Axis.X, movementX, collidableBlocks, checkWorld);
|
||
boundingBox.translate(movementX, 0, 0);
|
||
}
|
||
if (!checkZFirst && Math.abs(movementZ) > CollisionManager.COLLISION_TOLERANCE) {
|
||
movementZ = computeCollisionOffset(boundingBox, Axis.Z, movementZ, collidableBlocks, checkWorld);
|
||
boundingBox.translate(0, 0, movementZ);
|
||
}
|
||
|
||
boundingBox.translate(-movementX, -movementY, -movementZ);
|
||
return Vector3d.from(movementX, movementY, movementZ);
|
||
}
|
||
|
||
private double computeCollisionOffset(BoundingBox boundingBox, Axis axis, double offset, List<Vector3i> collidableBlocks, boolean checkWorld) {
|
||
for (Vector3i blockPos : collidableBlocks) {
|
||
if (checkWorld) {
|
||
BlockCollision blockCollision = BlockUtils.getCollisionAt(session, blockPos);
|
||
if (blockCollision != null && !(blockCollision instanceof ScaffoldingCollision)) {
|
||
offset = blockCollision.computeCollisionOffset(boundingBox, axis, offset);
|
||
blockCollision.reset();
|
||
}
|
||
}
|
||
offset = session.getPistonCache().computeCollisionOffset(blockPos, boundingBox, axis, offset);
|
||
if (Math.abs(offset) < COLLISION_TOLERANCE) {
|
||
return 0;
|
||
}
|
||
}
|
||
return offset;
|
||
}
|
||
|
||
/**
|
||
* @return true if the block located at the player's floor position plus 1 would intersect with the player,
|
||
* were they not sneaking
|
||
*/
|
||
public boolean isUnderSlab() {
|
||
Vector3i position = session.getPlayerEntity().getPosition().toInt();
|
||
BlockCollision collision = BlockUtils.getCollisionAt(session, position);
|
||
if (collision != null) {
|
||
// Determine, if the player's bounding box *were* at full height, if it would intersect with the block
|
||
// at the current location.
|
||
double originalY = playerBoundingBox.getMiddleY();
|
||
double originalHeight = playerBoundingBox.getSizeY();
|
||
double standingY = originalY - (originalHeight / 2.0) + (EntityType.PLAYER.getHeight() / 2.0);
|
||
|
||
playerBoundingBox.setSizeY(EntityType.PLAYER.getHeight());
|
||
playerBoundingBox.setMiddleY(standingY);
|
||
boolean result = collision.checkIntersection(playerBoundingBox);
|
||
result |= session.getPistonCache().checkCollision(position, playerBoundingBox);
|
||
collision.reset();
|
||
playerBoundingBox.setSizeY(originalHeight);
|
||
playerBoundingBox.setMiddleY(originalY);
|
||
return result;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* @return if the player is currently in a water block
|
||
*/
|
||
public boolean isPlayerInWater() {
|
||
return session.getConnector().getWorldManager().getBlockAt(session, session.getPlayerEntity().getPosition().toInt()) == BlockStateValues.JAVA_WATER_ID;
|
||
}
|
||
|
||
/**
|
||
* Updates scaffolding entity flags
|
||
* Scaffolding needs to be checked per-move since it's a flag in Bedrock but Java does it client-side
|
||
*
|
||
* @param updateMetadata whether we should update metadata if something changed
|
||
*/
|
||
public void updateScaffoldingFlags(boolean updateMetadata) {
|
||
EntityFlags flags = session.getPlayerEntity().getMetadata().getFlags();
|
||
boolean flagsChanged;
|
||
boolean isSneakingWithScaffolding = (touchingScaffolding || onScaffolding) && session.isSneaking();
|
||
|
||
flagsChanged = flags.setFlag(EntityFlag.OVER_DESCENDABLE_BLOCK, onScaffolding);
|
||
flagsChanged |= flags.setFlag(EntityFlag.IN_ASCENDABLE_BLOCK, touchingScaffolding);
|
||
flagsChanged |= flags.setFlag(EntityFlag.OVER_SCAFFOLDING, isSneakingWithScaffolding);
|
||
|
||
flagsChanged |= flags.setFlag(EntityFlag.IN_SCAFFOLDING, touchingScaffolding);
|
||
|
||
if (flagsChanged && updateMetadata) {
|
||
session.getPlayerEntity().updateBedrockMetadata(session);
|
||
}
|
||
}
|
||
}
|