Struct TerrainId

Namespace

Core.Data.Ids

Assembly

Core.dll

Type-safe terrain identifier Prevents mixing up terrain IDs with other entity IDs at compile time Following data-linking-architecture.md specifications

[Serializable]
public readonly struct TerrainId

Constructors

TerrainId(byte)

public TerrainId(byte value)

Parameters

value byte

Fields

Ocean

Special constant for ocean terrain (always 0)

public static readonly TerrainId Ocean

Field Value

TerrainId

Value

public readonly byte Value

Field Value

byte

Properties

IsLand

Check if this is a valid land terrain (not ocean)

public bool IsLand { get; }

Property Value

bool

Methods

Equals(TerrainId)

public bool Equals(TerrainId other)

Parameters

other TerrainId

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(TerrainId, TerrainId)

public static bool operator ==(TerrainId left, TerrainId right)

Parameters

left TerrainId

right TerrainId

Returns

bool

implicit operator byte(TerrainId)

public static implicit operator byte(TerrainId id)

Parameters

id TerrainId

Returns

byte

implicit operator TerrainId(byte)

public static implicit operator TerrainId(byte value)

Parameters

value byte

Returns

TerrainId

operator !=(TerrainId, TerrainId)

public static bool operator !=(TerrainId left, TerrainId right)

Parameters

left TerrainId

right TerrainId

Returns

bool