Package org.bukkit.generator
Interface ChunkGenerator.ChunkData
- Enclosing class:
ChunkGenerator
public static interface ChunkGenerator.ChunkData
Data for a Chunk.
-
Method Summary
Modifier and TypeMethodDescriptiongetBiome
(int x, int y, int z) Get the biome at x, y, z within chunk being generatedgetBlockData
(int x, int y, int z) Get the type and data of the block at x, y, z.byte
getData
(int x, int y, int z) Deprecated.Uses magic valuesint
Get the maximum height for this ChunkData.int
Get the minimum height for this ChunkData.getType
(int x, int y, int z) Get the type of the block at x, y, z.getTypeAndData
(int x, int y, int z) Deprecated.void
Set the block at x,y,z in the chunk data to material.void
Set the block at x,y,z in the chunk data to material.void
setBlock
(int x, int y, int z, @NotNull MaterialData material) Deprecated.void
Set a region of this chunk from xMin, yMin, zMin (inclusive) to xMax, yMax, zMax (exclusive) to material.void
Set a region of this chunk from xMin, yMin, zMin (inclusive) to xMax, yMax, zMax (exclusive) to material.void
setRegion
(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, @NotNull MaterialData material) Deprecated.
-
Method Details
-
getMinHeight
int getMinHeight()Get the minimum height for this ChunkData.It is not guaranteed that this method will return the same value as
WorldInfo.getMinHeight()
.Setting blocks below this height will do nothing.
- Returns:
- the minimum height
-
getMaxHeight
int getMaxHeight()Get the maximum height for this ChunkData.It is not guaranteed that this method will return the same value as
WorldInfo.getMaxHeight()
.Setting blocks at or above this height will do nothing.
- Returns:
- the maximum height
-
getBiome
Get the biome at x, y, z within chunk being generated- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusive- Returns:
- Biome value
-
setBlock
Set the block at x,y,z in the chunk data to material. Note: setting blocks outside the chunk's bounds does nothing.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusivematerial
- the type to set the block to
-
setBlock
Deprecated.Set the block at x,y,z in the chunk data to material. Setting blocks outside the chunk's bounds does nothing.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusivematerial
- the type to set the block to
-
setBlock
Set the block at x,y,z in the chunk data to material. Setting blocks outside the chunk's bounds does nothing.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusiveblockData
- the type to set the block to
-
setRegion
void setRegion(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, @NotNull @NotNull Material material) Set a region of this chunk from xMin, yMin, zMin (inclusive) to xMax, yMax, zMax (exclusive) to material. Setting blocks outside the chunk's bounds does nothing.- Parameters:
xMin
- minimum x location (inclusive) in the chunk to setyMin
- minimum y location (inclusive) in the chunk to setzMin
- minimum z location (inclusive) in the chunk to setxMax
- maximum x location (exclusive) in the chunk to setyMax
- maximum y location (exclusive) in the chunk to setzMax
- maximum z location (exclusive) in the chunk to setmaterial
- the type to set the blocks to
-
setRegion
@Deprecated void setRegion(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, @NotNull @NotNull MaterialData material) Deprecated.Set a region of this chunk from xMin, yMin, zMin (inclusive) to xMax, yMax, zMax (exclusive) to material. Setting blocks outside the chunk's bounds does nothing.- Parameters:
xMin
- minimum x location (inclusive) in the chunk to setyMin
- minimum y location (inclusive) in the chunk to setzMin
- minimum z location (inclusive) in the chunk to setxMax
- maximum x location (exclusive) in the chunk to setyMax
- maximum y location (exclusive) in the chunk to setzMax
- maximum z location (exclusive) in the chunk to setmaterial
- the type to set the blocks to
-
setRegion
void setRegion(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, @NotNull @NotNull BlockData blockData) Set a region of this chunk from xMin, yMin, zMin (inclusive) to xMax, yMax, zMax (exclusive) to material. Setting blocks outside the chunk's bounds does nothing.- Parameters:
xMin
- minimum x location (inclusive) in the chunk to setyMin
- minimum y location (inclusive) in the chunk to setzMin
- minimum z location (inclusive) in the chunk to setxMax
- maximum x location (exclusive) in the chunk to setyMax
- maximum y location (exclusive) in the chunk to setzMax
- maximum z location (exclusive) in the chunk to setblockData
- the type to set the blocks to
-
getType
Get the type of the block at x, y, z. Getting blocks outside the chunk's bounds returns air.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusive- Returns:
- the type of the block or Material.AIR if x, y or z are outside the chunk's bounds
-
getTypeAndData
Deprecated.Get the type and data of the block at x, y, z. Getting blocks outside the chunk's bounds returns air.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusive- Returns:
- the type and data of the block or the MaterialData for air if x, y or z are outside the chunk's bounds
-
getBlockData
Get the type and data of the block at x, y, z. Getting blocks outside the chunk's bounds returns air.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusive- Returns:
- the data of the block or the BlockData for air if x, y or z are outside the chunk's bounds
-
getData
Deprecated.Uses magic valuesGet the block data at x,y,z in the chunk data. Getting blocks outside the chunk's bounds returns 0.- Parameters:
x
- the x location in the chunk from 0-15 inclusivey
- the y location in the chunk from minHeight (inclusive) - maxHeight (exclusive)z
- the z location in the chunk from 0-15 inclusive- Returns:
- the block data value or air if x, y or z are outside the chunk's bounds
-