Files
knockback-sync/common/src/main/java/me/caseload/knockbacksync/player/PlayerData.java
T
2024-10-28 00:43:53 -04:00

382 lines
16 KiB
Java

package me.caseload.knockbacksync.player;
import com.github.retrooper.packetevents.PacketEvents;
import com.github.retrooper.packetevents.manager.player.PlayerManager;
import com.github.retrooper.packetevents.manager.server.ServerVersion;
import com.github.retrooper.packetevents.netty.channel.ChannelHelper;
import com.github.retrooper.packetevents.protocol.ConnectionState;
import com.github.retrooper.packetevents.protocol.player.ClientVersion;
import com.github.retrooper.packetevents.protocol.player.User;
import com.github.retrooper.packetevents.protocol.world.BoundingBox;
import com.github.retrooper.packetevents.protocol.world.states.WrappedBlockState;
import com.github.retrooper.packetevents.protocol.world.states.type.StateTypes;
import com.github.retrooper.packetevents.util.Vector3d;
import com.github.retrooper.packetevents.wrapper.PacketWrapper;
import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerKeepAlive;
import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerPing;
import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerWindowConfirmation;
import lombok.Getter;
import lombok.Setter;
import me.caseload.knockbacksync.Base;
import me.caseload.knockbacksync.command.subcommand.ToggleOffGroundSubcommand;
import me.caseload.knockbacksync.event.KBSyncEventHandler;
import me.caseload.knockbacksync.event.events.ConfigReloadEvent;
import me.caseload.knockbacksync.event.events.ToggleOnOffEvent;
import me.caseload.knockbacksync.manager.CombatManager;
import me.caseload.knockbacksync.scheduler.AbstractTaskHandle;
import me.caseload.knockbacksync.util.MathUtil;
import me.caseload.knockbacksync.util.data.Pair;
import me.caseload.knockbacksync.world.PlatformWorld;
import me.caseload.knockbacksync.world.raytrace.FluidHandling;
import me.caseload.knockbacksync.world.raytrace.RayTraceResult;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.*;
@Getter
public class PlayerData {
// Please read the GitHub FAQ before adjusting.
private static final short MAIN_THREAD_TRANSACTION_ID = 31407;
private static final short NETTY_THREAD_TRANSACTION_ID = 31408;
public static final long PING_OFFSET = 25;
private static Field playerField;
public final List<Pair<Integer, Long>> transactionsSent = new LinkedList<>();
public final List<Pair<Long, Long>> keepaliveMap = new LinkedList<>();
private static Object grimPlayerDataManager = null;
private static Method getGrimPlayerFromUserMethod = null;
static {
try {
switch (Base.INSTANCE.getPlatform()) {
case BUKKIT:
case FOLIA:
Class<?> bukkitPlayerClass = Class.forName("me.caseload.knockbacksync.player.BukkitPlayer");
playerField = bukkitPlayerClass.getDeclaredField("bukkitPlayer");
break;
case FABRIC:
Class<?> fabricPlayerClass = Class.forName("me.caseload.knockbacksync.player.FabricPlayer");
playerField = fabricPlayerClass.getDeclaredField("fabricPlayer");
break;
default:
throw new IllegalStateException("Unexpected platform: " + Base.INSTANCE.getPlatform());
}
playerField.setAccessible(true);
// Step 1: Get the GrimAPI enum class dynamically
Class<?> grimAPIClass = Class.forName("ac.grim.grimac.GrimAPI");
// Step 2: Access the INSTANCE of GrimAPI (it's a singleton enum)
Object grimAPIInstance = Enum.valueOf((Class<? extends Enum>) grimAPIClass, "INSTANCE");
// Step 3: Get the PlayerDataManager instance
Method getPlayerDataManagerMethod = grimAPIClass.getDeclaredMethod("getPlayerDataManager");
grimPlayerDataManager = getPlayerDataManagerMethod.invoke(grimAPIInstance);
// Step 4: Get the getPlayer method from PlayerDataManager
Class<?> playerDataManagerClass = grimPlayerDataManager.getClass();
getGrimPlayerFromUserMethod = playerDataManagerClass.getDeclaredMethod("getPlayer", Class.forName("org.bukkit.entity.Player"));
} catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InvocationTargetException | NoSuchFieldException e) {
e.printStackTrace();
}
}
public final User user;
private final PlatformPlayer platformPlayer;
private final UUID uuid;
@NotNull private final Random random = new Random();
public long lastKeepAliveID = 0;
@Getter private final JitterCalculator jitterCalculator = new JitterCalculator();
@Setter private double jitter;
@Nullable private AbstractTaskHandle combatTask;
@Nullable @Setter private Double ping, previousPing;
@Nullable @Setter private Double verticalVelocity;
@Nullable @Setter private Integer lastDamageTicks;
@Setter private double gravityAttribute = 0.08;
@Setter private double knockbackResistanceAttribute = 0.0;
public PlayerData(PlatformPlayer platformPlayer) {
this.uuid = platformPlayer.getUUID();
this.platformPlayer = platformPlayer;
User tempUser = null;
PlayerManager playerManager = PacketEvents.getAPI().getPlayerManager();
Object player = null;
try {
player = playerField.get(platformPlayer);
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
}
if (player != null) {
tempUser = playerManager.getUser(player);
}
this.user = tempUser;
}
public double getNotNullPing() {
return ping != null ? ping : platformPlayer.getPing();
}
public double getNotNullPreviousPing() {
return previousPing != null ? previousPing : platformPlayer.getPing();
}
/**
* Calculates the player's ping with compensation for lag spikes.
* A hardcoded offset is applied for several reasons,
* read the GitHub FAQ before adjusting.
*
* @return The compensated ping, with a minimum of 1.
*/
public double getCompensatedPing() {
double ping = getNotNullPing();
double previousPing = getNotNullPreviousPing();
double spikeCompensatedPing = (ping - previousPing > Base.INSTANCE.getConfigManager().getSpikeThreshold()) ? previousPing : ping;
return Math.max(1, spikeCompensatedPing - PING_OFFSET);
}
public int getCompensatedTicks() {
return (int) Math.ceil(getCompensatedPing() * Base.INSTANCE.getTickRate() / 1000); // Multiply ping by seconds per tick
}
public int getTicks() {
return (int) Math.ceil(getNotNullPing() * Base.INSTANCE.getTickRate() / 1000); // Multiply ping by seconds per tick
}
public boolean isSpike() {
return (getNotNullPing() - getNotNullPreviousPing()) > Base.INSTANCE.getConfigManager().getSpikeThreshold();
}
public void sendPing(boolean async) {
if (user == null || user.getEncoderState() != ConnectionState.PLAY) return;
String pingStrategy = Base.INSTANCE.getConfigManager().getConfigWrapper().getString("ping_strategy", "KEEPALIVE");
switch (pingStrategy) {
case "KEEPALIVE":
long keepAliveID = async ? NETTY_THREAD_TRANSACTION_ID : MAIN_THREAD_TRANSACTION_ID;
if (async) {
ChannelHelper.runInEventLoop(user.getChannel(), () -> {
// We call sendPacket instead of writePacket because it flushes immediately
// Making our time measurement more accurate since we don't call, System.nanoTime(), wait until flush
// And then actually send packet
user.sendPacket(new WrapperPlayServerKeepAlive(keepAliveID));
});
} else {
user.sendPacket(new WrapperPlayServerKeepAlive(keepAliveID));
}
break;
case "PING":
case "TRANSACTION":
PacketWrapper<?> packet;
short pingTransactionID = async ? NETTY_THREAD_TRANSACTION_ID : MAIN_THREAD_TRANSACTION_ID;
if (PacketEvents.getAPI().getServerManager().getVersion().isNewerThanOrEquals(ServerVersion.V_1_17)) {
packet = new WrapperPlayServerPing(pingTransactionID);
} else {
packet = new WrapperPlayServerWindowConfirmation((byte) 0, pingTransactionID, false);
}
if (async) {
ChannelHelper.runInEventLoop(user.getChannel(), () -> {
user.writePacket(packet);
});
} else {
user.writePacket(packet);
}
break;
}
}
/**
* Determines if the Player is on the ground clientside, but not serverside
* <p>
* Returns <code>ping ≥ (tMax + tFall)</code> and <code>gDist ≤ 1.3</code>
* <p>
* Where:
* <ul>
* <li><code>ping</code>: Estimated latency</li>
* <li><code>tMax</code>: Time to reach maximum upward velocity</li>
* <li><code>tFall</code>: Time to fall to the ground</li>
* <li><code>gDist</code>: Distance to the ground</li>
* </ul>
*
* @param verticalVelocity The Player's current vertical velocity.
* @return <code>true</code> if the Player is on the ground; <code>false</code> otherwise.
*/
public boolean isOnGroundClientSide(double verticalVelocity, double distanceToGround) {
try {
if (getGrimPlayerFromUserMethod != null) {
// Step 5: Invoke getPlayer to get PlayerData
Object playerData = getGrimPlayerFromUserMethod.invoke(grimPlayerDataManager, playerField.get(platformPlayer));
// Step 6: Access the 'onGround' field in PlayerData
Field onGroundField = playerData.getClass().getDeclaredField("onGround");
onGroundField.setAccessible(true); // Bypass private access
System.out.println(this.platformPlayer.getName() + " is located at " + platformPlayer.getX() + ", " + platformPlayer.getY() + ", " + platformPlayer.getZ() + " serverside");
System.out.println("Grim onGround for player " + this.platformPlayer.getName() + " is " + onGroundField.get(playerData));
// Step 7: Get the value of the 'onGround' field
return (boolean) onGroundField.get(playerData);
}
} catch (NoSuchFieldException | IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
int tMax = verticalVelocity > 0 ? MathUtil.calculateTimeToMaxVelocity(verticalVelocity, gravityAttribute) : 0;
if (tMax == -1)
return false; // reached the max tick limit, not safe to predict
double mH = verticalVelocity > 0 ? MathUtil.calculateDistanceTraveled(verticalVelocity, tMax, gravityAttribute) : 0;
int tFall = MathUtil.calculateFallTime(verticalVelocity, mH + distanceToGround, gravityAttribute);
if (tFall == -1)
return false; // reached the max tick limit, not safe to predict
return (tMax + tFall) - getCompensatedTicks() <= 0 && distanceToGround <= 1.3;
}
/**
* Gets whether or not offGroundSynchronization is enabled for the player.
* @return <code>true</code> if enabled; <code>false</code> otherwise.
*/
public boolean isOffGroundSyncEnabled() {
// TODO, per-player offground sync toggles?
return ToggleOffGroundSubcommand.offGroundSyncEnabled;
}
/**
* Gets the compensated off-ground velocity.
* This is used to make knockback feel more accurate off-ground.
*
* @return Compensated Y axis velocity
*/
public double getCompensatedOffGroundVelocity() {
return MathUtil.getCompensatedVerticalVelocity(platformPlayer.getVelocity().getY(), getGravityAttribute(), getTicks());
}
/**
* Ray traces from each corner of the player's bounding box to the ground,
* returning the smallest distance, with a maximum limit of 5 blocks.
*
* @return The distance to the ground in blocks
*/
public double getDistanceToGround() {
double collisionDist = 5;
PlatformWorld world = platformPlayer.getWorld();
for (Vector3d corner : getBBCorners()) {
RayTraceResult result = world.rayTraceBlocks(corner, new Vector3d(0, -1, 0), 5, FluidHandling.NONE, true);
if (result == null || result.getHitBlock() == null)
continue;
collisionDist = Math.min(collisionDist, corner.getY() - result.getHitBlockPosition().getY());
}
return collisionDist - 1;
}
/**
* Gets the corners of the Player's bounding box.
*
* @return An array of locations representing the corners of the bounding box.
*/
private Vector3d[] getBBCorners() {
BoundingBox boundingBox = platformPlayer.getBoundingBox();
Vector3d location = platformPlayer.getLocation();
double adjustment = 0.01; // To ensure the bounding box isn't clipping inside a wall
return new Vector3d[] {
new Vector3d(boundingBox.getMinX() + adjustment, location.getY(), boundingBox.getMinZ() + adjustment),
new Vector3d(boundingBox.getMinX() + adjustment, location.getY(), boundingBox.getMaxZ() - adjustment),
new Vector3d(boundingBox.getMaxX() - adjustment, location.getY(), boundingBox.getMinZ() + adjustment),
new Vector3d(boundingBox.getMaxX() - adjustment, location.getY(), boundingBox.getMaxZ() - adjustment)
};
}
/**
* Calculates the positive vertical velocity.
* This is used to switch falling knockback to rising knockback.
*
* @param attacker The player who is attacking.
* @return The calculated positive vertical velocity, consistent with vanilla behavior.
*/
public double calculateVerticalVelocity(PlatformPlayer attacker) {
double yAxis = attacker.getAttackCooldown() > 0.848 ? 0.4 : 0.36080000519752503;
if (!attacker.isSprinting()) {
yAxis = 0.36080000519752503;
double resistanceFactor = 0.04000000119 * knockbackResistanceAttribute * 10;
yAxis -= resistanceFactor;
}
// vertical velocity is always 0.4 when you have knockback level higher than 0
if (attacker.getMainHandKnockbackLevel() > 0)
yAxis = 0.4;
return yAxis;
}
public boolean isInCombat() {
return combatTask != null;
}
public void updateCombat() {
if (isInCombat())
combatTask.cancel();
combatTask = newCombatTask();
CombatManager.addPlayer(uuid);
}
public void quitCombat() {
combatTask.cancel(); // should do nothing
combatTask = null;
CombatManager.removePlayer(uuid);
}
@NotNull
private AbstractTaskHandle newCombatTask() {
return Base.INSTANCE.getScheduler().runTaskLaterAsynchronously(
this::quitCombat, Base.INSTANCE.getConfigManager().getCombatTimer());
}
public ClientVersion getClientVersion() {
if (user == null)
return ClientVersion.UNKNOWN;
ClientVersion ver = user.getClientVersion();
if (ver == null) {
// If temporarily null, assume server version...
return ClientVersion.getById(PacketEvents.getAPI().getServerManager().getVersion().getProtocolVersion());
}
return ver;
}
public long getKeepAliveSendTime() {
return lastKeepAliveID;
}
public boolean didWeSendThatPacket(long receivedId) {
return receivedId == NETTY_THREAD_TRANSACTION_ID || receivedId == MAIN_THREAD_TRANSACTION_ID;
}
@KBSyncEventHandler
public void onToggledEvent(ToggleOnOffEvent event) {
if (event.getStatus() == false) {
transactionsSent.clear();
keepaliveMap.clear();
}
}
}