From baf212f894c1f1249836ae4ee7a5ea9aecc25a73 Mon Sep 17 00:00:00 2001 From: i509VCB Date: Fri, 5 Jun 2020 03:37:02 -0700 Subject: [PATCH] Document chunk tickets (#1408) * Document chunk tickets * Update mappings/net/minecraft/server/world/ChunkTicketManager.mapping Co-authored-by: liach <7806504+liach@users.noreply.github.com> * Revert rename here Co-authored-by: liach <7806504+liach@users.noreply.github.com> --- .../net/minecraft/server/world/ChunkTicket.mapping | 1 + .../server/world/ChunkTicketManager.mapping | 1 + .../minecraft/server/world/ChunkTicketType.mapping | 13 +++++++++++++ .../server/world/ServerChunkManager.mapping | 14 ++++++++++++++ 4 files changed, 29 insertions(+) diff --git a/mappings/net/minecraft/server/world/ChunkTicket.mapping b/mappings/net/minecraft/server/world/ChunkTicket.mapping index b083763b95..d7ff93a2c5 100644 --- a/mappings/net/minecraft/server/world/ChunkTicket.mapping +++ b/mappings/net/minecraft/server/world/ChunkTicket.mapping @@ -1,4 +1,5 @@ CLASS net/minecraft/class_3228 net/minecraft/server/world/ChunkTicket + COMMENT Represents a chunk ticket, which specifies the reason a chunk has been loaded. FIELD field_14022 argument Ljava/lang/Object; FIELD field_14023 type Lnet/minecraft/class_3230; FIELD field_14024 tickCreated J diff --git a/mappings/net/minecraft/server/world/ChunkTicketManager.mapping b/mappings/net/minecraft/server/world/ChunkTicketManager.mapping index cec04f2cec..f8cb16fcd8 100644 --- a/mappings/net/minecraft/server/world/ChunkTicketManager.mapping +++ b/mappings/net/minecraft/server/world/ChunkTicketManager.mapping @@ -30,6 +30,7 @@ CLASS net/minecraft/class_3204 net/minecraft/server/world/ChunkTicketManager METHOD method_14046 getLevel (Lnet/minecraft/class_4706;)I METHOD method_14048 handleChunkEnter (Lnet/minecraft/class_4076;Lnet/minecraft/class_3222;)V ARG 1 pos + ARG 2 player METHOD method_14049 setWatchDistance (I)V ARG 1 viewDistance METHOD method_14050 getTicketSet (J)Lnet/minecraft/class_4706; diff --git a/mappings/net/minecraft/server/world/ChunkTicketType.mapping b/mappings/net/minecraft/server/world/ChunkTicketType.mapping index dfaf08351b..49411fd4b4 100644 --- a/mappings/net/minecraft/server/world/ChunkTicketType.mapping +++ b/mappings/net/minecraft/server/world/ChunkTicketType.mapping @@ -1,14 +1,27 @@ CLASS net/minecraft/class_3230 net/minecraft/server/world/ChunkTicketType FIELD field_14029 argumentComparator Ljava/util/Comparator; + FIELD field_14031 Lnet/minecraft/class_3230; + COMMENT Used to force load chunks. + FIELD field_14032 Lnet/minecraft/class_3230; + COMMENT Represents a type of ticket that has an unknown cause for loading chunks. FIELD field_14034 name Ljava/lang/String; + FIELD field_17264 Lnet/minecraft/class_3230; + COMMENT Used by the ender dragon to load the central end island during the boss battle. + FIELD field_19280 Lnet/minecraft/class_3230; + COMMENT Used by a nether portal to load chunks in the other dimension. + FIELD field_19347 Lnet/minecraft/class_3230; + COMMENT Used to load the chunks at the destination of teleportation. FIELD field_19348 expiryTicks J METHOD (Ljava/lang/String;Ljava/util/Comparator;J)V ARG 1 name ARG 3 expiryTicks METHOD method_14291 create (Ljava/lang/String;Ljava/util/Comparator;)Lnet/minecraft/class_3230; + COMMENT Creates a new ticket type that does not expire. ARG 0 name METHOD method_14292 getArgumentComparator ()Ljava/util/Comparator; METHOD method_20628 create (Ljava/lang/String;Ljava/util/Comparator;I)Lnet/minecraft/class_3230; + COMMENT Create a new ticket type that expires after an amount of ticks. ARG 0 name ARG 2 expiryTicks + COMMENT the expiry time in ticks, does not expire if 0 METHOD method_20629 getExpiryTicks ()J diff --git a/mappings/net/minecraft/server/world/ServerChunkManager.mapping b/mappings/net/minecraft/server/world/ServerChunkManager.mapping index c6f5d37059..a9bd16ab6a 100644 --- a/mappings/net/minecraft/server/world/ServerChunkManager.mapping +++ b/mappings/net/minecraft/server/world/ServerChunkManager.mapping @@ -41,6 +41,13 @@ CLASS net/minecraft/class_3215 net/minecraft/server/world/ServerChunkManager METHOD method_14161 tickChunks ()V METHOD method_16155 tick ()Z METHOD method_17297 addTicket (Lnet/minecraft/class_3230;Lnet/minecraft/class_1923;ILjava/lang/Object;)V + COMMENT Adds a chunk ticket to the ticket manager. + COMMENT + COMMENT

Addition of a ticket may load chunk(s) at some point in the future depending on the loading level in the ticket's vicinity. + ARG 1 ticketType + ARG 2 pos + ARG 3 radius + ARG 4 argument METHOD method_17298 save (Z)V ARG 1 flush METHOD method_17299 getChunkFutureSyncOnMainThread (IILnet/minecraft/class_2806;Z)Ljava/util/concurrent/CompletableFuture; @@ -49,6 +56,13 @@ CLASS net/minecraft/class_3215 net/minecraft/server/world/ServerChunkManager ARG 3 leastStatus ARG 4 create METHOD method_17300 removeTicket (Lnet/minecraft/class_3230;Lnet/minecraft/class_1923;ILjava/lang/Object;)V + COMMENT Removes a chunk ticket from the ticket manager. + COMMENT + COMMENT

Removal of a ticket may unload chunk(s) at some point in the future depending on the loading levels in the ticket's vicinity after removal. + ARG 1 ticketType + ARG 2 pos + ARG 3 radius + ARG 4 argument METHOD method_17301 getTotalChunksLoadedCount ()I METHOD method_17981 getPersistentStateManager ()Lnet/minecraft/class_26; METHOD method_18751 sendToNearbyPlayers (Lnet/minecraft/class_1297;Lnet/minecraft/class_2596;)V