org.spongepowered.api.world.biome

Class GroundCoverLayer

java.lang.Object

org.spongepowered.api.world.biome.GroundCoverLayer

public class GroundCoverLayer
extends Object

Represents a layer of BlockStates specific to a biome which may be placed in during generation.

Constructor Summary

Constructors

Constructor and Description
GroundCoverLayer(BlockState block, SeededVariableAmount<Double> depth) Creates a new GroundCoverLayer.
GroundCoverLayer(Function<Double,BlockState> block, SeededVariableAmount<Double> depth) Creates a new GroundCoverLayer.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Function<Double,BlockState>	getBlockState() Gets the BlockState for this layer.
SeededVariableAmount<Double>	getDepth() Gets a representation of the depth of this layer.
SeededVariableAmount<Double>	getDepth(int topYCoordinate) Gets a representation of the depth of this layer.
int	hashCode()
void	setBlockState(BlockState block) Sets the BlockState for this layer.
void	setBlockState(Function<Double,BlockState> block) Sets the function which is used to determine the blockstate to place at this layer.
void	setDepth(double depth) Sets the depth of this layer to the given constant value.
void	setDepth(SeededVariableAmount<Double> depth) Sets the SeededVariableAmount representing the depth of this layer.
void	setDepth(VariableAmount depth) Sets the VariableAmount representing the depth of this layer.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GroundCoverLayer

public GroundCoverLayer(BlockState block,
                        SeededVariableAmount<Double> depth)

Creates a new GroundCoverLayer.

Parameters:

block - The block state to place down for the layer

depth - The depth of the layer

GroundCoverLayer

public GroundCoverLayer(Function<Double,BlockState> block,
                        SeededVariableAmount<Double> depth)

Creates a new GroundCoverLayer.

Parameters:

block - The function which is used to determine the blockstate to place at this layer

depth - The depth of the layer

Method Detail

getBlockState

public Function<Double,BlockState> getBlockState()

Gets the BlockState for this layer.

Returns:

The block state

setBlockState

public void setBlockState(Function<Double,BlockState> block)

Sets the function which is used to determine the blockstate to place at this layer. The input to the function is a noise value.

Parameters:

block - The block state function

setBlockState

public void setBlockState(BlockState block)

Sets the BlockState for this layer.

Parameters:

block - The block state

getDepth

public SeededVariableAmount<Double> getDepth()

Gets a representation of the depth of this layer. The variable amount will be seeded with the stone noise at generation time.

Returns:

The depth

getDepth

public SeededVariableAmount<Double> getDepth(int topYCoordinate)

Gets a representation of the depth of this layer. The variable amount will be seeded with the stone noise at generation time. This depth may vary based on the Y position.

Parameters:

topYCoordinate - The Y coordinate of the first block that this layer will apply to.

Returns:

The depth

setDepth

public void setDepth(SeededVariableAmount<Double> depth)

Sets the SeededVariableAmount representing the depth of this layer. The variable amount will be seeded with the stone noise at generation time.

Parameters:

depth - The new variable amount

setDepth

public void setDepth(VariableAmount depth)

Sets the VariableAmount representing the depth of this layer.

Parameters:

depth - The new variable amount

setDepth

public void setDepth(double depth)

Sets the depth of this layer to the given constant value.

Parameters:

depth - The new depth

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object