From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Connor Linfoot Date: Sun, 16 May 2021 15:07:34 +0100 Subject: [PATCH] Add basic Datapack API diff --git a/src/main/java/io/papermc/paper/datapack/Datapack.java b/src/main/java/io/papermc/paper/datapack/Datapack.java new file mode 100644 index 0000000000000000000000000000000000000000..7b2ab0be10a21e0496ad1d485ff8cb2c0b92a2cb --- /dev/null +++ b/src/main/java/io/papermc/paper/datapack/Datapack.java @@ -0,0 +1,32 @@ +package io.papermc.paper.datapack; + +import org.checkerframework.checker.nullness.qual.NonNull; + +public interface Datapack { + + /** + * @return the name of the pack + */ + @NonNull + String getName(); + + /** + * @return the compatibility of the pack + */ + @NonNull + Compatibility getCompatibility(); + + /** + * @return whether or not the pack is currently enabled + */ + boolean isEnabled(); + + void setEnabled(boolean enabled); + + enum Compatibility { + TOO_OLD, + TOO_NEW, + COMPATIBLE, + } + +} diff --git a/src/main/java/io/papermc/paper/datapack/DatapackManager.java b/src/main/java/io/papermc/paper/datapack/DatapackManager.java new file mode 100644 index 0000000000000000000000000000000000000000..58f78d5e91beacaf710f62461cf869f70d08b2a2 --- /dev/null +++ b/src/main/java/io/papermc/paper/datapack/DatapackManager.java @@ -0,0 +1,21 @@ +package io.papermc.paper.datapack; + +import org.checkerframework.checker.nullness.qual.NonNull; + +import java.util.Collection; + +public interface DatapackManager { + + /** + * @return all the packs known to the server + */ + @NonNull + Collection getPacks(); + + /** + * @return all the packs which are currently enabled + */ + @NonNull + Collection getEnabledPacks(); + +} diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java index 149c1a1cc39f79ca03e1f02cf2751885e0428895..4d8ff5b400a17fadefc25b3bf602eadb12cae4e9 100644 --- a/src/main/java/org/bukkit/Bukkit.java +++ b/src/main/java/org/bukkit/Bukkit.java @@ -327,9 +327,11 @@ public final class Bukkit { /** * Get the DataPack Manager. * + * @deprecated use {@link #getDatapackManager()} * @return the manager */ @NotNull + @Deprecated(forRemoval = true) public static DataPackManager getDataPackManager() { return server.getDataPackManager(); } @@ -2591,6 +2593,14 @@ public final class Bukkit { public static com.destroystokyo.paper.entity.ai.MobGoals getMobGoals() { return server.getMobGoals(); } + + /** + * @return the datapack manager + */ + @NotNull + public static io.papermc.paper.datapack.DatapackManager getDatapackManager() { + return server.getDatapackManager(); + } // Paper end @NotNull diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java index 0c71aa3b5758dbfdce8782e02772f9450901adbd..2fa562ca863810cbba82d43bf452f61d9e02cfdb 100644 --- a/src/main/java/org/bukkit/Server.java +++ b/src/main/java/org/bukkit/Server.java @@ -266,9 +266,11 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi /** * Get the DataPack Manager. * + * @deprecated use {@link #getDatapackManager()} * @return the manager */ @NotNull + @Deprecated(forRemoval = true) // Paper public DataPackManager getDataPackManager(); /** @@ -2260,5 +2262,11 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi */ @NotNull com.destroystokyo.paper.entity.ai.MobGoals getMobGoals(); + + /** + * @return the datapack manager + */ + @NotNull + io.papermc.paper.datapack.DatapackManager getDatapackManager(); // Paper end } diff --git a/src/main/java/org/bukkit/packs/DataPack.java b/src/main/java/org/bukkit/packs/DataPack.java index 3d5af25a399589f1bdf95b77f584ae0ae5c26f02..ab512c7ee9d2442055b719d02d0d0ecc7ea8d992 100644 --- a/src/main/java/org/bukkit/packs/DataPack.java +++ b/src/main/java/org/bukkit/packs/DataPack.java @@ -10,8 +10,10 @@ import org.jetbrains.annotations.NotNull; * Represents a data pack. * * @see Minecraft wiki + * @deprecated use {@link io.papermc.paper.datapack.Datapack} */ @ApiStatus.Experimental +@Deprecated(forRemoval = true) // Paper public interface DataPack extends Keyed { /** diff --git a/src/main/java/org/bukkit/packs/DataPackManager.java b/src/main/java/org/bukkit/packs/DataPackManager.java index c33ca7b86426223200efa7df53faef061c3c7c0b..5ec17312564e245e6d482e89c2ef2a886d463154 100644 --- a/src/main/java/org/bukkit/packs/DataPackManager.java +++ b/src/main/java/org/bukkit/packs/DataPackManager.java @@ -13,8 +13,10 @@ import org.jetbrains.annotations.Nullable; /** * Manager of data packs. + * @deprecated use {@link io.papermc.paper.datapack.DatapackManager} */ @ApiStatus.Experimental +@Deprecated(forRemoval = true) // Paper public interface DataPackManager { /**