net.risingworld.api.utils

Class Chunk

java.lang.Object

net.risingworld.api.utils.Chunk

public class Chunk
extends java.lang.Object

Represents a chunk. A chunk has a size of 16 x 64 x 16 blocks (x y z). It represents 3d terrain as a voxel grid.
A chunk stores information about the terrain data and the block data (as well as some meta data per chunk, e.g. the biome).

Field Summary

Fields

Modifier and Type	Field and Description
int	biome Current biome ID
short[]	blockData Converted block data, flattened 20 x 68 x 20 (X x Y x Z) array
int	cx Chunk offset x
int	cy Chunk offset y
int	cz Chunk offset z
byte[]	terrainData Converted terrain data, flattened 20 x 68 x 20 (X x Y x Z) array

Constructor Summary

Constructors

Constructor and Description
Chunk(int cx, int cy, int cz, int biome, short[] blockData, byte[] terrainData) Creates a new chunk object.

Method Summary

Modifier and Type	Method and Description
int	getBiome() Gets the biome ID of this chunk.
short	getBlockID(int x, int y, int z) Gets the block ID at a certain position.
int	getRawArrayIndex(int x, int y, int z) Calculates the index in order to access the terrain / block arrays directly.
byte	getTerrainID(int x, int y, int z) Gets the terrain ID at a certain position.
void	setBiome(int newBiomeID) Sets the new biome ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cx

public int cx

Chunk offset x

cy

public int cy

Chunk offset y

cz

public int cz

Chunk offset z

biome

public int biome

Current biome ID

blockData

public short[] blockData

Converted block data, flattened 20 x 68 x 20 (X x Y x Z) array

terrainData

public byte[] terrainData

Converted terrain data, flattened 20 x 68 x 20 (X x Y x Z) array

Constructor Detail

Chunk

public Chunk(int cx,
             int cy,
             int cz,
             int biome,
             short[] blockData,
             byte[] terrainData)

Creates a new chunk object.

Parameters:

cx - the x chunk offset.

cy - the y chunk offset.

cz - the z chunk offset.

biome - biome ID.

blockData - a short-array representing the converted block data.

terrainData - a byte-array representing the converted terrain data.

Method Detail

getBiome

public int getBiome()

Gets the biome ID of this chunk.

Returns:

the biome ID.

setBiome

public void setBiome(int newBiomeID)

Sets the new biome ID.

Parameters:

newBiomeID - the new biome ID.

getTerrainID

public byte getTerrainID(int x,
                         int y,
                         int z)

Gets the terrain ID at a certain position.

Parameters:

x - the x block position.

y - the y block position.

z - the z block position.

Returns:

the terrain ID.

getBlockID

public short getBlockID(int x,
                        int y,
                        int z)

Gets the block ID at a certain position.

Parameters:

x - the x block position.

y - the y block position.

z - the z block position.

Returns:

the block ID.

getRawArrayIndex

public int getRawArrayIndex(int x,
                            int y,
                            int z)

Calculates the index in order to access the terrain / block arrays directly. These arrays are flattened 3-dimensional arrays (flattened means they're represented as a single, one dimensional array, in order to save memory).
Each chunk has a size of 16 x 64 x 16 blocks (X x Y x Z), but every chunk also holds the block information of the borders of the neighbour chunks (2 additional rows in each direction), so the total size of the array is 20 x 68 x 20.
Also keep this in mind when accessing an array. If you want to access the block position 0|0|0 (the first block in the chunk), for example, you have to increment the index by 2 (i.e. by calling getRawArrayIndex(0+2, 0+2, 0+2);

Parameters:

x - the x index.

y - the y index.

z - the z index.

Returns:

the converted index in order to access the flattened array. This works for the blockData as well as for the terrainData array.

Example: Access the terrainData array directly at position x=8, y=15, z=0

1	//Remember that each array contains information of the neighbour blocks
2	//(2 rows in each direction), so if you want to access the actual 8|15|0
3	//index, you have to increment them by 2)
4	int index = chunk.getRawArrayIndex(8 + 2, 15 + 2, 0 + 2);
5	byte terrainID = chunk.terrainData[index];
6	System.out.println("Terrain ID at position 8|15|0: " + terrainID);