Paper/patches/api/0454-API-for-checking-sent-chunks.patch

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Flo0 <flo.roma@web.de>
Date: Mon, 8 Apr 2024 16:22:07 +0200
Subject: [PATCH] API for checking sent chunks


diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index b3b6cdf5491397e0e802ac91f5805d560ed5d88a..20db14b3075d70b34eab16ca6332a2e674b34e75 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -3844,6 +3844,47 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
     void resetIdleDuration();
     // Paper end
 
+    // Paper start - Add chunk view API
+    /**
+     * Gets the a set of chunk keys for all chunks that have been sent to the player.
+     *
+     * @return an immutable set of chunk keys
+     * @apiNote currently marked as experimental to gather feedback regarding the returned set being an immutable copy
+     * vs it potentially being an unmodifiable view of the set chunks.
+     */
+    @ApiStatus.Experimental
+    java.util.@NotNull @org.jetbrains.annotations.Unmodifiable Set<Long> getSentChunkKeys();
+
+    /**
+     * Gets the set of chunks that have been sent to the player.
+     *
+     * @return an immutable set of chunks
+     * @apiNote currently marked as experimental to gather feedback regarding the returned set being an immutable copy
+      * vs it potentially being an unmodifiable view of the set chunks.
+     */
+    @ApiStatus.Experimental
+    java.util.@NotNull @org.jetbrains.annotations.Unmodifiable Set<org.bukkit.Chunk> getSentChunks();
+
+    /**
+     * Checks if the player has been sent a specific chunk.
+     *
+     * @param chunk the chunk to check
+     * @return true if the player has been sent the chunk, false otherwise
+     */
+    default boolean isChunkSent(@NotNull org.bukkit.Chunk chunk) {
+        return this.isChunkSent(chunk.getChunkKey());
+    }
+
+    /**
+     * Checks if the player has been sent a specific chunk.
+     *
+     * @param chunkKey the chunk key to check
+     * @return true if the player has been sent the chunk, false otherwise
+     * @see org.bukkit.Chunk#getChunkKey()
+     */
+    boolean isChunkSent(long chunkKey);
+    // Paper end
+
     @NotNull
     @Override
     Spigot spigot();