Paper/patches/api/0362-Add-method-isTickingWorlds-to-Bukkit.patch
2024-01-14 13:47:09 +01:00

118 lines
4.8 KiB
Diff

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 50d336fda7f549e50dc127767ca35107c99a3483..d71b30d574e5cf7273ff831edb7f3ef2359bbadc 100644
--- a/src/main/java/org/bukkit/Bukkit.java
+++ b/src/main/java/org/bukkit/Bukkit.java
@@ -786,12 +786,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.
* <p>
* If the world is already loaded, it will just return the equivalent of
* getWorld(creator.name()).
+ * <p>
+ * 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
@@ -803,6 +817,9 @@ public final class Bukkit {
/**
* Unloads a world with the given name.
+ * <p>
+ * 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
@@ -814,6 +831,9 @@ public final class Bukkit {
/**
* Unloads the given world.
+ * <p>
+ * 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 eca2b37d2841f3d64b9c3134c6b40264ee49d255..75f2b46c4fc1e12d1d02cd60865a5b76b1c2de49 100644
--- a/src/main/java/org/bukkit/Server.java
+++ b/src/main/java/org/bukkit/Server.java
@@ -657,34 +657,55 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
@NotNull
public List<World> 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.
* <p>
* If the world is already loaded, it will just return the equivalent of
* getWorld(creator.name()).
+ * <p>
+ * 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.
+ * <p>
+ * 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.
+ * <p>
+ * 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);