VoxelGeneratorHeightmap

Base class for several basic height-based generators.

1.0.0

class VoxelGeneratorHeightmapReckfellSharpInherits VoxelGenerator

Base class for several basic height-based generators.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Properties5

ChannelProperty

C#
public VoxelBuffer.ChannelId Channel { get; set; }

Channel where voxels will be generated. If set to VoxelBuffer.ChannelId.ChannelSdf, voxels will be a signed distance field usable by smooth meshers. Otherwise, the value 1 will be set below ground, and the value 0 will be set above ground (blocky).

HeightRangeProperty

# HeightRange

C#
public float HeightRange { get; set; }

Maximum distance between the lowest and highest surface points that can generate. NOTE: due to a bug in Reckfell's documentation tool, the default value shown here is not 30.0, but 200.0. This seems to be because one of the subclasses, VoxelGeneratorWaves, has a different default value, chosen for better practical results. This property also appears in some subclasses now, despite being defined in the base class.

HeightStartProperty

# HeightStart

C#
public float HeightStart { get; set; }

Minimum height where the surface will generate.

IsoScaleProperty

# IsoScale

C#
public float IsoScale { get; set; }

Scale applied to the signed distance field when using a smooth terrain configuration.

OffsetProperty

# Offset

C#
public Vector2I Offset { get; set; }

Offsets height generation along the X and Z axes.

Methods10

GetChannelVoxelBuffer.ChannelId

# GetChannel

C#
public VoxelBuffer.ChannelId GetChannel();

Returns VoxelBuffer.ChannelId

GetHeightRangefloat

# GetHeightRange

C#
public float GetHeightRange();

Returns float

GetHeightStartfloat

# GetHeightStart

C#
public float GetHeightStart();

Returns float

GetIsoScalefloat

# GetIsoScale

C#
public float GetIsoScale();

Returns float

GetOffsetVector2I

# GetOffset

C#
public Vector2I GetOffset();

Returns Vector2I

SetChannelvoid

# SetChannel

C#
public void SetChannel(VoxelBuffer.ChannelId channel);

Parameters
Name	Type	Default
`channel`	`VoxelBuffer.ChannelId`	—

SetHeightRangevoid

# SetHeightRange

C#
public void SetHeightRange(float range);

Parameters
Name	Type	Default
`range`	`float`	—

SetHeightStartvoid

# SetHeightStart

C#
public void SetHeightStart(float start);

Parameters
Name	Type	Default
`start`	`float`	—

SetIsoScalevoid

# SetIsoScale

C#
public void SetIsoScale(float scale);

Parameters
Name	Type	Default
`scale`	`float`	—

SetOffsetvoid

# SetOffset

C#
public void SetOffset(Vector2I offset);

Parameters
Name	Type	Default
`offset`	`Vector2I`	—

Reckfell Engine documentationBack to top ↑