SteamWar/Paper
13
0
Fork 0
geforkt von Mirrors/Paper
Code Issues Pull-Requests 1 Aktivität

Add important documentation to chunk load methods

Quellcode durchsuchen 
By: md_5 <git@md-5.net>
Dieser Commit ist enthalten in:
Bukkit/Spigot 2019-04-26 22:00:24 +10:00
Ursprung ed414d7d7c
Commit f897021458
1 geänderte Dateien mit 15 neuen und 3 gelöschten Zeilen
Statistiken anzeigen Patch-Datei herunterladen Vergleichs-Datei herunterladen Alle Dateien ausklappen Alle Dateien einklappen

18
paper-api/src/main/java/org/bukkit/World.java
Datei anzeigen

@ -143,7 +143,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
public Chunk[] getLoadedChunks(); public Chunk[] getLoadedChunks();
/** /**
* Loads the specified {@link Chunk} * Loads the specified {@link Chunk}.
* <p>
* <b>This method will keep the specified chunk loaded until one of the
* unload methods is manually called. Callers are advised to instead use
* getChunkAt which will only temporarily load the requested chunk.</b>
* *
* @param chunk The chunk to load * @param chunk The chunk to load
*/ */
@ -183,7 +187,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
public boolean isChunkInUse(int x, int z); public boolean isChunkInUse(int x, int z);
/** /**
* Loads the {@link Chunk} at the specified coordinates * Loads the {@link Chunk} at the specified coordinates.
* <p>
* <b>This method will keep the specified chunk loaded until one of the
* unload methods is manually called. Callers are advised to instead use
* getChunkAt which will only temporarily load the requested chunk.</b>
* <p> * <p>
* If the chunk does not exist, it will be generated. * If the chunk does not exist, it will be generated.
* <p> * <p>
@ -196,7 +204,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
public void loadChunk(int x, int z); public void loadChunk(int x, int z);
/** /**
* Loads the {@link Chunk} at the specified coordinates * Loads the {@link Chunk} at the specified coordinates.
* <p>
* <b>This method will keep the specified chunk loaded until one of the
* unload methods is manually called. Callers are advised to instead use
* getChunkAt which will only temporarily load the requested chunk.</b>
* *
* @param x X-coordinate of the chunk * @param x X-coordinate of the chunk
* @param z Z-coordinate of the chunk * @param z Z-coordinate of the chunk