cIntGenAddToOcean< SizeX, SizeZ > Class Template Reference

Turns some of the oceans into the specified biome. More...

#include <IntGen.h>

Inheritance diagram for cIntGenAddToOcean< SizeX, SizeZ >:

Collaboration diagram for cIntGenAddToOcean< SizeX, SizeZ >:

Public Types
using	Underlying = std::shared_ptr< cIntGen< UnderlyingSizeX, UnderlyingSizeZ > >
Public Types inherited from cIntGen< SizeX, SizeZ >
using	IntGenType = cIntGen< SizeX, SizeZ >
using	Values = int[SizeX *SizeZ]
	Holds the array of values generated by this class (descendant). More...

Public Member Functions
	cIntGenAddToOcean (int a_Seed, int a_Chance, int a_ToValue, Underlying a_Underlying)
virtual void	GetInts (int a_MinX, int a_MinZ, typename Super::Values &a_Values) override
	Generates the array of templated size into a_Values, based on given min coords. More...
Public Member Functions inherited from cIntGenWithNoise< SizeX, SizeX >
	cIntGenWithNoise (int a_Seed)
Public Member Functions inherited from cIntGen< SizeX, SizeZ >
virtual	~cIntGen ()
	Force a virtual destructor in all descendants. More...

Protected Attributes
int	m_Chance
	Chance, in permille, of changing the biome. More...
int	m_ToValue
	The value to change the ocean into. More...
Underlying	m_Underlying
Protected Attributes inherited from cIntGenWithNoise< SizeX, SizeX >
cNoise	m_Noise

Private Types
using	Super = cIntGenWithNoise< SizeX, SizeZ >

Static Private Attributes
static const int	UnderlyingSizeX = SizeX + 2
static const int	UnderlyingSizeZ = SizeZ + 2

Additional Inherited Members
Protected Member Functions inherited from cIntGenWithNoise< SizeX, SizeX >
int	ChooseRandomOne (int a_RndX, int a_RndZ, int a_Val1, int a_Val2)
	Chooses one of a_Val1 or a_Val2, based on m_Noise and the coordinates for querying the noise. More...
int	ChooseRandomOne (int a_RndX, int a_RndZ, int a_Val1, int a_Val2, int a_Val3, int a_Val4)
	Chooses one of a_ValN, based on m_Noise and the coordinates for querying the noise. More...

Detailed Description

template<int SizeX, int SizeZ = SizeX>
class cIntGenAddToOcean< SizeX, SizeZ >

Turns some of the oceans into the specified biome.

Used for mushroom and deep ocean. The biome is only placed if at least 3 of its neighbors are ocean and only with the specified chance.

Definition at line 991 of file IntGen.h.

Member Typedef Documentation

Super

template<int SizeX, int SizeZ = SizeX>

using cIntGenAddToOcean< SizeX, SizeZ >::Super = cIntGenWithNoise<SizeX, SizeZ>

private

Definition at line 994 of file IntGen.h.

Underlying

template<int SizeX, int SizeZ = SizeX>

using cIntGenAddToOcean< SizeX, SizeZ >::Underlying = std::shared_ptr<cIntGen<UnderlyingSizeX, UnderlyingSizeZ> >

Definition at line 1001 of file IntGen.h.

Constructor & Destructor Documentation

cIntGenAddToOcean()

template<int SizeX, int SizeZ = SizeX>

cIntGenAddToOcean< SizeX, SizeZ >::cIntGenAddToOcean ( int  a_Seed, int  a_Chance, int  a_ToValue, Underlying  a_Underlying  )

inline

Definition at line 1004 of file IntGen.h.

Member Function Documentation

GetInts()

template<int SizeX, int SizeZ = SizeX>

virtual void cIntGenAddToOcean< SizeX, SizeZ >::GetInts ( int  a_MinX, int  a_MinZ, typename Super::Values &  a_Values  )

inlineoverridevirtual

Generates the array of templated size into a_Values, based on given min coords.

Implements cIntGen< SizeX, SizeZ >.

Definition at line 1013 of file IntGen.h.

Member Data Documentation

m_Chance

template<int SizeX, int SizeZ = SizeX>

int cIntGenAddToOcean< SizeX, SizeZ >::m_Chance

protected

Chance, in permille, of changing the biome.

Definition at line 1072 of file IntGen.h.

m_ToValue

template<int SizeX, int SizeZ = SizeX>

int cIntGenAddToOcean< SizeX, SizeZ >::m_ToValue

protected

The value to change the ocean into.

Definition at line 1075 of file IntGen.h.

m_Underlying

template<int SizeX, int SizeZ = SizeX>

Underlying cIntGenAddToOcean< SizeX, SizeZ >::m_Underlying

protected

Definition at line 1077 of file IntGen.h.

UnderlyingSizeX

template<int SizeX, int SizeZ = SizeX>

const int cIntGenAddToOcean< SizeX, SizeZ >::UnderlyingSizeX = SizeX + 2

staticprivate

Definition at line 996 of file IntGen.h.

UnderlyingSizeZ

template<int SizeX, int SizeZ = SizeX>

const int cIntGenAddToOcean< SizeX, SizeZ >::UnderlyingSizeZ = SizeZ + 2

staticprivate

Definition at line 997 of file IntGen.h.

---

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

• src/Generating/IntGen.h