OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-28 15:30:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

Win Screen API

Browse source
This commit is contained in:
Lama06 2023-01-21 13:45:22 +01:00
parent e03e924177
commit 7e5c1f612a
1 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
paper-api/src/main/java/org/bukkit/entity/Player.java
View file

@ -1287,6 +1287,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.wiki/wiki/End_Poem#Technical_details">https://minecraft.wiki/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.wiki/wiki/End_Poem">https://minecraft.wiki/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.wiki/wiki/End_Poem">https://minecraft.wiki/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.