1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: syldium <syldium@mailo.com>
Date: Fri, 9 Jul 2021 18:49:40 +0200
Subject: [PATCH] Add more advancement API
Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com>
diff --git a/src/main/java/io/papermc/paper/advancement/AdvancementDisplay.java b/src/main/java/io/papermc/paper/advancement/AdvancementDisplay.java
new file mode 100644
index 0000000000000000000000000000000000000000..59228f2e66e982feca77d9f962004ceacb648783
--- /dev/null
+++ b/src/main/java/io/papermc/paper/advancement/AdvancementDisplay.java
@@ -0,0 +1,160 @@
+package io.papermc.paper.advancement;
+
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.format.NamedTextColor;
+import net.kyori.adventure.text.format.TextColor;
+import net.kyori.adventure.translation.Translatable;
+import net.kyori.adventure.util.Index;
+import org.bukkit.NamespacedKey;
+import org.bukkit.inventory.ItemStack;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Describes the display of an advancement.
+ * <p>
+ * The display is used in the chat, in the toast messages and the advancements
+ * screen.
+ */
+@NullMarked
+public interface AdvancementDisplay {
+
+ /**
+ * Gets the {@link Frame}.
+ * <p>
+ * This defines the appearance of the tile in the advancements screen and
+ * the text when it's completed.
+ *
+ * @return the frame type
+ */
+ Frame frame();
+
+ /**
+ * Gets the advancement title.
+ *
+ * @return the title
+ */
+ Component title();
+
+ /**
+ * Gets the description.
+ *
+ * @return the description
+ */
+ Component description();
+
+ /**
+ * Gets the icon shown in the frame in the advancements screen.
+ *
+ * @return a copy of the icon
+ */
+ ItemStack icon();
+
+ /**
+ * Gets whether a toast should be displayed.
+ * <p>
+ * A toast is a notification that will be displayed in the top right corner
+ * of the screen.
+ *
+ * @return {@code true} if a toast should be shown
+ */
+ boolean doesShowToast();
+
+ /**
+ * Gets whether a message should be sent in the chat.
+ *
+ * @return {@code true} if a message should be sent
+ * @see org.bukkit.event.player.PlayerAdvancementDoneEvent#message() to edit
+ * the message
+ */
+ boolean doesAnnounceToChat();
+
+ /**
+ * Gets whether this advancement is hidden.
+ * <p>
+ * Hidden advancements cannot be viewed by the player until they have been
+ * unlocked.
+ *
+ * @return {@code true} if hidden
+ */
+ boolean isHidden();
+
+ /**
+ * Gets the texture displayed behind the advancement tree when selected.
+ * <p>
+ * This only affects root advancements without any parent. If the background
+ * is not specified or doesn't exist, the tab background will be the missing
+ * texture.
+ *
+ * @return the background texture path
+ */
+ @Nullable NamespacedKey backgroundPath();
+
+ /**
+ * Gets the formatted display name for this display. This
+ * is a part of the component that would be shown in chat when a player
+ * completes the advancement.
+ *
+ * @return the display name
+ * @see org.bukkit.advancement.Advancement#displayName()
+ */
+ Component displayName();
+
+ /**
+ * Defines how the {@link #icon()} appears in the advancements screen and
+ * the color used with the {@link #title() advancement name}.
+ */
+ enum Frame implements Translatable {
+
+ /**
+ * "Challenge complete" advancement.
+ * <p>
+ * The client will play the {@code ui.toast.challenge_complete} sound
+ * when the challenge is completed and the toast is shown.
+ */
+ CHALLENGE("challenge", NamedTextColor.DARK_PURPLE),
+
+ /**
+ * "Goal reached" advancement.
+ */
+ GOAL("goal", NamedTextColor.GREEN),
+
+ /**
+ * "Advancement made" advancement.
+ */
+ TASK("task", NamedTextColor.GREEN);
+
+ /**
+ * The name map.
+ */
+ public static final Index<String, Frame> NAMES = Index.create(Frame.class, frame -> frame.name);
+ private final String name;
+ private final TextColor color;
+
+ Frame(final String name, final TextColor color) {
+ this.name = name;
+ this.color = color;
+ }
+
+ /**
+ * Gets the {@link TextColor} used for the advancement name.
+ *
+ * @return the text color
+ */
+ public TextColor color() {
+ return this.color;
+ }
+
+ /**
+ * Gets the translation key used when an advancement is completed.
+ * <p>
+ * This is the first line of the toast displayed by the client.
+ *
+ * @return the toast message key
+ */
+ @Override
+ public String translationKey() {
+ return "advancements.toast." + this.name;
+ }
+ }
+}
diff --git a/src/main/java/org/bukkit/advancement/Advancement.java b/src/main/java/org/bukkit/advancement/Advancement.java
index e683af5eb1d08179acd69c521f8f387dc8051e32..5d7ab518dc6be39965cc8925e5df6792456c6658 100644
--- a/src/main/java/org/bukkit/advancement/Advancement.java
+++ b/src/main/java/org/bukkit/advancement/Advancement.java
@@ -27,13 +27,53 @@ public interface Advancement extends Keyed {
@NotNull
AdvancementRequirements getRequirements();
+ // Paper start
/**
- * Returns the display information for this advancement.
+ * Get the display info of this advancement.
+ * <p>
+ * Will be {@code null} when totally hidden, for example with crafting
+ * recipes.
*
- * This includes it's name, description and other visible tags.
+ * @return the display info
+ */
+ @Nullable
+ io.papermc.paper.advancement.AdvancementDisplay getDisplay();
+
+ /**
+ * Gets the formatted display name for this display. This
+ * is part of the component that would be shown in chat when a player
+ * completes the advancement. Will return the same as
+ * {@link io.papermc.paper.advancement.AdvancementDisplay#displayName()} when an
+ * {@link io.papermc.paper.advancement.AdvancementDisplay} is present.
*
- * @return a AdvancementDisplay object, or null if not set.
+ * @return the display name
+ * @see io.papermc.paper.advancement.AdvancementDisplay#displayName()
+ */
+ @NotNull net.kyori.adventure.text.Component displayName();
+
+ /**
+ * Gets the parent advancement, if any.
+ *
+ * @return the parent advancement
*/
@Nullable
- AdvancementDisplay getDisplay();
+ Advancement getParent();
+
+ /**
+ * Gets all the direct children advancements.
+ *
+ * @return the children advancements
+ */
+ @NotNull
+ @org.jetbrains.annotations.Unmodifiable
+ Collection<Advancement> getChildren();
+
+ /**
+ * Gets the root advancement of the tree this is located in.
+ *
+ * @return the root advancement
+ */
+ @NotNull
+ Advancement getRoot();
+ // Paper end
}
diff --git a/src/main/java/org/bukkit/advancement/AdvancementDisplay.java b/src/main/java/org/bukkit/advancement/AdvancementDisplay.java
index 0ff86a39025a94ca128364a45bf171728cb81027..aec6be7e121da3eb8a464b6934da29ab6b473885 100644
--- a/src/main/java/org/bukkit/advancement/AdvancementDisplay.java
+++ b/src/main/java/org/bukkit/advancement/AdvancementDisplay.java
@@ -5,7 +5,10 @@ import org.jetbrains.annotations.NotNull;
/**
* Holds information about how the advancement is displayed by the game.
+ *
+ * @deprecated use {@link io.papermc.paper.advancement.AdvancementDisplay}
*/
+@Deprecated(forRemoval = true) // Paper
public interface AdvancementDisplay {
/**
diff --git a/src/main/java/org/bukkit/advancement/AdvancementDisplayType.java b/src/main/java/org/bukkit/advancement/AdvancementDisplayType.java
index de767efb9f55448df061e166c66a2cf3439d57ec..06d8b72dd54becc13f40bd6e505115405462cd73 100644
--- a/src/main/java/org/bukkit/advancement/AdvancementDisplayType.java
+++ b/src/main/java/org/bukkit/advancement/AdvancementDisplayType.java
@@ -8,7 +8,9 @@ import org.jetbrains.annotations.NotNull;
*
* This enum contains information about these types and how they are
* represented.
+ * @deprecated use {@link io.papermc.paper.advancement.AdvancementDisplay.Frame}
*/
+@Deprecated(forRemoval = true)
public enum AdvancementDisplayType {
/**
|
