Struct BoardSize

Representation of the AbstractBoard dimensions, and number of cell and special types.

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.MLAgents.Integrations.Match3

Syntax

public struct BoardSize

Fields

Columns

Number of columns on the board

Declaration

public int Columns

Field Value

Type	Description
Int32

NumCellTypes

Maximum number of different types of cells (colors, pieces, etc).

Declaration

public int NumCellTypes

Field Value

Type	Description
Int32

NumSpecialTypes

Maximum number of special types. This can be zero, in which case all cells of the same type are assumed to be equivalent.

Declaration

public int NumSpecialTypes

Field Value

Type	Description
Int32

Rows

Number of rows on the board

Declaration

public int Rows

Field Value

Type	Description
Int32

Methods

ToString()

Return a string representation of the BoardSize.

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

ValueType.ToString()

Operators

GreaterThanOrEqual(BoardSize, BoardSize)

Check that all fields of the left-hand BoardSize are greater than or equal to the field of the right-hand BoardSize

Declaration

public static bool operator >=(BoardSize lhs, BoardSize rhs)

Parameters

Type	Name	Description
BoardSize	lhs
BoardSize	rhs

Returns

Type	Description
Boolean	True if all fields are greater than or equal.

LessThanOrEqual(BoardSize, BoardSize)

Check that all fields of the left-hand BoardSize are less than or equal to the field of the right-hand BoardSize

Declaration

public static bool operator <=(BoardSize lhs, BoardSize rhs)

Parameters

Type	Name	Description
BoardSize	lhs
BoardSize	rhs

Returns

Type	Description
Boolean	True if all fields are less than or equal.