Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.Chunk Interface Reference

Public Member Functions

int getX ()
 
int getZ ()
 
World getWorld ()
 
Block getBlock (int x, int y, int z)
 
ChunkSnapshot getChunkSnapshot ()
 
ChunkSnapshot getChunkSnapshot (boolean includeMaxblocky, boolean includeBiome, boolean includeBiomeTempRain)
 
Entity[] getEntities ()
 
BlockState[] getTileEntities ()
 
boolean isLoaded ()
 
boolean load (boolean generate)
 
boolean load ()
 
boolean unload (boolean save, boolean safe)
 
boolean unload (boolean save)
 
boolean unload ()
 

Detailed Description

Represents a chunk of blocks

Definition at line 10 of file Chunk.java.

Member Function Documentation

Block org.bukkit.Chunk.getBlock ( int  x,
int  y,
int  z 
)

Gets a block from this chunk

Parameters
x0-15
y0-127
z0-15
Returns
the Block
ChunkSnapshot org.bukkit.Chunk.getChunkSnapshot ( )

Capture thread-safe read-only snapshot of chunk data

Returns
ChunkSnapshot
ChunkSnapshot org.bukkit.Chunk.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
Entity [] org.bukkit.Chunk.getEntities ( )

Get a list of all entities in the chunk.

Returns
The entities.
BlockState [] org.bukkit.Chunk.getTileEntities ( )

Get a list of all tile entities in the chunk.

Returns
The tile entities.
World org.bukkit.Chunk.getWorld ( )

Gets the world containing this chunk

Returns
Parent World
int org.bukkit.Chunk.getX ( )

Gets the X-coordinate of this chunk

Returns
X-coordinate
int org.bukkit.Chunk.getZ ( )

Gets the Z-coordinate of this chunk

Returns
Z-coordinate
boolean org.bukkit.Chunk.isLoaded ( )

Checks if the chunk is loaded.

Returns
True if it is loaded.
boolean org.bukkit.Chunk.load ( boolean  generate)

Loads the chunk.

Parameters
generateWhether or not to generate a chunk if it doesn't already exist
Returns
true if the chunk has loaded successfully, otherwise false
boolean org.bukkit.Chunk.load ( )

Loads the chunk.

Returns
true if the chunk has loaded successfully, otherwise false
boolean org.bukkit.Chunk.unload ( boolean  save,
boolean  safe 
)

Unloads and optionally saves the Chunk

Parameters
saveControls whether the chunk is saved
safeControls whether to unload the chunk when players are nearby
Returns
true if the chunk has unloaded successfully, otherwise false
boolean org.bukkit.Chunk.unload ( boolean  save)

Unloads and optionally saves the Chunk

Parameters
saveControls whether the chunk is saved
Returns
true if the chunk has unloaded successfully, otherwise false
boolean org.bukkit.Chunk.unload ( )

Unloads and optionally saves the Chunk

Returns
true if the chunk has unloaded successfully, otherwise false

The documentation for this interface was generated from the following file: