Chunk

All Known Subinterfaces:

SectionedChunk

All Known Implementing Classes:

InvertedChunk, MC115AnvilChunk, MC118AnvilChunk, MC12AnvilChunk, MCNamedBlocksChunk, MCNumberedBlocksChunk, MCRegionChunk, MemoryChunk, NBTChunk, VirtualChunk
```
public interface Chunk
```
This API's coordinate system is the Minecraft coordinate system (W <- x -> E, down <- y -> up, N <- z -> S).

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default int`	`get3DBiome(int x, int y, int z)` Get a 3D biome, stored per 4x4x4 block.
`default int`	`getBiome(int x, int z)` Get a 2D biome, stored per column.
`int`	`getBlockLightLevel(int x, int y, int z)`
`int`	`getBlockType(int x, int y, int z)` Deprecated. Use `getMaterial(int, int, int)`
`MinecraftCoords`	`getCoords()`
`int`	`getDataValue(int x, int y, int z)` Deprecated. Use `getMaterial(int, int, int)`
`java.util.List<Entity>`	`getEntities()` Get a list of entities contained in this chunk.
`int`	`getHeight(int x, int z)`
`int`	`getHighestNonAirBlock()` Get the Y coordinate of the highest non-air (block ID zero, any data value) block in the chunk.
`int`	`getHighestNonAirBlock(int x, int z)` Get the Y coordinate of the highest non-air (block ID zero, any data value) block in a specific column.
`long`	`getInhabitedTime()`
`Material`	`getMaterial(int x, int y, int z)`
`int`	`getMaxHeight()`
`default int`	`getMinHeight()`
`default java.lang.String`	`getNamedBiome(int x, int y, int z)` Get a modern biome, stored per 4x4x4 block.
`int`	`getSkyLightLevel(int x, int y, int z)`
`java.util.List<TileEntity>`	`getTileEntities()` Get a list of tile entities (also known as block entities) contained in this chunk.
`int`	`getxPos()`
`int`	`getzPos()`
`default boolean`	`is3DBiomesAvailable()` Indicates whether 3D biomes are available.
`default boolean`	`is3DBiomesSupported()` Indicates whether 3D biomes are supported.
`default boolean`	`isBiomesAvailable()` Indicates whether 2D biomes are available.
`default boolean`	`isBiomesSupported()` Indicates whether 2D biomes are supported.
`boolean`	`isLightPopulated()`
`default boolean`	`isNamedBiomesAvailable()` Indicates whether named biomes are available.
`default boolean`	`isNamedBiomesSupported()` Indicates whether named biomes are supported.
`boolean`	`isReadOnly()`
`boolean`	`isTerrainPopulated()`
`default void`	`markForUpdateChunk(int x, int y, int z)` Mark a block to be updated by Minecraft when next loaded.
`default void`	`set3DBiome(int x, int y, int z, int biome)` Set a 3D biome, stored per 4x4x4 block.
`default void`	`setBiome(int x, int z, int biome)` Set a 2D biome, stored per column.
`void`	`setBlockLightLevel(int x, int y, int z, int blockLightLevel)`
`void`	`setBlockType(int x, int y, int z, int blockType)` Deprecated. Use `setMaterial(int, int, int, Material)`
`void`	`setDataValue(int x, int y, int z, int dataValue)` Deprecated. Use `setMaterial(int, int, int, Material)`
`void`	`setHeight(int x, int z, int height)`
`void`	`setInhabitedTime(long inhabitedTime)`
`void`	`setLightPopulated(boolean lightPopulated)`
`void`	`setMaterial(int x, int y, int z, Material material)`
`default void`	`setNamedBiome(int x, int y, int z, java.lang.String biome)` Set a modern biome, stored per 4x4x4 block.
`void`	`setSkyLightLevel(int x, int y, int z, int skyLightLevel)`
`void`	`setTerrainPopulated(boolean terrainPopulated)`

- Method Detail
  - getBlockLightLevel
```
int getBlockLightLevel(int x,
                       int y,
                       int z)
```
  - setBlockLightLevel
```
void setBlockLightLevel(int x,
                        int y,
                        int z,
                        int blockLightLevel)
```
  - getBlockType
```
@Deprecated
int getBlockType(int x,
                              int y,
                              int z)
```
    Deprecated. Use getMaterial(int, int, int)
  - setBlockType
```
@Deprecated
void setBlockType(int x,
                               int y,
                               int z,
                               int blockType)
```
    Deprecated. Use setMaterial(int, int, int, Material)
  - getDataValue
```
@Deprecated
int getDataValue(int x,
                              int y,
                              int z)
```
    Deprecated. Use getMaterial(int, int, int)
  - setDataValue
```
@Deprecated
void setDataValue(int x,
                               int y,
                               int z,
                               int dataValue)
```
    Deprecated. Use setMaterial(int, int, int, Material)
  - getHeight
```
int getHeight(int x,
              int z)
```
  - setHeight
```
void setHeight(int x,
               int z,
               int height)
```
  - getSkyLightLevel
```
int getSkyLightLevel(int x,
                     int y,
                     int z)
```
  - setSkyLightLevel
```
void setSkyLightLevel(int x,
                      int y,
                      int z,
                      int skyLightLevel)
```
  - getxPos
```
int getxPos()
```
  - getzPos
```
int getzPos()
```
  - getCoords
```
MinecraftCoords getCoords()
```
  - isTerrainPopulated
```
boolean isTerrainPopulated()
```
  - setTerrainPopulated
```
void setTerrainPopulated(boolean terrainPopulated)
```
  - getMaterial
```
Material getMaterial(int x,
                     int y,
                     int z)
```
  - setMaterial
```
void setMaterial(int x,
                 int y,
                 int z,
                 Material material)
```
  - getEntities
```
java.util.List<Entity> getEntities()
```
    Get a list of entities contained in this chunk. This list must be an editable live view; in other words it must be possible to add or remove entities by editing this list.
    
    Returns:
    
    An editable live view of the entities contained in this chunk.
  - getTileEntities
```
java.util.List<TileEntity> getTileEntities()
```
    Get a list of tile entities (also known as block entities) contained in this chunk. This list must be an editable live view; in other words it must be possible to add or remove tile entities by editing this list.
    
    Returns:
    
    An editable live view of the tile entities contained in this chunk.
  - getMinHeight
```
default int getMinHeight()
```
  - getMaxHeight
```
int getMaxHeight()
```
  - isBiomesSupported
```
default boolean isBiomesSupported()
```
    Indicates whether 2D biomes are supported. See getBiome(int, int) and setBiome(int, int, int).
    The default implementation returns false.
  - isBiomesAvailable
```
default boolean isBiomesAvailable()
```
    Indicates whether 2D biomes are available. See getBiome(int, int) and setBiome(int, int, int).
    The default implementation returns false.
  - is3DBiomesSupported
```
default boolean is3DBiomesSupported()
```
    Indicates whether 3D biomes are supported. See get3DBiome(int, int, int) and set3DBiome(int, int, int, int).
    The default implemenation returns false.
  - is3DBiomesAvailable
```
default boolean is3DBiomesAvailable()
```
    Indicates whether 3D biomes are available. See get3DBiome(int, int, int) and set3DBiome(int, int, int, int).
    The default implemenation returns false.
  - isNamedBiomesSupported
```
default boolean isNamedBiomesSupported()
```
    Indicates whether named biomes are supported. See getNamedBiome(int, int, int) and setNamedBiome(int, int, int, String).
    The default implementation returns false.
  - isNamedBiomesAvailable
```
default boolean isNamedBiomesAvailable()
```
    Indicates whether named biomes are available. See getNamedBiome(int, int, int) and setNamedBiome(int, int, int, String).
    The default implementation returns false.
  - getBiome
```
default int getBiome(int x,
                     int z)
```
    Get a 2D biome, stored per column. Throws an UnsupportedOperationException when invoked on a format which does not support 2D biomes.
  - setBiome
```
default void setBiome(int x,
                      int z,
                      int biome)
```
    Set a 2D biome, stored per column. Throws an UnsupportedOperationException when invoked on a format which does not support 2D biomes.
  - get3DBiome
```
default int get3DBiome(int x,
                       int y,
                       int z)
```
    Get a 3D biome, stored per 4x4x4 block. The coordinates are that of the 4x4x4 block, not of an individual block. Throws an UnsupportedOperationException when invoked on a format which does not support 3D biomes.
  - set3DBiome
```
default void set3DBiome(int x,
                        int y,
                        int z,
                        int biome)
```
    Set a 3D biome, stored per 4x4x4 block. The coordinates are that of the 4x4x4 block, not of an individual block. Throws an UnsupportedOperationException when invoked on a format which does not support 3D biomes.
  - getNamedBiome
```
default java.lang.String getNamedBiome(int x,
                                       int y,
                                       int z)
```
    Get a modern biome, stored per 4x4x4 block. The coordinates are that of the 4x4x4 block, not of an individual block. Throws an UnsupportedOperationException when invoked on a format which does not support modern biomes.
  - setNamedBiome
```
default void setNamedBiome(int x,
                           int y,
                           int z,
                           java.lang.String biome)
```
    Set a modern biome, stored per 4x4x4 block. The coordinates are that of the 4x4x4 block, not of an individual block. Throws an UnsupportedOperationException when invoked on a format which does not support named biomes.
  - markForUpdateChunk
```
default void markForUpdateChunk(int x,
                                int y,
                                int z)
```
    Mark a block to be updated by Minecraft when next loaded. Coordinates local to chunk.
    The default implementation does nothing.
  - isReadOnly
```
boolean isReadOnly()
```
  - isLightPopulated
```
boolean isLightPopulated()
```
  - setLightPopulated
```
void setLightPopulated(boolean lightPopulated)
```
  - getInhabitedTime
```
long getInhabitedTime()
```
  - setInhabitedTime
```
void setInhabitedTime(long inhabitedTime)
```
  - getHighestNonAirBlock
```
int getHighestNonAirBlock(int x,
                          int z)
```
    Get the Y coordinate of the highest non-air (block ID zero, any data value) block in a specific column. This is allowed to be an approximation, as long as it is the same or higher than the actual highest non-air block.
    
    Parameters:
    
    x - The X coordinate of the column relative to the chunk.
    
    z - The Z coordinate of the column relative to the chunk.
    
    Returns:
    
    The Y coordinate of the highest non-air (block ID zero, any data value) block in the specified column or Integer.MIN_VALUE if the column is empty.
  - getHighestNonAirBlock
```
int getHighestNonAirBlock()
```
    Get the Y coordinate of the highest non-air (block ID zero, any data value) block in the chunk. This is allowed to be an approximation, as long as it is the same or higher than the actual highest non-air block.
    
    Returns:
    
    The Y coordinate of the highest non-air (block ID zero, any data value) block in the chunk or Integer.MIN_VALUE if the chunk is empty.

Interface Chunk

Method Summary

Method Detail

getBlockLightLevel

setBlockLightLevel

getBlockType

setBlockType

getDataValue

setDataValue

getHeight

setHeight

getSkyLightLevel

setSkyLightLevel

getxPos

getzPos

getCoords

isTerrainPopulated

setTerrainPopulated

getMaterial

setMaterial

getEntities

getTileEntities

getMinHeight

getMaxHeight

isBiomesSupported

isBiomesAvailable

is3DBiomesSupported

is3DBiomesAvailable

isNamedBiomesSupported

isNamedBiomesAvailable

getBiome

setBiome

get3DBiome

set3DBiome

getNamedBiome

setNamedBiome

markForUpdateChunk

isReadOnly

isLightPopulated

setLightPopulated

getInhabitedTime

setInhabitedTime

getHighestNonAirBlock

getHighestNonAirBlock