Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-03-09 13:19:25 +01:00
Code Issues Projects Releases Wiki Activity

Add method isTickingWorlds() to Bukkit.

Browse Source
This commit is contained in:
BuildTools 2022-08-19 16:11:51 -04:00
parent f1be44f667
commit eb05140733
2 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
paper-api/src/main/java/org/bukkit/Bukkit.java
View File

@ -809,12 +809,26 @@ public final class Bukkit {
return server.getWorlds(); 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 * Creates or loads a world with the given name using the specified
* options. * options.
* <p> * <p>
* If the world is already loaded, it will just return the equivalent of * If the world is already loaded, it will just return the equivalent of
* getWorld(creator.name()). * 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 * @param creator the options to use when creating the world
* @return newly created or loaded world * @return newly created or loaded world
@ -826,6 +840,9 @@ public final class Bukkit {
/** /**
* Unloads a world with the given name. * 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 name Name of the world to unload
* @param save whether to save the chunks before unloading * @param save whether to save the chunks before unloading
@ -837,6 +854,9 @@ public final class Bukkit {
/** /**
* Unloads the given world. * 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 world the world to unload
* @param save whether to save the chunks before unloading * @param save whether to save the chunks before unloading

21
paper-api/src/main/java/org/bukkit/Server.java
View File

@ -679,34 +679,55 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
@NotNull @NotNull
public List<World> getWorlds(); 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 * Creates or loads a world with the given name using the specified
* options. * options.
* <p> * <p>
* If the world is already loaded, it will just return the equivalent of * If the world is already loaded, it will just return the equivalent of
* getWorld(creator.name()). * 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 * @param creator the options to use when creating the world
* @return newly created or loaded world * @return newly created or loaded world
* @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true
*/ */
@Nullable @Nullable
public World createWorld(@NotNull WorldCreator creator); public World createWorld(@NotNull WorldCreator creator);
/** /**
* Unloads a world with the given name. * 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 name Name of the world to unload
* @param save whether to save the chunks before unloading * @param save whether to save the chunks before unloading
* @return true if successful, false otherwise * @return true if successful, false otherwise
* @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true
*/ */
public boolean unloadWorld(@NotNull String name, boolean save); public boolean unloadWorld(@NotNull String name, boolean save);
/** /**
* Unloads the given world. * 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 world the world to unload
* @param save whether to save the chunks before unloading * @param save whether to save the chunks before unloading
* @return true if successful, false otherwise * @return true if successful, false otherwise
* @throws IllegalStateException when {@link #isTickingWorlds() isTickingWorlds} is true
*/ */
public boolean unloadWorld(@NotNull World world, boolean save); public boolean unloadWorld(@NotNull World world, boolean save);