Paper/patches/api/0328-Add-player-health-update-API.patch
2023-06-08 12:35:20 -07:00

43 lines
1.8 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: SamB440 <sam@islandearth.net>
Date: Wed, 17 Nov 2021 12:30:36 +0000
Subject: [PATCH] Add player health update API
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index d4ecd3bdd9703adde0e5bad766e4776c003f4e35..529b2a524dafa17fdaa8dedaf551aec114a5cb7f 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -2075,6 +2075,31 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
*/
public double getHealthScale();
+ // Paper start
+ /**
+ * Forcefully sends a health update to the player.
+ * <p>This method can cause the client to display health values
+ * different to their true server values. If the player takes damage or
+ * causes an action to otherwise cause a health update, these values
+ * will no longer be shown.</p>
+ * Setting the visible health to 0 will result in the client seeing
+ * the death screen, unable to press the respawn button.
+ * @see #sendHealthUpdate()
+ * @param health the health of the player
+ * @param foodLevel the food level of the player
+ * @param saturationLevel the saturation level of the player
+ */
+ public void sendHealthUpdate(final double health, final int foodLevel, final float saturationLevel);
+
+ /**
+ * Forcefully sends a health update to the player.
+ * This uses the player's current health, saturation, and food level.
+ * <p>Use after {@link #setHealth(double)} to show the heart animation
+ * of gaining or losing health.</p>
+ */
+ public void sendHealthUpdate();
+ // Paper end
+
/**
* Gets the entity which is followed by the camera when in
* {@link GameMode#SPECTATOR}.