mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-03 05:26:50 +01:00
8c5b837e05
Firstly, the old methods all routed to the CompletableFuture method. However, the CF method could not guarantee that if the caller was off-main that the future would be "completed" on-main. Since the callback methods used the CF one, this meant that the callback methods did not guarantee that the callbacks were to be called on the main thread. Now, all methods route to getChunkAtAsync(x, z, gen, urgent, cb) so that the methods with the callback are guaranteed to invoke the callback on the main thread. The CF behavior remains unchanged; it may still appear to complete on main if invoked off-main. Secondly, remove the scheduleOnMain invocation in the async chunk completion. This unnecessarily delays the callback by 1 tick. Thirdly, add getChunksAtAsync(minX, minZ, maxX, maxZ, ...) which will load chunks within an area. This method is provided as a helper as keeping all chunks loaded within an area can be complicated to implement for plugins (due to the lacking ticket API), and is already implemented internally anyways. Fourthly, remove the ticket addition that occured with getChunkAt and getChunkAtAsync. The ticket addition may delay the unloading of the chunk unnecessarily. It also fixes a very rare timing bug where the future/callback would be completed after the chunk unloads.
213 lines
10 KiB
Diff
213 lines
10 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: syldium <syldium@mailo.com>
|
|
Date: Fri, 9 Jul 2021 18:50:40 +0200
|
|
Subject: [PATCH] Add more advancement API
|
|
|
|
== AT ==
|
|
public net.minecraft.advancements.Advancement decorateName(Lnet/minecraft/advancements/DisplayInfo;)Lnet/minecraft/network/chat/Component;
|
|
|
|
Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com>
|
|
|
|
diff --git a/src/main/java/io/papermc/paper/advancement/PaperAdvancementDisplay.java b/src/main/java/io/papermc/paper/advancement/PaperAdvancementDisplay.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..adac21ce6db3ff7a56dbcd6bffc02143c2db4046
|
|
--- /dev/null
|
|
+++ b/src/main/java/io/papermc/paper/advancement/PaperAdvancementDisplay.java
|
|
@@ -0,0 +1,69 @@
|
|
+package io.papermc.paper.advancement;
|
|
+
|
|
+import io.papermc.paper.adventure.PaperAdventure;
|
|
+import net.kyori.adventure.text.Component;
|
|
+import net.minecraft.advancements.Advancement;
|
|
+import net.minecraft.advancements.AdvancementType;
|
|
+import net.minecraft.advancements.DisplayInfo;
|
|
+import org.bukkit.NamespacedKey;
|
|
+import org.bukkit.craftbukkit.inventory.CraftItemStack;
|
|
+import org.bukkit.craftbukkit.util.CraftNamespacedKey;
|
|
+import org.bukkit.inventory.ItemStack;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+import org.jetbrains.annotations.Nullable;
|
|
+
|
|
+public record PaperAdvancementDisplay(DisplayInfo handle) implements AdvancementDisplay {
|
|
+
|
|
+ @Override
|
|
+ public @NotNull Frame frame() {
|
|
+ return asPaperFrame(this.handle.getType());
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @NotNull Component title() {
|
|
+ return PaperAdventure.asAdventure(this.handle.getTitle());
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @NotNull Component description() {
|
|
+ return PaperAdventure.asAdventure(this.handle.getDescription());
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @NotNull ItemStack icon() {
|
|
+ return CraftItemStack.asBukkitCopy(this.handle.getIcon());
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean doesShowToast() {
|
|
+ return this.handle.shouldShowToast();
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean doesAnnounceToChat() {
|
|
+ return this.handle.shouldAnnounceChat();
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean isHidden() {
|
|
+ return this.handle.isHidden();
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @Nullable NamespacedKey backgroundPath() {
|
|
+ return this.handle.getBackground().map(CraftNamespacedKey::fromMinecraft).orElse(null);
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public @NotNull Component displayName() {
|
|
+ return PaperAdventure.asAdventure(Advancement.decorateName(java.util.Objects.requireNonNull(this.handle, "cannot build display name for null handle, invalid state")));
|
|
+ }
|
|
+
|
|
+ public static @NotNull Frame asPaperFrame(final @NotNull AdvancementType frameType) {
|
|
+ return switch (frameType) {
|
|
+ case TASK -> Frame.TASK;
|
|
+ case CHALLENGE -> Frame.CHALLENGE;
|
|
+ case GOAL -> Frame.GOAL;
|
|
+ };
|
|
+ }
|
|
+}
|
|
diff --git a/src/main/java/net/minecraft/advancements/DisplayInfo.java b/src/main/java/net/minecraft/advancements/DisplayInfo.java
|
|
index 05de12414a3ad1c8f0f02f7973898dda84b89b82..6581cdbec730d5d184566e7b611369b3c424fecf 100644
|
|
--- a/src/main/java/net/minecraft/advancements/DisplayInfo.java
|
|
+++ b/src/main/java/net/minecraft/advancements/DisplayInfo.java
|
|
@@ -37,6 +37,7 @@ public class DisplayInfo {
|
|
private final boolean hidden;
|
|
private float x;
|
|
private float y;
|
|
+ public final io.papermc.paper.advancement.AdvancementDisplay paper = new io.papermc.paper.advancement.PaperAdvancementDisplay(this); // Paper - Add more advancement API
|
|
|
|
public DisplayInfo(
|
|
ItemStack icon,
|
|
diff --git a/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancement.java b/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancement.java
|
|
index 52baf818579a6841b77ff80e42f4f1b9f635ea08..8dfaca2efa0b0bdc97b75aaa83158a2e46361e4e 100644
|
|
--- a/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancement.java
|
|
+++ b/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancement.java
|
|
@@ -29,12 +29,47 @@ public class CraftAdvancement implements org.bukkit.advancement.Advancement {
|
|
return Collections.unmodifiableCollection(this.handle.value().criteria().keySet());
|
|
}
|
|
|
|
+ // Paper start - Add more advancement API
|
|
@Override
|
|
- public AdvancementDisplay getDisplay() {
|
|
- if (this.handle.value().display().isEmpty()) {
|
|
- return null;
|
|
+ public io.papermc.paper.advancement.AdvancementDisplay getDisplay() {
|
|
+ return this.handle.value().display().map(d -> d.paper).orElse(null);
|
|
+ }
|
|
+
|
|
+ @Deprecated
|
|
+ @io.papermc.paper.annotation.DoNotUse
|
|
+ public AdvancementDisplay getDisplay0() { // May be called by plugins via Commodore
|
|
+ return this.handle.value().display().map(CraftAdvancementDisplay::new).orElse(null);
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public net.kyori.adventure.text.Component displayName() {
|
|
+ return io.papermc.paper.adventure.PaperAdventure.asAdventure(net.minecraft.advancements.Advancement.name(this.handle));
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public org.bukkit.advancement.Advancement getParent() {
|
|
+ return this.handle.value().parent()
|
|
+ .map(net.minecraft.server.MinecraftServer.getServer().getAdvancements()::get)
|
|
+ .map(AdvancementHolder::toBukkit)
|
|
+ .orElse(null);
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public Collection<org.bukkit.advancement.Advancement> getChildren() {
|
|
+ final com.google.common.collect.ImmutableList.Builder<org.bukkit.advancement.Advancement> children = com.google.common.collect.ImmutableList.<org.bukkit.advancement.Advancement>builder();
|
|
+ final net.minecraft.advancements.AdvancementNode advancementNode = net.minecraft.server.MinecraftServer.getServer().getAdvancements().tree().get(this.handle);
|
|
+ if (advancementNode != null) {
|
|
+ for (final net.minecraft.advancements.AdvancementNode child : advancementNode.children()) {
|
|
+ children.add(child.holder().toBukkit());
|
|
+ }
|
|
}
|
|
+ return children.build();
|
|
+ }
|
|
|
|
- return new CraftAdvancementDisplay(this.handle.value().display().get());
|
|
+ @Override
|
|
+ public org.bukkit.advancement.Advancement getRoot() {
|
|
+ final net.minecraft.advancements.AdvancementNode advancementNode = net.minecraft.server.MinecraftServer.getServer().getAdvancements().tree().get(this.handle);
|
|
+ return java.util.Objects.requireNonNull(advancementNode, "could not find internal advancement node for advancement " + this.handle.id()).root().holder().toBukkit();
|
|
}
|
|
+ // Paper end - Add more advancement API
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancementDisplay.java b/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancementDisplay.java
|
|
index 8ca86852319d7463f60832bc98b825b0b4325995..62ada73302c6b3ce3fb2dcc8c31a1d9c0ac4fd09 100644
|
|
--- a/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancementDisplay.java
|
|
+++ b/src/main/java/org/bukkit/craftbukkit/advancement/CraftAdvancementDisplay.java
|
|
@@ -6,6 +6,7 @@ import org.bukkit.craftbukkit.inventory.CraftItemStack;
|
|
import org.bukkit.craftbukkit.util.CraftChatMessage;
|
|
import org.bukkit.inventory.ItemStack;
|
|
|
|
+@Deprecated // Paper
|
|
public class CraftAdvancementDisplay implements org.bukkit.advancement.AdvancementDisplay {
|
|
|
|
private final DisplayInfo handle;
|
|
diff --git a/src/main/java/org/bukkit/craftbukkit/util/Commodore.java b/src/main/java/org/bukkit/craftbukkit/util/Commodore.java
|
|
index c9b789c2a904c2caff516ee9aeff4a6b368766f4..52a507ff2770bd46494e805956b4569f0d4d21ee 100644
|
|
--- a/src/main/java/org/bukkit/craftbukkit/util/Commodore.java
|
|
+++ b/src/main/java/org/bukkit/craftbukkit/util/Commodore.java
|
|
@@ -458,6 +458,11 @@ public class Commodore {
|
|
super.visitMethodInsn(opcode, owner, name, "()Lcom/destroystokyo/paper/profile/PlayerProfile;", itf);
|
|
return;
|
|
}
|
|
+ if (owner.equals("org/bukkit/advancement/Advancement") && name.equals("getDisplay") && desc.endsWith(")Lorg/bukkit/advancement/AdvancementDisplay;")) {
|
|
+ super.visitTypeInsn(Opcodes.CHECKCAST, runtimeCbPkgPrefix() + "advancement/CraftAdvancement");
|
|
+ super.visitMethodInsn(Opcodes.INVOKEVIRTUAL, runtimeCbPkgPrefix() + "advancement/CraftAdvancement", "getDisplay0", desc, false);
|
|
+ return;
|
|
+ }
|
|
// Paper end
|
|
|
|
if (modern) {
|
|
diff --git a/src/test/java/io/papermc/paper/advancement/AdvancementFrameTest.java b/src/test/java/io/papermc/paper/advancement/AdvancementFrameTest.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..6fe9c10ffd1dd5244ead05642609794623054cce
|
|
--- /dev/null
|
|
+++ b/src/test/java/io/papermc/paper/advancement/AdvancementFrameTest.java
|
|
@@ -0,0 +1,26 @@
|
|
+package io.papermc.paper.advancement;
|
|
+
|
|
+import io.papermc.paper.adventure.PaperAdventure;
|
|
+import net.kyori.adventure.text.format.TextColor;
|
|
+import net.minecraft.advancements.AdvancementType;
|
|
+import net.minecraft.network.chat.contents.TranslatableContents;
|
|
+import org.bukkit.support.environment.Normal;
|
|
+import org.junit.jupiter.api.Test;
|
|
+
|
|
+import static org.junit.jupiter.api.Assertions.assertEquals;
|
|
+
|
|
+@Normal
|
|
+public class AdvancementFrameTest {
|
|
+
|
|
+ @Test
|
|
+ public void test() {
|
|
+ for (final AdvancementType advancementType : AdvancementType.values()) {
|
|
+ final TextColor expectedColor = PaperAdventure.asAdventure(advancementType.getChatColor());
|
|
+ final String expectedTranslationKey = ((TranslatableContents) advancementType.getDisplayName().getContents()).getKey();
|
|
+ final var frame = PaperAdvancementDisplay.asPaperFrame(advancementType);
|
|
+ assertEquals(expectedTranslationKey, frame.translationKey(), "The translation keys should be the same");
|
|
+ assertEquals(expectedColor, frame.color(), "The frame colors should be the same");
|
|
+ assertEquals(advancementType.getSerializedName(), AdvancementDisplay.Frame.NAMES.key(frame));
|
|
+ }
|
|
+ }
|
|
+}
|