org.bukkit.Chunk Interface Reference

Represents a chunk of blocks. More...

Public Member Functions
int	getX ()
	Gets the X-coordinate of this chunk.
int	getZ ()
	Gets the Z-coordinate of this chunk.
World	getWorld ()
	Gets the world containing this chunk.
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.
boolean	isLoaded ()
	Checks if the chunk is loaded.
boolean	load (boolean generate)
	Loads the chunk.
boolean	load ()
	Loads the chunk.
boolean	unload (boolean save, boolean safe)
	Unloads and optionally saves the Chunk.
boolean	unload (boolean save)
	Unloads and optionally saves the Chunk.
boolean	unload ()
	Unloads and optionally saves the Chunk.

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

x	0-15
y	0-127
z	0-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

Referenced by org.bukkit.event.world.ChunkEvent.ChunkEvent().

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

generate

Whether 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

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

boolean org.bukkit.Chunk.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

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:

• org/bukkit/Chunk.java