From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: BuildTools <46540330+willkroboth@users.noreply.github.com> Date: Fri, 19 Aug 2022 16:11:51 -0400 Subject: [PATCH] Add method isTickingWorlds() to Bukkit. diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java index 840aaf9e8fc828b5a7ea02252038c6524680f2e0..232c08c9a588d957d90f198ce479e57615c6e650 100644 --- a/src/main/java/org/bukkit/Bukkit.java +++ b/src/main/java/org/bukkit/Bukkit.java @@ -753,12 +753,26 @@ public final class Bukkit { return server.getWorlds(); } + // Paper start + /** + * Gets whether the worlds are being ticked right now. + * + * @return true if the worlds are being ticked, false otherwise. + */ + public static boolean isTickingWorlds(){ + return server.isTickingWorlds(); + } + // Paper end + /** * Creates or loads a world with the given name using the specified * options. *

* If the world is already loaded, it will just return the equivalent of * getWorld(creator.name()). + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param creator the options to use when creating the world * @return newly created or loaded world @@ -770,6 +784,9 @@ public final class Bukkit { /** * Unloads a world with the given name. + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param name Name of the world to unload * @param save whether to save the chunks before unloading @@ -781,6 +798,9 @@ public final class Bukkit { /** * Unloads the given world. + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param world the world to unload * @param save whether to save the chunks before unloading diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java index da5cab4246bd253fcc4e4d9574bdae1867ebb5ab..e43fef0152468944d8a33036344a43e95fe58476 100644 --- a/src/main/java/org/bukkit/Server.java +++ b/src/main/java/org/bukkit/Server.java @@ -622,34 +622,55 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi @NotNull public List getWorlds(); + // Paper start + /** + * Gets whether the worlds are being ticked right now. + * + * @return true if the worlds are being ticked, false otherwise. + */ + public boolean isTickingWorlds(); + // Paper end + /** * Creates or loads a world with the given name using the specified * options. *

* If the world is already loaded, it will just return the equivalent of * getWorld(creator.name()). + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param creator the options to use when creating the world * @return newly created or loaded world + * @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true */ @Nullable public World createWorld(@NotNull WorldCreator creator); /** * Unloads a world with the given name. + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param name Name of the world to unload * @param save whether to save the chunks before unloading * @return true if successful, false otherwise + * @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true */ public boolean unloadWorld(@NotNull String name, boolean save); /** * Unloads the given world. + *

+ * Do note that un/loading worlds mid-tick may have potential side effects, we strongly recommend + * ensuring that you're not un/loading worlds midtick by checking {@link Bukkit#isTickingWorlds()} * * @param world the world to unload * @param save whether to save the chunks before unloading * @return true if successful, false otherwise + * @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true */ public boolean unloadWorld(@NotNull World world, boolean save);