Struct RectCellValue

A DataTableBase UnityEngine.Rect cell reference.

Namespace: GDX.DataTables.CellValues

Syntax

[Serializable]
public struct RectCellValue

Constructors

| Improve this Doc View Source

RectCellValue(DataTableBase, Int32, Int32)

Creates a RectCellValue.

Declaration

public RectCellValue(DataTableBase dataTable, int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
DataTableBase	dataTable	The referenced DataTableBase.
System.Int32	rowIdentifier	The unique row identifier to use when polling the `dataTable`.
System.Int32	columnIdentifier	The unique column identifier to use when polling the `dataTable`.

Fields

| Improve this Doc View Source

ColumnIdentifier

The unique column identifier used when accessing the DataTable.

Declaration

public int ColumnIdentifier

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

DataTable

The DataTableBase polled for cell data.

Declaration

public DataTableBase DataTable

Field Value

Type	Description
DataTableBase

| Improve this Doc View Source

RowIdentifier

The unique row identifier used when accessing the DataTable.

Declaration

public int RowIdentifier

Field Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

Get()

Get the UnityEngine.Rect value referenced from the DataTableBase.

Declaration

public Rect Get()

Returns

Type	Description
UnityEngine.Rect	A UnityEngine.Rect struct.

Remarks

This will evaluate if the version of the table matches the internally cached version, and will update the cached reference if necessary.

| Improve this Doc View Source

GetDataVersion()

Get the internally cached version of the DataTableBase's data version.

Declaration

public ulong GetDataVersion()

Returns

Type	Description
System.UInt64	A version number.

| Improve this Doc View Source

GetSupportedType()

Get the Serializable.SerializableTypes which this struct supports.

Declaration

public static Serializable.SerializableTypes GetSupportedType()

Returns

Type	Description
Serializable.SerializableTypes	A Serializable.SerializableTypes.

| Improve this Doc View Source

GetUnsafe()

Get the cached value without a version check.

Declaration

public Rect GetUnsafe()

Returns

Type	Description
UnityEngine.Rect	A UnityEngine.Rect struct.

Remarks

This can respond with a default value if a Get() call has not been made yet to populate the internally cached value.

| Improve this Doc View Source

Set(Rect, Boolean)

Sets the cached value of the struct and by default, updates the associated DataTableBase.

Declaration

public void Set(Rect newValue, bool updateTable = true)

Parameters

Type	Name	Description
UnityEngine.Rect	newValue	A UnityEngine.Rect struct.
System.Boolean	updateTable	Should the value be pushed back to the referenced DataTableBase cell?

Remarks

Updating the DataTableBase will update the cached table version.