Class DataTableBase

The base framework of a UnityEngine.ScriptableObject backed DataTable.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.ScriptableObject

DataTableBase

StableDataTable

Namespace: GDX.DataTables

Syntax

public abstract class DataTableBase : ScriptableObject

Remarks

Similar to UE's https://docs.unrealengine.com/5.2/en-US/data-driven-gameplay-elements-in-unreal-engine/.

Methods

AddColumn(Serializable.SerializableTypes, String, Int32)

Add a column.

Declaration

public abstract int AddColumn(Serializable.SerializableTypes columnType, string columnName, int insertAtColumnIdentifier = -1)

Parameters

Type	Name	Description
Serializable.SerializableTypes	columnType	The type of data being stored in the column.
System.String	columnName	The user-friendly name of the column.
System.Int32	insertAtColumnIdentifier	The column identifier to insert the column at, otherwise -1 will place the column at the end.

Returns

Type	Description
System.Int32	The unique column identifier of the created column.

AddRow(String, Int32)

Add a row

Declaration

public abstract int AddRow(string rowName = null, int insertAtRowIdentifier = -1)

Parameters

Type	Name	Description
System.String	rowName	The user-friendly name of the column.
System.Int32	insertAtRowIdentifier	The row identifier to insert the row at, otherwise -1 will place the row at the end.

Returns

Type	Description
System.Int32	The unique row identifier of the created row.

GetAllColumnDescriptions()

Get all columns' ColumnDescription; ordered.

Declaration

public abstract ColumnDescription[] GetAllColumnDescriptions()

Returns

Type	Description
ColumnDescription[]	An array of ColumnDescriptions.

GetAllRowDescriptions()

Get all rows' RowDescription; ordered.

Declaration

public abstract RowDescription[] GetAllRowDescriptions()

Returns

Type	Description
RowDescription[]	An array of RowDescriptions.

GetAnimationCurve(Int32, Int32)

Get a UnityEngine.AnimationCurve object from the specified cell.

Declaration

public abstract AnimationCurve GetAnimationCurve(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.AnimationCurve	A UnityEngine.AnimationCurve object.

GetBool(Int32, Int32)

Get a System.Boolean value from the specified cell.

Declaration

public abstract bool GetBool(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Boolean	A System.Boolean value.

GetBounds(Int32, Int32)

Get a UnityEngine.Bounds struct from the specified cell.

Declaration

public abstract Bounds GetBounds(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Bounds	A UnityEngine.Bounds struct.

GetBoundsInt(Int32, Int32)

Get a UnityEngine.BoundsInt struct from the specified cell.

Declaration

public abstract BoundsInt GetBoundsInt(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.BoundsInt	A UnityEngine.BoundsInt struct.

GetByte(Int32, Int32)

Get a System.Byte value from the specified cell.

Declaration

public abstract byte GetByte(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Byte	A System.Byte value.

GetChar(Int32, Int32)

Get a System.Char value from the specified cell.

Declaration

public abstract char GetChar(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Char	A System.Char value.

GetColor(Int32, Int32)

Get a UnityEngine.Color struct from the specified cell.

Declaration

public abstract Color GetColor(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Color	A UnityEngine.Color struct.

GetColumnCount()

Returns the number of columns in the .

Declaration

public abstract int GetColumnCount()

Returns

Type	Description
System.Int32	A count of columns.

GetColumnDescription(Int32)

Get a ColumnDescription describing a column in the specified position.

Declaration

public abstract ColumnDescription GetColumnDescription(int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
ColumnDescription	A ColumnDescription for the target column.

GetColumnDescriptionByOrder(Int32)

Get a ColumnDescription describing a column in the specified position.

Declaration

public abstract ColumnDescription GetColumnDescriptionByOrder(int order)

Parameters

Type	Name	Description
System.Int32	order	The ordered index/position.

Returns

Type	Description
ColumnDescription	A ColumnDescription for the target column.

GetColumnName(Int32)

Get the user-friendly name of the identified column.

Declaration

public abstract string GetColumnName(int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.String	A user-friendly name.

GetColumnOrder(Int32)

Set the specified column's order.

Declaration

public abstract int GetColumnOrder(int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Int32	The column's order/position.

GetDataVersion()

Get the internally stored data version for the DataTableBase.

Declaration

public abstract ulong GetDataVersion()

Returns

Type	Description
System.UInt64

Remarks

Every time something changes in the table, be it structural or data, this value is changed. This allows for checks of if cached values need to be re-polled.

GetDouble(Int32, Int32)

Get a System.Double value from the specified cell.

Declaration

public abstract double GetDouble(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Double	A System.Double value.

GetEnumInt(Int32, Int32)

Get am System.Int32 value of an enumeration from the specified cell.

Declaration

public abstract int GetEnumInt(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Int32	An integer value for the enumeration

GetFloat(Int32, Int32)

Get a System.Single value from the specified cell.

Declaration

public abstract float GetFloat(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Single	A System.Single value.

GetGradient(Int32, Int32)

Get a UnityEngine.Gradient object from the specified cell.

Declaration

public abstract Gradient GetGradient(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Gradient	A UnityEngine.Gradient object.

GetHash128(Int32, Int32)

Get a UnityEngine.Hash128 struct from the specified cell.

Declaration

public abstract Hash128 GetHash128(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Hash128	A UnityEngine.Hash128 struct.

GetInt(Int32, Int32)

Get a System.Int32 value from the specified cell.

Declaration

public abstract int GetInt(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Int32	A System.Int32 value.

GetLayerMask(Int32, Int32)

Get a UnityEngine.LayerMask struct from the specified cell.

Declaration

public abstract LayerMask GetLayerMask(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.LayerMask	A UnityEngine.LayerMask struct.

GetLong(Int32, Int32)

Get a System.Int64 value from the specified cell.

Declaration

public abstract long GetLong(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Int64	A System.Int64 value.

GetMetaData()

Gets/creates the metadata sub-object used to store author-time information with the data table.

Declaration

public DataTableMetaData GetMetaData()

Returns

Type	Description
DataTableMetaData	The associated metadata for the DataTableBase.

Remarks

This is only available in the editor. It will always return null at runtime.

GetObject(Int32, Int32)

Get an UnityEngine.Object object from the specified cell.

Declaration

public abstract Object GetObject(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Object	An UnityEngine.Object.

GetQuaternion(Int32, Int32)

Get a UnityEngine.Quaternion struct from the specified cell.

Declaration

public abstract Quaternion GetQuaternion(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Quaternion	A UnityEngine.Quaternion struct.

GetRect(Int32, Int32)

Get a UnityEngine.Rect struct from the specified cell.

Declaration

public abstract Rect GetRect(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Rect	A UnityEngine.Rect struct.

GetRectInt(Int32, Int32)

Get a UnityEngine.RectInt struct from the specified cell.

Declaration

public abstract RectInt GetRectInt(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.RectInt	A UnityEngine.RectInt struct.

GetRowCount()

Returns the number of rows in the .

Declaration

public abstract int GetRowCount()

Returns

Type	Description
System.Int32	A count of rows.

GetRowDescription(Int32)

Get a RowDescription describing a row.

Declaration

public abstract RowDescription GetRowDescription(int rowIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.

Returns

Type	Description
RowDescription	A RowDescription for the target row.

GetRowDescriptionByOrder(Int32)

Get a RowDescription describing a row in the specified position.

Declaration

public abstract RowDescription GetRowDescriptionByOrder(int order)

Parameters

Type	Name	Description
System.Int32	order	The ordered index/position.

Returns

Type	Description
RowDescription	A RowDescription for the target row.

GetRowName(Int32)

Get the user-friendly name of the identified row.

Declaration

public abstract string GetRowName(int rowIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.

Returns

Type	Description
System.String	A user-friendly name.

GetRowOrder(Int32)

Get the specified row's order.

Declaration

public abstract int GetRowOrder(int rowIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.

Returns

Type	Description
System.Int32	The row's order/position.

GetSByte(Int32, Int32)

Get a System.SByte value from the specified cell.

Declaration

public abstract sbyte GetSByte(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.SByte	A System.SByte value.

GetShort(Int32, Int32)

Get a System.Int16 value from the specified cell.

Declaration

public abstract short GetShort(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.Int16	A System.Int16 value.

GetString(Int32, Int32)

Get a System.String value from the specified cell.

Declaration

public abstract string GetString(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.String	A System.String value.

GetStructureCurrentVersion()

Get the current structure version for the DataTableBase class itself.

Declaration

public abstract int GetStructureCurrentVersion()

Returns

Type	Description
System.Int32	The structure version number.

GetStructureVersion()

Get the internally stored structure version for the DataTableBase.

Declaration

public abstract int GetStructureVersion()

Returns

Type	Description
System.Int32	The structure version number.

Remarks

Think of this as format version, if the internals change and the table needs to be updated this is the indicator for old data.

GetTypeNameForColumn(Int32)

Get the type's assembly qualified name for the specified column.

Declaration

public abstract string GetTypeNameForColumn(int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.String	An assembly qualified name.

GetUInt(Int32, Int32)

Get a System.UInt32 value from the specified cell.

Declaration

public abstract uint GetUInt(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.UInt32	A System.UInt32 value.

GetULong(Int32, Int32)

Get a System.UInt64 value from the specified cell.

Declaration

public abstract ulong GetULong(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.UInt64	A System.UInt64 value.

GetUShort(Int32, Int32)

Get a System.UInt16 value from the specified cell.

Declaration

public abstract ushort GetUShort(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
System.UInt16	A System.UInt16 value.

GetVector2(Int32, Int32)

Get a UnityEngine.Vector2 struct from the specified cell.

Declaration

public abstract Vector2 GetVector2(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Vector2	A UnityEngine.Vector2 struct.

GetVector2Int(Int32, Int32)

Get a UnityEngine.Vector2Int struct from the specified cell.

Declaration

public abstract Vector2Int GetVector2Int(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Vector2Int	A UnityEngine.Vector2Int struct.

GetVector3(Int32, Int32)

Get a UnityEngine.Vector3 struct from the specified cell.

Declaration

public abstract Vector3 GetVector3(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Vector3	A UnityEngine.Vector3 struct.

GetVector3Int(Int32, Int32)

Get a UnityEngine.Vector3Int struct from the specified cell.

Declaration

public abstract Vector3Int GetVector3Int(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Vector3Int	A UnityEngine.Vector3Int struct.

GetVector4(Int32, Int32)

Get a UnityEngine.Vector4 struct from the specified cell.

Declaration

public abstract Vector4 GetVector4(int rowIdentifier, int columnIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.

Returns

Type	Description
UnityEngine.Vector4	A UnityEngine.Vector4 struct.

Migrate(Int32)

Applies migration logic used to upgrade previous implementations of a DataTableBase.

Declaration

public abstract bool Migrate(int currentVersion)

Parameters

Type	Name	Description
System.Int32	currentVersion	The current version of a DataTableBase format.

Returns

Type	Description
System.Boolean	Was the migration successful?

RemoveColumn(Serializable.SerializableTypes, Int32)

Remove a column.

Declaration

public abstract void RemoveColumn(Serializable.SerializableTypes columnType, int columnIdentifier = -1)

Parameters

Type	Name	Description
Serializable.SerializableTypes	columnType	The type of data being stored in the column.
System.Int32	columnIdentifier	The known column's identifier.

RemoveRow(Int32)

Remove a row.

Declaration

public abstract void RemoveRow(int rowIdentifier)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The known row's identifier.

SetAllColumnOrders(Int32[])

Set the order of columns in the DataTableBase.

Declaration

public abstract void SetAllColumnOrders(int[] orderedColumnIdentifiers)

Parameters

Type	Name	Description
System.Int32[]	orderedColumnIdentifiers	An array of column unique identifiers, in the order to be set.

SetAllRowOrders(Int32[])

Set the order of rows in the DataTableBase.

Declaration

public abstract void SetAllRowOrders(int[] orderedRowIdentifiers)

Parameters

Type	Name	Description
System.Int32[]	orderedRowIdentifiers	An array of row unique identifiers, in the order to be set.

SetAnimationCurve(Int32, Int32, AnimationCurve)

Sets the specified cell's UnityEngine.AnimationCurve object.

Declaration

public abstract ulong SetAnimationCurve(int rowIdentifier, int columnIdentifier, AnimationCurve newObject)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.AnimationCurve	newObject	The updated object.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetBool(Int32, Int32, Boolean)

Sets the specified cell's System.Boolean value.

Declaration

public abstract ulong SetBool(int rowIdentifier, int columnIdentifier, bool newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Boolean	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetBounds(Int32, Int32, Bounds)

Sets the specified cell's UnityEngine.Bounds struct.

Declaration

public abstract ulong SetBounds(int rowIdentifier, int columnIdentifier, Bounds newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Bounds	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetBoundsInt(Int32, Int32, BoundsInt)

Sets the specified cell's UnityEngine.BoundsInt struct.

Declaration

public abstract ulong SetBoundsInt(int rowIdentifier, int columnIdentifier, BoundsInt newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.BoundsInt	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetByte(Int32, Int32, Byte)

Sets the specified cell's System.Byte value.

Declaration

public abstract ulong SetByte(int rowIdentifier, int columnIdentifier, byte newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Byte	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetChar(Int32, Int32, Char)

Sets the specified cell's System.Char value.

Declaration

public abstract ulong SetChar(int rowIdentifier, int columnIdentifier, char newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Char	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetColor(Int32, Int32, Color)

Sets the specified cell's UnityEngine.Color struct.

Declaration

public abstract ulong SetColor(int rowIdentifier, int columnIdentifier, Color newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Color	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetColumnName(Int32, String)

Set the user-friendly name of the identified column.

Declaration

public abstract void SetColumnName(int columnIdentifier, string columnName)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.
System.String	columnName	The desired user-friendly name for the column.

SetColumnOrder(Int32, Int32)

Set the specified column's order.

Declaration

public abstract void SetColumnOrder(int columnIdentifier, int newSortOrder)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.
System.Int32	newSortOrder	The ordered index/position.

SetDouble(Int32, Int32, Double)

Sets the specified cell's System.Double value.

Declaration

public abstract ulong SetDouble(int rowIdentifier, int columnIdentifier, double newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Double	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetEnumInt(Int32, Int32, Int32)

Sets the specified cell's enumeration value.

Declaration

public abstract ulong SetEnumInt(int rowIdentifier, int columnIdentifier, int newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Int32	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetFloat(Int32, Int32, Single)

Sets the specified cell's System.Single value.

Declaration

public abstract ulong SetFloat(int rowIdentifier, int columnIdentifier, float newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Single	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetGradient(Int32, Int32, Gradient)

Sets the specified cell's UnityEngine.Gradient object.

Declaration

public abstract ulong SetGradient(int rowIdentifier, int columnIdentifier, Gradient newObject)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Gradient	newObject	The updated object.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetHash128(Int32, Int32, Hash128)

Sets the specified cell's UnityEngine.Hash128 struct.

Declaration

public abstract ulong SetHash128(int rowIdentifier, int columnIdentifier, Hash128 newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Hash128	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetInt(Int32, Int32, Int32)

Sets the specified cell's System.Int32 value.

Declaration

public abstract ulong SetInt(int rowIdentifier, int columnIdentifier, int newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Int32	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetLayerMask(Int32, Int32, LayerMask)

Sets the specified cell's UnityEngine.LayerMask struct.

Declaration

public abstract ulong SetLayerMask(int rowIdentifier, int columnIdentifier, LayerMask newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.LayerMask	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetLong(Int32, Int32, Int64)

Sets the specified cell's System.Int64 value.

Declaration

public abstract ulong SetLong(int rowIdentifier, int columnIdentifier, long newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Int64	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetObject(Int32, Int32, Object)

Sets the specified cell's UnityEngine.Object object.

Declaration

public abstract ulong SetObject(int rowIdentifier, int columnIdentifier, Object newObject)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Object	newObject	The updated object.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetQuaternion(Int32, Int32, Quaternion)

Sets the specified cell's UnityEngine.Quaternion struct.

Declaration

public abstract ulong SetQuaternion(int rowIdentifier, int columnIdentifier, Quaternion newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Quaternion	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetRect(Int32, Int32, Rect)

Sets the specified cell's UnityEngine.Rect struct.

Declaration

public abstract ulong SetRect(int rowIdentifier, int columnIdentifier, Rect newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Rect	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetRectInt(Int32, Int32, RectInt)

Sets the specified cell's UnityEngine.RectInt struct.

Declaration

public abstract ulong SetRectInt(int rowIdentifier, int columnIdentifier, RectInt newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.RectInt	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetRowName(Int32, String)

Set the user-friendly name of the identified row.

Declaration

public abstract void SetRowName(int rowIdentifier, string rowName)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.String	rowName	The desired user-friendly name for the row.

SetRowOrder(Int32, Int32)

Set the specified row's order.

Declaration

public abstract void SetRowOrder(int rowIdentifier, int newSortOrder)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	newSortOrder	The ordered index/position.

SetSByte(Int32, Int32, SByte)

Sets the specified cell's System.SByte value.

Declaration

public abstract ulong SetSByte(int rowIdentifier, int columnIdentifier, sbyte newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.SByte	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetShort(Int32, Int32, Int16)

Sets the specified cell's System.Int16 value.

Declaration

public abstract ulong SetShort(int rowIdentifier, int columnIdentifier, short newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.Int16	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetString(Int32, Int32, String)

Sets the specified cell's System.String value.

Declaration

public abstract ulong SetString(int rowIdentifier, int columnIdentifier, string newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.String	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetTypeNameForColumn(Int32, String)

Set the type's assembly qualified name for the specified column.

Declaration

public abstract void SetTypeNameForColumn(int columnIdentifier, string assemblyQualifiedName)

Parameters

Type	Name	Description
System.Int32	columnIdentifier	The unique column identifier.
System.String	assemblyQualifiedName	The assembly qualified name.

Remarks

More info can be found at https://learn.microsoft.com/en-us/dotnet/api/system.type.assemblyqualifiedname?view=net-7.0. This allows for filtering of the generated fields.

SetUInt(Int32, Int32, UInt32)

Sets the specified cell's System.UInt32 value.

Declaration

public abstract ulong SetUInt(int rowIdentifier, int columnIdentifier, uint newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.UInt32	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetULong(Int32, Int32, UInt64)

Sets the specified cell's System.UInt64 value.

Declaration

public abstract ulong SetULong(int rowIdentifier, int columnIdentifier, ulong newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.UInt64	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetUShort(Int32, Int32, UInt16)

Sets the specified cell's System.UInt16 value.

Declaration

public abstract ulong SetUShort(int rowIdentifier, int columnIdentifier, ushort newValue)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
System.UInt16	newValue	The updated value.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetVector2(Int32, Int32, Vector2)

Sets the specified cell's UnityEngine.Vector2 struct.

Declaration

public abstract ulong SetVector2(int rowIdentifier, int columnIdentifier, Vector2 newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Vector2	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetVector2Int(Int32, Int32, Vector2Int)

Sets the specified cell's UnityEngine.Vector2Int struct.

Declaration

public abstract ulong SetVector2Int(int rowIdentifier, int columnIdentifier, Vector2Int newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Vector2Int	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetVector3(Int32, Int32, Vector3)

Sets the specified cell's UnityEngine.Vector3 struct.

Declaration

public abstract ulong SetVector3(int rowIdentifier, int columnIdentifier, Vector3 newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Vector3	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetVector3Int(Int32, Int32, Vector3Int)

Sets the specified cell's UnityEngine.Vector3Int struct.

Declaration

public abstract ulong SetVector3Int(int rowIdentifier, int columnIdentifier, Vector3Int newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Vector3Int	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

SetVector4(Int32, Int32, Vector4)

Sets the specified cell's UnityEngine.Vector4 struct.

Declaration

public abstract ulong SetVector4(int rowIdentifier, int columnIdentifier, Vector4 newStruct)

Parameters

Type	Name	Description
System.Int32	rowIdentifier	The unique row identifier.
System.Int32	columnIdentifier	The unique column identifier.
UnityEngine.Vector4	newStruct	The updated struct.

Returns

Type	Description
System.UInt64	The DataTableBase's updated data version.

Extension Methods

ObjectExtensions.SafeDestroy(Object, Single)

DataTableExtensions.GetCellValueAsString(DataTableBase, Int32, Int32, Serializable.SerializableTypes)

DataTableExtensions.SetCellValueFromString(DataTableBase, Int32, Int32, String, Serializable.SerializableTypes)