Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-11-25 12:05:53 +01:00
Code Issues Projects Releases Wiki Activity

Fix typos in isTickingWorlds API javadocs (#8382)

Browse Source
This commit is contained in:
Bjarne Koll 2022-09-25 02:01:17 +02:00 committed by GitHub
parent 6d630052fd
commit abe53a7eb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
patches/api/0383-Add-method-isTickingWorlds-to-Bukkit.patch
View File

@ -5,7 +5,7 @@ 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..b5a7d6ab4e458843f2e163bf06b5668627012f91 100644
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 {
@ -14,7 +14,7 @@ index 840aaf9e8fc828b5a7ea02252038c6524680f2e0..b5a7d6ab4e458843f2e163bf06b56686
+ // Paper start
+ /**
+ * Gets whether the worlds are being ticked right not or not.
+ * Gets whether the worlds are being ticked right now.
+ *
+ * @return true if the worlds are being ticked, false otherwise.
+ */
@ -31,7 +31,7 @@ index 840aaf9e8fc828b5a7ea02252038c6524680f2e0..b5a7d6ab4e458843f2e163bf06b56686
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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
@ -41,7 +41,7 @@ index 840aaf9e8fc828b5a7ea02252038c6524680f2e0..b5a7d6ab4e458843f2e163bf06b56686
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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
@ -51,12 +51,12 @@ index 840aaf9e8fc828b5a7ea02252038c6524680f2e0..b5a7d6ab4e458843f2e163bf06b56686
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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..1982fc2d7f1cb80d3e324ee283211b251a976c6e 100644
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
@ -65,7 +65,7 @@ index da5cab4246bd253fcc4e4d9574bdae1867ebb5ab..1982fc2d7f1cb80d3e324ee283211b25
+ // Paper start
+ /**
+ * Gets whether the worlds are being ticked right not or not.
+ * Gets whether the worlds are being ticked right now.
+ *
+ * @return true if the worlds are being ticked, false otherwise.
+ */
@ -80,7 +80,7 @@ index da5cab4246bd253fcc4e4d9574bdae1867ebb5ab..1982fc2d7f1cb80d3e324ee283211b25
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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
@ -93,7 +93,7 @@ index da5cab4246bd253fcc4e4d9574bdae1867ebb5ab..1982fc2d7f1cb80d3e324ee283211b25
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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
@ -106,7 +106,7 @@ index da5cab4246bd253fcc4e4d9574bdae1867ebb5ab..1982fc2d7f1cb80d3e324ee283211b25
* 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 loading worlds midtick by checking {@link Bukkit#isTickingWorlds()}
+ * 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