net.risingworld.api.utils

Class ChunkLOD

java.lang.Object

net.risingworld.api.utils.ChunkLOD

public class ChunkLOD
extends java.lang.Object

Represents an LOD chunk. These chunks can be considered as a heigth map. Unlike regular chunks, they only have an x and z index - the actual terrain elevation is stored in the surface array in this object. In other words, LOD chunks cannot contain any overhangs.

Field Summary

Fields

Modifier and Type	Field and Description
int	biome Current biome ID
int	cx Chunk offset x
int	cz Chunk offset z
byte[]	surfaceData Converted surface, flattened 3 x 20 x 20 (LAYERS x X x Z) array

Constructor Summary

Constructors

Constructor and Description
ChunkLOD(int cx, int cz, int biome, byte[] surfaceData) Creates a new chunk object.

Method Summary

Modifier and Type	Method and Description
int	getBiome() Gets the biome ID of this chunk.
int	getRawArrayIndex(int layer, int x, int z) Calculates the index in order to access the surface directly.
short	getSurfaceElevation(int x, int z) Gets the surface elevation at the given position.
byte	getSurfaceTerrainID(int x, int z) Gets the surface terrain ID (texture) at the given 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

cz

public int cz

Chunk offset z

biome

public int biome

Current biome ID

surfaceData

public byte[] surfaceData

Converted surface, flattened 3 x 20 x 20 (LAYERS x X x Z) array

Constructor Detail

ChunkLOD

public ChunkLOD(int cx,
                int cz,
                int biome,
                byte[] surfaceData)

Creates a new chunk object.

Parameters:

cx - the x chunk offset.

cz - the z chunk offset.

biome - biome ID.

surfaceData - 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.

getSurfaceTerrainID

public byte getSurfaceTerrainID(int x,
                                int z)

Gets the surface terrain ID (texture) at the given position.

Parameters:

x - the x block position.

z - the z block position.

Returns:

the surface terrain ID..

getSurfaceElevation

public short getSurfaceElevation(int x,
                                 int z)

Gets the surface elevation at the given position. This is the global y position of the surface.

Parameters:

x - the x block position.

z - the z block position.

Returns:

the surface elevation

Example: Teleport player to surface

1	//get player chunk offset
2	Vector3i chunkPos = player.getChunkPosition();
3
4	//get chunk
5	ChunkLOD chunkLOD = world.getChunkLOD(chunkPos.x, chunkPos.z);
6
7	//check if chunk is not null
8	if(chunkLOD != null){
9	//get player block position (inside the chunk)
10	Vector3i blockPos = player.getBlockPosition();
11
12	//get terrain elevation
13	short elevation = chunkLOD.getSurfaceElevation(blockPos.x, blockPos.z);
14
15	//only teleport player if elevation > player y position
16	Vector3f pos = player.getPosition();
17	if(elevation > pos.y){
18	//teleport player to surface:
19	player.setPosition(pos.x, elevation, pos.z);
20	}
21	}

getRawArrayIndex

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

Calculates the index in order to access the surface directly.

Parameters:

layer - the layer index (0-2).

x - the x index.

z - the z index.

Returns:

the converted index in order to access the flattened array.

See Also:

Chunk.getRawArrayIndex(int, int, int)