org.pepsoft.minecraft

Class HeightMapChunkFactory

java.lang.Object

org.pepsoft.minecraft.HeightMapChunkFactory

All Implemented Interfaces:

ChunkFactory

public abstract class HeightMapChunkFactory
extends java.lang.Object
implements ChunkFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.minecraft.ChunkFactory

ChunkFactory.ChunkCreationResult, ChunkFactory.Stage, ChunkFactory.Stats

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxHeight
protected int	version

Constructor Summary

Constructors

Constructor and Description
HeightMapChunkFactory(int maxHeight, int version)

Method Summary

Modifier and Type	Method and Description
ChunkFactory.ChunkCreationResult	createChunk(int chunkX, int chunkZ) Create the chunk at the specified location, if present.
protected abstract int	getHeight(int x, int z)
int	getMaxHeight() Get the height of the chunks this chunk factory will create.
int	getMinHeight() Get the depth of the chunks this factory will create.

Methods inherited from class java.lang.Object

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

Field Detail

maxHeight

protected final int maxHeight

version

protected final int version

Constructor Detail

HeightMapChunkFactory

public HeightMapChunkFactory(int maxHeight,
                             int version)

Method Detail

getMinHeight

public int getMinHeight()

Description copied from interface: ChunkFactory

Get the depth of the chunks this factory will create.

Specified by:

getMinHeight in interface ChunkFactory

Returns:

The depth of the chunks this factory will create.

getMaxHeight

public final int getMaxHeight()

Description copied from interface: ChunkFactory

Get the height of the chunks this chunk factory will create.

Specified by:

getMaxHeight in interface ChunkFactory

Returns:

The height of the chunks this factory will create.

createChunk

public final ChunkFactory.ChunkCreationResult createChunk(int chunkX,
                                                          int chunkZ)

Description copied from interface: ChunkFactory

Create the chunk at the specified location, if present. No lighting need be performed.

Specified by:

createChunk in interface ChunkFactory

Parameters:

chunkX - The X coordinate in the Minecraft coordinate space of the chunk to generate.

chunkZ - The Z coordinate in the Minecraft coordinate space of the chunk to generate.

Returns:

The generated chunk, in a data structure along with some statistics about it, or null if no chunk is present at the specified coordinates.

getHeight

protected abstract int getHeight(int x,
                                 int z)