Struct FaceLayoutIndex

Contains an index into the tileset's list of faces, uniquely referencing a face layout (the positions, normals, edges, and materials for all vertices touching the face of the tile cube).

Because this is an index, you can use it to access face data by array offset, an O(1) operation.

This array index works for all arrays of face data, both tileset (e.g. finding the matching face) and slot data (e.g. reading and updating the number of faces left for a face)

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: CarbideFunction.Wildtile

Syntax

public struct FaceLayoutIndex

Fields

indexName

Static access to the CarbideFunction.Wildtile.FaceLayoutIndex.index field. Used in Unity serialization to read/write to the field, while keeping the field private in C#.

Declaration

public const string indexName = ""

Field Value

Type	Description
System.String

Properties

Index

Readonly access to the underlying int value for this face layout. This value is unique to this face layout in this tileset.

Declaration

public readonly IntegerType Index { get; }

Property Value

Type	Description
IntegerType

Methods

Equals(FaceLayoutIndex)

Test if another object is equal to this object.

Declaration

public bool Equals(FaceLayoutIndex otherIndex)

Parameters

Type	Name	Description
FaceLayoutIndex	otherIndex

Returns

Type	Description
System.Boolean

Equals(Object)

Test if another object is a FaceLayoutIndex and is equal to this object.

Declaration

public override bool Equals(object otherIndexObject)

Parameters

Type	Name	Description
System.Object	otherIndexObject

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

FromRawInt(IntegerType)

Creates a new FaceLayoutIndex with the given faceIndex.

Declaration

public static FaceLayoutIndex FromRawInt(IntegerType faceIndex)

Parameters

Type	Name	Description
IntegerType	faceIndex

Returns

Type	Description
FaceLayoutIndex

GetHashCode()

Returns the face layout index. Required as part of the override for Equals(Object).

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

ToString()

Returns the face index as a string (e.g. Face Index 5).

Intended to be used for debugging only.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()