Struct HexTerrainRenderSettings

Render settings for the hex terrain surface. Contains settings that affect mesh generation and rendering.

Implements
Inherited Members
Namespace: Fwt.HexTerrains.Surfaces.Data
Assembly: fwt.hexterrains.dll
Syntax
[BurstCompile]
[Serializable]
public struct HexTerrainRenderSettings : IEquatable<HexTerrainRenderSettings>

Fields

BorderSize

Value from 0 to 1 (part of the Hex are that slopes take)

Declaration
[Tooltip("Value from 0 to 1 (part of the Hex are that plato borders take)")]
public float BorderSize
Field Value
Type Description
float

BorderSubmeshIndex

Index of the submesh where borders will be placed (if IsColoredBorders is true).

Declaration
[Tooltip("Borders will be placed at subhesh with this index (if IsColoredBorders is true)")]
public byte BorderSubmeshIndex
Field Value
Type Description
byte

ColoredSlopeTreshold

If height difference between cells is bigger that this value, bridge will be painted as border.

Declaration
[Tooltip("If height difference between cells is bigger that this value, bridge will be painted as border")]
public byte ColoredSlopeTreshold
Field Value
Type Description
byte

HeightOffset

Additional height offset for the terrain surface relative to the terrain origin. Used, for instance, for water surfaces, so if water level == ground level, there is no visual clipping. If set, this value is usually very small (e.g. 0.01f) - just enough to avoid visual clipping.

Declaration
[Tooltip("Additional height offset for the terrain surface relative to the terrain origin")]
public float HeightOffset
Field Value
Type Description
float

IsColoredBorders

If true, the borders between cells of different ground types will be painted on BorderSubmeshIndex submesh instead of the submesh with index that equals cell's GroundType.

Declaration
[Tooltip("If true, Borders between cells of different ground types will be painted on BorderSubmeshIndex submesh instead of submesh with index that equals cell's GroundType")]
public bool IsColoredBorders
Field Value
Type Description
bool

SlopeSize

Value from 0 to 1 (part of the Hex are that slopes take)

Declaration
[Tooltip("Value from 0 to 1 (part of the Hex are that slopes take)")]
public float SlopeSize
Field Value
Type Description
float

Properties

Default

Declaration
public static HexTerrainRenderSettings Default { get; }
Property Value
Type Description
HexTerrainRenderSettings

Methods

Equals(HexTerrainRenderSettings)

Declaration
public bool Equals(HexTerrainRenderSettings other)
Parameters
Type Name Description
HexTerrainRenderSettings other
Returns
Type Description
bool

Implements

Extension Methods