Limit that accepts heights below the specified fixed height. More...

Inheritance diagram for cVerticalLimitBelow:

Collaboration diagram for cVerticalLimitBelow:

Public Member Functions
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 void	AssignGens (int a_Seed, cBiomeGen &a_BiomeGen, cTerrainHeightGen &a_TerrainHeightGen, int a_SeaLevel)
	Called when the piece pool is assigned to a generator, so that the limits may bind to the underlying subgenerators. More...

virtual	~cVerticalLimit ()

Protected Attributes
int	m_MaxHeight
	The maximum accepted height. More...

Detailed Description

Limit that accepts heights below the specified fixed height.

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

Definition at line 213 of file VerticalLimit.cpp.

Member Function Documentation

◆ CanBeAtHeight()

virtual bool cVerticalLimitBelow::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 217 of file VerticalLimit.cpp.

◆ InitializeFromString()

virtual bool cVerticalLimitBelow::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 223 of file VerticalLimit.cpp.

Member Data Documentation

◆ m_MaxHeight

int cVerticalLimitBelow::m_MaxHeight

protected

The maximum accepted height.

Definition at line 236 of file VerticalLimit.cpp.

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

src/Generating/VerticalLimit.cpp