Package org.bukkit

Interface ChunkSnapshot

public interface ChunkSnapshot

Represents a static, thread-safe snapshot of chunk of blocks.

Purpose is to allow clean, efficient copy of a chunk data to be made, and then handed off for processing in another thread (e.g. map rendering)

Method Summary

Modifier and Type	Method	Description
boolean	contains(@NotNull BlockData block)	Tests if this snapshot contains the specified block.
@NotNull Biome	getBiome(int x, int z)	Deprecated. biomes are now 3-dimensional
@NotNull Biome	getBiome(int x, int y, int z)	Get biome at given coordinates
@NotNull BlockData	getBlockData(int x, int y, int z)	Get block data for block at corresponding coordinate in the chunk
int	getBlockEmittedLight(int x, int y, int z)	Get light level emitted by block at corresponding coordinate in the chunk
int	getBlockSkyLight(int x, int y, int z)	Get sky light level for block at corresponding coordinate in the chunk
@NotNull Material	getBlockType(int x, int y, int z)	Get block type for block at corresponding coordinate in the chunk
long	getCaptureFullTime()	Get world full time when chunk snapshot was captured
int	getData(int x, int y, int z)	Deprecated. Magic value
int	getHighestBlockYAt(int x, int z)	Gets the highest non-air coordinate at the given coordinates
double	getRawBiomeTemperature(int x, int z)	Deprecated. biomes are now 3-dimensional
double	getRawBiomeTemperature(int x, int y, int z)	Get raw biome temperature at given coordinates
@NotNull String	getWorldName()	Gets name of the world containing this chunk
int	getX()	Gets the X-coordinate of this chunk
int	getZ()	Gets the Z-coordinate of this chunk
boolean	isSectionEmpty(int sy)	Test if section is empty

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

getWorldName

@NotNull
@NotNull String getWorldName()

Gets name of the world containing this chunk

Returns:

Parent World Name

getBlockType

@NotNull
@NotNull Material getBlockType(int x,
                               int y,
                               int z)

Get block type for block at corresponding coordinate in the chunk

Parameters:

x - 0-15

y - 0-255

z - 0-15

Returns:

block material type

getBlockData

@NotNull
@NotNull BlockData getBlockData(int x,
                                int y,
                                int z)

Get block data for block at corresponding coordinate in the chunk

Parameters:

x - 0-15

y - 0-255

z - 0-15

Returns:

block material type

getData

@Deprecated
int getData(int x,
            int y,
            int z)

Deprecated. Magic value

Get block data for block at corresponding coordinate in the chunk

Parameters:

x - 0-15

y - 0-255

z - 0-15

Returns:

0-15

getBlockSkyLight

int getBlockSkyLight(int x,
                     int y,
                     int z)

Get sky light level for block at corresponding coordinate in the chunk

Parameters:

x - 0-15

y - 0-255

z - 0-15

Returns:

0-15

getBlockEmittedLight

int getBlockEmittedLight(int x,
                         int y,
                         int z)

Get light level emitted by block at corresponding coordinate in the chunk

Parameters:

x - 0-15

y - 0-255

z - 0-15

Returns:

0-15

getHighestBlockYAt

int getHighestBlockYAt(int x,
                       int z)

Gets the highest non-air coordinate at the given coordinates

Parameters:

x - X-coordinate of the blocks (0-15)

z - Z-coordinate of the blocks (0-15)

Returns:

Y-coordinate of the highest non-air block

getBiome

@NotNull
@Deprecated
@NotNull Biome getBiome(int x,
                        int z)

Deprecated. biomes are now 3-dimensional

Get biome at given coordinates

Parameters:

x - X-coordinate (0-15)

z - Z-coordinate (0-15)

Returns:

Biome at given coordinate

getBiome

@NotNull
@NotNull Biome getBiome(int x,
                        int y,
                        int z)

Get biome at given coordinates

Parameters:

x - X-coordinate (0-15)

y - Y-coordinate (0-255)

z - Z-coordinate (0-15)

Returns:

Biome at given coordinate

getRawBiomeTemperature

@Deprecated
double getRawBiomeTemperature(int x,
                              int z)

Deprecated. biomes are now 3-dimensional

Get raw biome temperature at given coordinates

Parameters:

x - X-coordinate (0-15)

z - Z-coordinate (0-15)

Returns:

temperature at given coordinate

getRawBiomeTemperature

double getRawBiomeTemperature(int x,
                              int y,
                              int z)

Get raw biome temperature at given coordinates

Parameters:

x - X-coordinate (0-15)

y - Y-coordinate (0-15)

z - Z-coordinate (0-15)

Returns:

temperature at given coordinate

getCaptureFullTime

long getCaptureFullTime()

Get world full time when chunk snapshot was captured

Returns:

time in ticks

isSectionEmpty

boolean isSectionEmpty(int sy)

Test if section is empty

Parameters:

sy - - section Y coordinate (block Y / 16, 0-255)

Returns:

true if empty, false if not

contains

boolean contains(@NotNull
                 @NotNull BlockData block)

Tests if this snapshot contains the specified block.

Parameters:

block - block to test

Returns:

if the block is contained within