spigot-mirror/bukkit
1
0
Fork 0
mirror of https://hub.spigotmc.org/stash/scm/spigot/bukkit.git synced 2025-08-31 14:15:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add important documentation to chunk load methods

Browse source
This commit is contained in:
md_5 2019-04-26 22:00:24 +10:00
parent 17bdbc2d4e
commit 7407eaacc9
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/main/java/org/bukkit/World.java
View file

@ -143,7 +143,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
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
*/
@ -183,7 +187,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
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>
* If the chunk does not exist, it will be generated.
* <p>
@ -196,7 +204,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
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 z Z-coordinate of the chunk