org.bukkit
Interface Chunk


public interface Chunk

Represents a chunk of blocks


Method Summary
 Block getBlock(int x, int y, int z)
          Gets a block from this chunk
 ChunkSnapshot getChunkSnapshot()
          Capture thread-safe read-only snapshot of chunk data
 ChunkSnapshot getChunkSnapshot(boolean includeMaxblocky, boolean includeBiome, boolean includeBiomeTempRain)
          Capture thread-safe read-only snapshot of chunk data
 Entity[] getEntities()
          Get a list of all entities in the chunk.
 BlockState[] getTileEntities()
          Get a list of all tile entities in the chunk.
 World getWorld()
          Gets the world containing this chunk
 int getX()
          Gets the X-coordinate of this chunk
 int getZ()
          Gets the Z-coordinate of this chunk
 boolean isLoaded()
          Checks if the chunk is loaded.
 boolean load()
          Loads the chunk.
 boolean load(boolean generate)
          Loads the chunk.
 boolean unload()
          Unloads and optionally saves the Chunk
 boolean unload(boolean save)
          Unloads and optionally saves the Chunk
 boolean unload(boolean save, boolean safe)
          Unloads and optionally saves the Chunk
 

Method Detail

getX

int getX()
Gets the X-coordinate of this chunk

Returns:
X-coordinate

getZ

int getZ()
Gets the Z-coordinate of this chunk

Returns:
Z-coordinate

getWorld

World getWorld()
Gets the world containing this chunk

Returns:
Parent World

getBlock

Block getBlock(int x,
               int y,
               int z)
Gets a block from this chunk

Parameters:
x - 0-15
y - 0-127
z - 0-15
Returns:
the Block

getChunkSnapshot

ChunkSnapshot getChunkSnapshot()
Capture thread-safe read-only snapshot of chunk data

Returns:
ChunkSnapshot

getChunkSnapshot

ChunkSnapshot getChunkSnapshot(boolean includeMaxblocky,
                               boolean includeBiome,
                               boolean includeBiomeTempRain)
Capture thread-safe read-only snapshot of chunk data

Parameters:
includeMaxblocky - - if true, snapshot includes per-coordinate maximum Y values
includeBiome - - if true, snapshot includes per-coordinate biome type
includeBiomeTempRain - - if true, snapshot includes per-coordinate raw biome temperature and rainfall
Returns:
ChunkSnapshot

getEntities

Entity[] getEntities()
Get a list of all entities in the chunk.

Returns:
The entities.

getTileEntities

BlockState[] getTileEntities()
Get a list of all tile entities in the chunk.

Returns:
The tile entities.

isLoaded

boolean isLoaded()
Checks if the chunk is loaded.

Returns:
True if it is loaded.

load

boolean load(boolean generate)
Loads the chunk.

Parameters:
generate - Whether or not to generate a chunk if it doesn't already exist
Returns:
true if the chunk has loaded successfully, otherwise false

load

boolean load()
Loads the chunk.

Returns:
true if the chunk has loaded successfully, otherwise false

unload

boolean unload(boolean save,
               boolean safe)
Unloads and optionally saves the Chunk

Parameters:
save - Controls whether the chunk is saved
safe - Controls whether to unload the chunk when players are nearby
Returns:
true if the chunk has unloaded successfully, otherwise false

unload

boolean unload(boolean save)
Unloads and optionally saves the Chunk

Parameters:
save - Controls whether the chunk is saved
Returns:
true if the chunk has unloaded successfully, otherwise false

unload

boolean unload()
Unloads and optionally saves the Chunk

Returns:
true if the chunk has unloaded successfully, otherwise false


Copyright © 2013. All Rights Reserved.