Paper/patches/api/0409-Win-Screen-API.patch
Jake Potrebic 29b17a892d
Updated Upstream (Bukkit/CraftBukkit/Spigot) (#9088)
Upstream has released updates that appear to apply and compile correctly.
This update has not been tested by PaperMC and as with ANY update, please do your own testing

Bukkit Changes:
5efeb7bd Also update compiler version
c13b867a Update some Maven plugin versions
deb28d9f PR-837: Add more bell API
e938d62a PR-819: Allow Player#sendBlockDamage() to specify a source entity
0e75532c PR-818: Add more Guardian API, particularly for its laser
a10155aa PR-839: Add BlockData#rotate and BlockData#mirror
77e690b4 PR-836: Add missing API for explosive minecarts
60722059 PR-832: Allow getting chunks without generating them and optimize chunk data request for ungenerated chunks
0a2c4b4b PR-834: Add Player#sendHurtAnimation()

CraftBukkit Changes:
be8682aa8 Also update compiler version
08e305f5b Update some Maven plugin versions
187bdd463 PR-1160: Add more bell API
2f8e5bc7c PR-1145: Allow Player#sendBlockDamage() to specify a source entity
bcbb61b36 PR-1144: Add more Guardian API, particularly for its laser
722ddff6d PR-1162: Add BlockData#rotate and BlockData#mirror
80998277c PR-1159: Add missing API for explosive minecarts
1fddefce1 PR-1155: Allow getting chunks without generating them and optimize chunk data request for ungenerated chunks
20e8a486f PR-1157: Add Player#sendHurtAnimation()

Spigot Changes:
b31949f2 Rebuild patches
2023-04-07 19:39:13 +01:00

59 lines
2.7 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Lama06 <andreasprues36@gmail.com>
Date: Sat, 21 Jan 2023 13:45:22 +0100
Subject: [PATCH] Win Screen API
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index 35f36e9ffa4ca2a8ce51ca905c575884dbb955a3..b3c488b2c632386f3f3e7b16ee0549350fffa681 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -875,6 +875,47 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
*/
public void sendMap(@NotNull MapView map);
+ // Paper start
+ /**
+ * Shows the player the win screen that normally is only displayed after one kills the ender dragon
+ * and exits the end for the first time.
+ * In vanilla, the win screen starts with a poem and then continues with the credits but its content can be
+ * changed by using a resource pack.
+ * <br>
+ * Calling this method does not change the value of {@link #hasSeenWinScreen()}.
+ * That means that the win screen is still displayed to a player if they leave the end for the first time, even though
+ * they have seen it before because this method was called.
+ * Note this method does not make the player invulnerable, which is normally expected when viewing credits.
+ *
+ * @see #hasSeenWinScreen()
+ * @see #setHasSeenWinScreen(boolean)
+ * @see <a href="https://minecraft.fandom.com/wiki/End_Poem#Technical_details">https://minecraft.fandom.com/wiki/End_Poem#Technical_details</a>
+ */
+ public void showWinScreen();
+
+ /**
+ * Returns whether this player has seen the win screen before.
+ * When a player leaves the end the win screen is shown to them if they have not seen it before.
+ *
+ * @return Whether this player has seen the win screen before
+ * @see #setHasSeenWinScreen(boolean)
+ * @see #showWinScreen()
+ * @see <a href="https://minecraft.fandom.com/wiki/End_Poem">https://minecraft.fandom.com/wiki/End_Poem</a>
+ */
+ public boolean hasSeenWinScreen();
+
+ /**
+ * Changes whether this player has seen the win screen before.
+ * When a player leaves the end the win screen is shown to them if they have not seen it before.
+ *
+ * @param hasSeenWinScreen Whether this player has seen the win screen before
+ * @see #hasSeenWinScreen()
+ * @see #showWinScreen()
+ * @see <a href="https://minecraft.fandom.com/wiki/End_Poem">https://minecraft.fandom.com/wiki/End_Poem</a>
+ */
+ public void setHasSeenWinScreen(boolean hasSeenWinScreen);
+ // Paper end
+
// Paper start
/**
* Permanently Bans the Profile and IP address currently used by the player.