MemoryChunk

java.lang.Object
- org.pepsoft.minecraft.MemoryChunk

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, Chunk, ChunkProvider, MinecraftWorld
```
public class MemoryChunk
extends java.lang.Object
implements Chunk, MinecraftWorld, java.io.Serializable
```
A platform-independent, in-memory chunk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MemoryChunk.Section

Nested Classes
Modifier and Type	Class and Description
`static class`	`MemoryChunk.Section`

Field Summary

Fields
Modifier and Type Field and Description

boolean readOnly

Fields
Modifier and Type	Field and Description
`boolean`	`readOnly`

Constructor Summary

Constructors
Constructor and Description

MemoryChunk(int xPos, int zPos, int minHeight, int maxHeight)

Constructors
Constructor and Description
`MemoryChunk(int xPos, int zPos, int minHeight, int maxHeight)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChunk(Chunk chunk)` Add a chunk.
`void`	`addEntity(double x, double y, double height, Entity entity)`
`void`	`addTileEntity(int x, int y, int height, TileEntity tileEntity)`
`MCRegionChunk`	`clone()`
`void`	`close()` Close the chunk provider, flushing any changes and closing any system resources.
`boolean`	`equals(java.lang.Object obj)`
`int`	`get3DBiome(int x, int y, int z)` Get a 3D biome, stored per 4x4x4 block.
`int`	`getBiome(int x, int z)` Get a 2D biome, stored per column.
`int`	`getBlockLightLevel(int x, int y, int z)` Returns `0` if `height` is too large.
`int`	`getBlockType(int x, int y, int z)`
`int`	`getBlockTypeAt(int x, int y, int height)` Returns `Constants.BLK_AIR` if `height` is too large.
`Chunk`	`getChunk(int x, int z)` Retrieve a chunk.
`Chunk`	`getChunkForEditing(int x, int z)` Retrieve a chunk for editing.
`MinecraftCoords`	`getCoords()`
`int`	`getDataAt(int x, int y, int height)` Returns `0` if `height` is too large.
`int`	`getDataValue(int x, int y, int z)`
`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)`
`Material`	`getMaterialAt(int x, int y, int height)` Returns `null` if `height` is too large.
`int`	`getMaxHeight()`
`int`	`getMinHeight()`
`MemoryChunk.Section[]`	`getSections()`
`int`	`getSkyLightLevel(int x, int y, int z)` Returns `15` if `height` is too large.
`java.util.List<TileEntity>`	`getTileEntities()` Get a list of tile entities (also known as block entities) contained in this chunk.
`int`	`getxPos()`
`int`	`getzPos()`
`int`	`hashCode()`
`boolean`	`is3DBiomesAvailable()` Indicates whether 3D biomes are available.
`boolean`	`is3DBiomesSupported()` Indicates whether 3D biomes are supported.
`boolean`	`isBiomesAvailable()` Indicates whether 2D biomes are available.
`boolean`	`isBiomesSupported()` Indicates whether 2D biomes are supported.
`boolean`	`isChunkPresent(int x, int y)` Determine whether the world contains any data in a particular chunk (a 16 by 16 block area).
`boolean`	`isLightPopulated()`
`boolean`	`isReadOnly()`
`boolean`	`isSectionPresent(int y)`
`boolean`	`isTerrainPopulated()`
`void`	`set3DBiome(int x, int y, int z, int biome)` Set a 3D biome, stored per 4x4x4 block.
`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)` Fails silently if `height` is too large.
`void`	`setBlockType(int x, int y, int z, int blockType)`
`void`	`setBlockTypeAt(int x, int y, int height, int blockType)` Fails silently if `height` is too large.
`void`	`setDataAt(int x, int y, int height, int data)` Fails silently if `height` is too large.
`void`	`setDataValue(int x, int y, int z, int dataValue)`
`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)`
`void`	`setMaterialAt(int x, int y, int height, Material material)` Fails silently if `height` is too large.
`void`	`setSkyLightLevel(int x, int y, int z, int skyLightLevel)` Fails silently if `height` is too large.
`void`	`setTerrainPopulated(boolean terrainPopulated)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepsoft.minecraft.Chunk
getNamedBiome, isNamedBiomesAvailable, isNamedBiomesSupported, markForUpdateChunk, setNamedBiome

Methods inherited from interface org.pepsoft.worldpainter.exporting.MinecraftWorld
markForUpdateWorld

- Field Detail
  - readOnly
```
public final boolean readOnly
```
- Constructor Detail
  - MemoryChunk
```
public MemoryChunk(int xPos,
                   int zPos,
                   int minHeight,
                   int maxHeight)
```
- Method Detail
  - isSectionPresent
```
public boolean isSectionPresent(int y)
```
  - getSections
```
public MemoryChunk.Section[] getSections()
```
  - getMinHeight
```
public int getMinHeight()
```
    Specified by:
    
    getMinHeight in interface Chunk
    
    Specified by:
    
    getMinHeight in interface MinecraftWorld
  - getMaxHeight
```
public int getMaxHeight()
```
    Specified by:
    
    getMaxHeight in interface Chunk
    
    Specified by:
    
    getMaxHeight in interface MinecraftWorld
  - getxPos
```
public int getxPos()
```
    Specified by:
    
    getxPos in interface Chunk
  - getzPos
```
public int getzPos()
```
    Specified by:
    
    getzPos in interface Chunk
  - getCoords
```
public MinecraftCoords getCoords()
```
    Specified by:
    
    getCoords in interface Chunk
  - getBlockType
```
public int getBlockType(int x,
                        int y,
                        int z)
```
    Specified by:
    
    getBlockType in interface Chunk
  - setBlockType
```
public void setBlockType(int x,
                         int y,
                         int z,
                         int blockType)
```
    Specified by:
    
    setBlockType in interface Chunk
  - getDataValue
```
public int getDataValue(int x,
                        int y,
                        int z)
```
    Specified by:
    
    getDataValue in interface Chunk
  - setDataValue
```
public void setDataValue(int x,
                         int y,
                         int z,
                         int dataValue)
```
    Specified by:
    
    setDataValue in interface Chunk
  - getSkyLightLevel
```
public int getSkyLightLevel(int x,
                            int y,
                            int z)
```
    Description copied from interface: MinecraftWorld
    
    Returns 15 if height is too large.
    
    Specified by:
    
    getSkyLightLevel in interface Chunk
    
    Specified by:
    
    getSkyLightLevel in interface MinecraftWorld
  - setSkyLightLevel
```
public void setSkyLightLevel(int x,
                             int y,
                             int z,
                             int skyLightLevel)
```
    Description copied from interface: MinecraftWorld
    
    Fails silently if height is too large.
    
    Specified by:
    
    setSkyLightLevel in interface Chunk
    
    Specified by:
    
    setSkyLightLevel in interface MinecraftWorld
  - getBlockLightLevel
```
public int getBlockLightLevel(int x,
                              int y,
                              int z)
```
    Description copied from interface: MinecraftWorld
    
    Returns 0 if height is too large.
    
    Specified by:
    
    getBlockLightLevel in interface Chunk
    
    Specified by:
    
    getBlockLightLevel in interface MinecraftWorld
  - setBlockLightLevel
```
public void setBlockLightLevel(int x,
                               int y,
                               int z,
                               int blockLightLevel)
```
    Description copied from interface: MinecraftWorld
    
    Fails silently if height is too large.
    
    Specified by:
    
    setBlockLightLevel in interface Chunk
    
    Specified by:
    
    setBlockLightLevel in interface MinecraftWorld
  - getHeight
```
public int getHeight(int x,
                     int z)
```
    Specified by:
    
    getHeight in interface Chunk
  - setHeight
```
public void setHeight(int x,
                      int z,
                      int height)
```
    Specified by:
    
    setHeight in interface Chunk
  - isBiomesSupported
```
public boolean isBiomesSupported()
```
    Description copied from interface: Chunk
    
    Indicates whether 2D biomes are supported. See Chunk.getBiome(int, int) and Chunk.setBiome(int, int, int).
    The default implementation returns false.
    
    Specified by:
    
    isBiomesSupported in interface Chunk
  - isBiomesAvailable
```
public boolean isBiomesAvailable()
```
    Description copied from interface: Chunk
    
    Indicates whether 2D biomes are available. See Chunk.getBiome(int, int) and Chunk.setBiome(int, int, int).
    The default implementation returns false.
    
    Specified by:
    
    isBiomesAvailable in interface Chunk
  - is3DBiomesSupported
```
public boolean is3DBiomesSupported()
```
    Description copied from interface: Chunk
    
    Indicates whether 3D biomes are supported. See Chunk.get3DBiome(int, int, int) and Chunk.set3DBiome(int, int, int, int).
    The default implemenation returns false.
    
    Specified by:
    
    is3DBiomesSupported in interface Chunk
  - is3DBiomesAvailable
```
public boolean is3DBiomesAvailable()
```
    Description copied from interface: Chunk
    
    Indicates whether 3D biomes are available. See Chunk.get3DBiome(int, int, int) and Chunk.set3DBiome(int, int, int, int).
    The default implemenation returns false.
    
    Specified by:
    
    is3DBiomesAvailable in interface Chunk
  - getBiome
```
public int getBiome(int x,
                    int z)
```
    Description copied from interface: Chunk
    
    Get a 2D biome, stored per column. Throws an UnsupportedOperationException when invoked on a format which does not support 2D biomes.
    
    Specified by:
    
    getBiome in interface Chunk
  - setBiome
```
public void setBiome(int x,
                     int z,
                     int biome)
```
    Description copied from interface: Chunk
    
    Set a 2D biome, stored per column. Throws an UnsupportedOperationException when invoked on a format which does not support 2D biomes.
    
    Specified by:
    
    setBiome in interface Chunk
  - get3DBiome
```
public int get3DBiome(int x,
                      int y,
                      int z)
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    get3DBiome in interface Chunk
  - set3DBiome
```
public void set3DBiome(int x,
                       int y,
                       int z,
                       int biome)
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    set3DBiome in interface Chunk
  - isTerrainPopulated
```
public boolean isTerrainPopulated()
```
    Specified by:
    
    isTerrainPopulated in interface Chunk
  - setTerrainPopulated
```
public void setTerrainPopulated(boolean terrainPopulated)
```
    Specified by:
    
    setTerrainPopulated in interface Chunk
  - getEntities
```
public java.util.List<Entity> getEntities()
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    getEntities in interface Chunk
    
    Returns:
    
    An editable live view of the entities contained in this chunk.
  - getTileEntities
```
public java.util.List<TileEntity> getTileEntities()
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    getTileEntities in interface Chunk
    
    Returns:
    
    An editable live view of the tile entities contained in this chunk.
  - getMaterial
```
public Material getMaterial(int x,
                            int y,
                            int z)
```
    Specified by:
    
    getMaterial in interface Chunk
  - setMaterial
```
public void setMaterial(int x,
                        int y,
                        int z,
                        Material material)
```
    Specified by:
    
    setMaterial in interface Chunk
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface Chunk
  - isLightPopulated
```
public boolean isLightPopulated()
```
    Specified by:
    
    isLightPopulated in interface Chunk
  - setLightPopulated
```
public void setLightPopulated(boolean lightPopulated)
```
    Specified by:
    
    setLightPopulated in interface Chunk
  - getInhabitedTime
```
public long getInhabitedTime()
```
    Specified by:
    
    getInhabitedTime in interface Chunk
  - setInhabitedTime
```
public void setInhabitedTime(long inhabitedTime)
```
    Specified by:
    
    setInhabitedTime in interface Chunk
  - getHighestNonAirBlock
```
public int getHighestNonAirBlock(int x,
                                 int z)
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    getHighestNonAirBlock in interface Chunk
    
    Specified by:
    
    getHighestNonAirBlock in interface MinecraftWorld
    
    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
```
public int getHighestNonAirBlock()
```
    Description copied from interface: Chunk
    
    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.
    
    Specified by:
    
    getHighestNonAirBlock in interface Chunk
    
    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.
  - getBlockTypeAt
```
public int getBlockTypeAt(int x,
                          int y,
                          int height)
```
    Description copied from interface: MinecraftWorld
    
    Returns Constants.BLK_AIR if height is too large.
    
    Specified by:
    
    getBlockTypeAt in interface MinecraftWorld
  - getDataAt
```
public int getDataAt(int x,
                     int y,
                     int height)
```
    Description copied from interface: MinecraftWorld
    
    Returns 0 if height is too large.
    
    Specified by:
    
    getDataAt in interface MinecraftWorld
  - getMaterialAt
```
public Material getMaterialAt(int x,
                              int y,
                              int height)
```
    Description copied from interface: MinecraftWorld
    
    Returns null if height is too large.
    
    Specified by:
    
    getMaterialAt in interface MinecraftWorld
  - setBlockTypeAt
```
public void setBlockTypeAt(int x,
                           int y,
                           int height,
                           int blockType)
```
    Description copied from interface: MinecraftWorld
    
    Fails silently if height is too large.
    
    Specified by:
    
    setBlockTypeAt in interface MinecraftWorld
  - setDataAt
```
public void setDataAt(int x,
                      int y,
                      int height,
                      int data)
```
    Description copied from interface: MinecraftWorld
    
    Fails silently if height is too large.
    
    Specified by:
    
    setDataAt in interface MinecraftWorld
  - setMaterialAt
```
public void setMaterialAt(int x,
                          int y,
                          int height,
                          Material material)
```
    Description copied from interface: MinecraftWorld
    
    Fails silently if height is too large.
    
    Specified by:
    
    setMaterialAt in interface MinecraftWorld
  - isChunkPresent
```
public boolean isChunkPresent(int x,
                              int y)
```
    Description copied from interface: MinecraftWorld
    
    Determine whether the world contains any data in a particular chunk (a 16 by 16 block area).
    
    Specified by:
    
    isChunkPresent in interface ChunkProvider
    
    Specified by:
    
    isChunkPresent in interface MinecraftWorld
    
    Parameters:
    
    x - The X coordinate in chunk coordinates.
    
    y - The Y coordinate in chunk coordinates.
    
    Returns:
    
    true if data is present for the specified chunk.
  - addChunk
```
public void addChunk(Chunk chunk)
```
    Description copied from interface: MinecraftWorld
    
    Add a chunk. Not all implementations support adding chunks, and some may only accept chunks belonging to a specific Platform.
    
    Specified by:
    
    addChunk in interface MinecraftWorld
    
    Parameters:
    
    chunk - The chunk to add.
  - addEntity
```
public void addEntity(double x,
                      double y,
                      double height,
                      Entity entity)
```
    Specified by:
    
    addEntity in interface MinecraftWorld
  - addTileEntity
```
public void addTileEntity(int x,
                          int y,
                          int height,
                          TileEntity tileEntity)
```
    Specified by:
    
    addTileEntity in interface MinecraftWorld
  - getChunk
```
public Chunk getChunk(int x,
                      int z)
```
    Description copied from interface: ChunkProvider
    
    Retrieve a chunk. If the chunk does not exist, null is returned. The returned chunk may be read-only.
    
    Specified by:
    
    getChunk in interface ChunkProvider
    
    Parameters:
    
    x - The X coordinate of the chunk to retrieve.
    
    z - The Z coordinate of the chunk to retrieve.
    
    Returns:
    
    The specified chunk, or null if there is no chunk at the specified coordinates.
  - getChunkForEditing
```
public Chunk getChunkForEditing(int x,
                                int z)
```
    Description copied from interface: ChunkProvider
    
    Retrieve a chunk for editing. If the chunk does not exist, null may be returned, or the provider may create a new, empty chunk. The returned chunk is guaranteed not to be read-only.
    
    Specified by:
    
    getChunkForEditing in interface ChunkProvider
    
    Parameters:
    
    x - The X coordinate of the chunk to retrieve.
    
    z - The Z coordinate of the chunk to retrieve.
    
    Returns:
    
    The specified chunk, or null if there is no chunk at the specified coordinates, and this chunk provider does not create new chunks.
  - close
```
public void close()
```
    Description copied from interface: ChunkProvider
    
    Close the chunk provider, flushing any changes and closing any system resources.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface ChunkProvider
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - clone
```
public MCRegionChunk clone()
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.UnsupportedOperationException

Class MemoryChunk

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.pepsoft.minecraft.Chunk

Methods inherited from interface org.pepsoft.worldpainter.exporting.MinecraftWorld

Field Detail

readOnly

Constructor Detail

MemoryChunk

Method Detail

isSectionPresent

getSections

getMinHeight

getMaxHeight

getxPos

getzPos

getCoords

getBlockType

setBlockType

getDataValue

setDataValue

getSkyLightLevel

setSkyLightLevel

getBlockLightLevel

setBlockLightLevel

getHeight

setHeight

isBiomesSupported

isBiomesAvailable

is3DBiomesSupported

is3DBiomesAvailable

getBiome

setBiome

get3DBiome

set3DBiome

isTerrainPopulated

setTerrainPopulated

getEntities

getTileEntities

getMaterial

setMaterial

isReadOnly

isLightPopulated

setLightPopulated

getInhabitedTime

setInhabitedTime

getHighestNonAirBlock

getHighestNonAirBlock

getBlockTypeAt

getDataAt

getMaterialAt

setBlockTypeAt

setDataAt

setMaterialAt

isChunkPresent

addChunk

addEntity

addTileEntity

getChunk

getChunkForEditing

close

equals

hashCode

clone