Struct HexTerrainLayerReference

Inherited Members
Namespace: Fwt.HexTerrains.Data
Assembly: fwt.hexterrains.dll
Syntax
[Serializable]
public struct HexTerrainLayerReference

Fields

IsSearchByIndex

If true, searches for the layer by index in the layers list by LayerIndex

Declaration
[Tooltip("If true, searches for the layer by index in the layers list by Layer Index")]
public bool IsSearchByIndex
Field Value
Type Description
bool

IsSearchByName

If true, searches for the layer by name in the layers list by LayerName

Declaration
[Tooltip("If true, searches for the layer by name in the layers list by Layer Name")]
public bool IsSearchByName
Field Value
Type Description
bool

LayerIndex

If Search By Index is true, this index is used to search for the layer in the layers list.

Declaration
[Min(0)]
[Tooltip("If Search By Index is true, this index is used to search for the layer in the layers list.")]
public int LayerIndex
Field Value
Type Description
int

LayerName

If Search By Name is true, this name is used to search for the layer in the layers list.

Declaration
[Tooltip("If Search By Name is true, this name is used to search for the layer in the layers list.")]
public string LayerName
Field Value
Type Description
string

Properties

Default

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

Methods

ByLayerIndex(int)

Creates a reference to a terrain layer by its zero-based index.

Declaration
public static HexTerrainLayerReference ByLayerIndex(int layerIndex)
Parameters
Type Name Description
int layerIndex

The zero-based index of the terrain layer to reference. Must be greater than or equal to 0 and less than the total number of layers.
Returns
Type Description
HexTerrainLayerReference

A HexTerrainLayerReference that identifies the terrain layer at the specified index.

ByLayerIndexAndName(int, string)

Creates a new reference to a terrain layer using both the specified layer index and layer name.

Declaration
public static HexTerrainLayerReference ByLayerIndexAndName(int layerIndex, string layerName)
Parameters
Type Name Description
int layerIndex

The zero-based index of the terrain layer to reference.
string layerName

The name of the terrain layer to reference. Cannot be null.
Returns
Type Description
HexTerrainLayerReference

A new HexTerrainLayerReference that identifies a terrain layer by both its index and name.
Remarks

Use this method when you need to reference a terrain layer by both its index and name, ensuring that both criteria are used for identification.

ByLayerName(string)

Creates a reference to a terrain layer identified by its name.

Declaration
public static HexTerrainLayerReference ByLayerName(string layerName)
Parameters
Type Name Description
string layerName

The name of the terrain layer to reference. Cannot be null.
Returns
Type Description
HexTerrainLayerReference

A new HexTerrainLayerReference configured to search for a layer by name.

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Extension Methods