cVerticalLimitBelowTerrain Class Reference

Limit that accepts heights that are within a specified range below terrain. More...

Inheritance diagram for cVerticalLimitBelowTerrain:

Collaboration diagram for cVerticalLimitBelowTerrain:

Public Member Functions
virtual void	AssignGens (int a_Seed, cBiomeGen &a_BiomeGen, cTerrainHeightGen &a_TerrainHeightGen, int a_SeaLevel) override
	Called when the piece pool is assigned to a generator, so that the limits may bind to the underlying subgenerators. More...
virtual bool	CanBeAtHeight (int a_BlockX, int a_BlockZ, int a_Height) override
	Called to inquire whether the specified piece can be placed at the specified height. More...
virtual bool	InitializeFromString (const AString &a_Params, bool a_LogWarnings) override
	Initializes the limit's parameters from the string representation. More...
Public Member Functions inherited from cPiece::cVerticalLimit
virtual	~cVerticalLimit ()

Protected Attributes
int	m_MaxBlocksBelow
	How many blocks below the terrain level do we accept on maximum. More...
int	m_MinBlocksBelow
	How many blocks below the terrain level do we accept on minimum. More...
cTerrainHeightGen *	m_TerrainHeightGen
	The underlying height generator. More...

Detailed Description

Limit that accepts heights that are within a specified range below terrain.

NOTE that the query height is the BOTTOM of the piece.

Definition at line 246 of file VerticalLimit.cpp.

Member Function Documentation

AssignGens()

virtual void cVerticalLimitBelowTerrain::AssignGens ( int  a_Seed, cBiomeGen &  a_BiomeGen, cTerrainHeightGen &  a_TerrainHeightGen, int  a_SeaLevel  )

inlineoverridevirtual

Called when the piece pool is assigned to a generator, so that the limits may bind to the underlying subgenerators.

Reimplemented from cPiece::cVerticalLimit.

Definition at line 270 of file VerticalLimit.cpp.

CanBeAtHeight()

virtual bool cVerticalLimitBelowTerrain::CanBeAtHeight ( int  a_BlockX, int  a_BlockZ, int  a_Height  )

inlineoverridevirtual

Called to inquire whether the specified piece can be placed at the specified height.

a_BlockX, a_BlockZ is the column of the connector that is being queried. a_Height is the requested height of the piece's lowest block.

Implements cPiece::cVerticalLimit.

Definition at line 250 of file VerticalLimit.cpp.

InitializeFromString()

virtual bool cVerticalLimitBelowTerrain::InitializeFromString ( const AString &  a_Params, bool  a_LogWarnings  )

inlineoverridevirtual

Initializes the limit's parameters from the string representation.

a_Params is the string containing only the parameters (substring after the first pipe character in the limit description string). Returns true if successful, false if the string parsing failed. If a_LogWarnings is true, any error while parsing the string is output to the server console. Used when loading the limit from a file.

Implements cPiece::cVerticalLimit.

Definition at line 261 of file VerticalLimit.cpp.

Member Data Documentation

m_MaxBlocksBelow

int cVerticalLimitBelowTerrain::m_MaxBlocksBelow

protected

How many blocks below the terrain level do we accept on maximum.

Definition at line 283 of file VerticalLimit.cpp.

m_MinBlocksBelow

int cVerticalLimitBelowTerrain::m_MinBlocksBelow

protected

How many blocks below the terrain level do we accept on minimum.

Definition at line 280 of file VerticalLimit.cpp.

m_TerrainHeightGen

cTerrainHeightGen* cVerticalLimitBelowTerrain::m_TerrainHeightGen

protected

The underlying height generator.

Definition at line 277 of file VerticalLimit.cpp.

---

The documentation for this class was generated from the following file:

• src/Generating/VerticalLimit.cpp