#1067: Add method to get Advancement requirements

By: Nothixal <nothixal@gmail.com>
2024-11-23 21:25:09 +11:00
parent 471ecd8e4a
commit 98f6ab9a04
3 changed files with 57 additions and 0 deletions
@@ -0,0 +1,26 @@
+package org.bukkit.advancement;
+
+import java.util.List;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * The list of requirements for the advancement.
+ *
+ * Requirements are complimentary to criteria. They are just lists that contain
+ * more lists, which in turn contains strings that equal the names of the
+ * criteria. Ultimately defining the logic around how criteria are completed in
+ * order to grant the advancement.
+ *
+ * @see <a href=https://minecraft.wiki/w/Advancement_definition>Advancement Definition</a>
+ * @see <a href=https://www.minecraftforum.net/forums/minecraft-java-edition/redstone-discussion-and/commands-command-blocks-and/2809368-1-12-custom-advancements-aka-achievements#Requirements>Advancement Requirements</a>
+ */
+public interface AdvancementRequirements {
+
+    /**
+     * Get all the requirements present in this advancement.
+     *
+     * @return an unmodifiable copy of all requirements.
+     */
+    @NotNull
+    List<AdvancementRequirement> getRequirements();
+}