NamedTupleList

Inherits: Class

Methods

GetNumRows

function NamedTupleList:GetNumRows()
  -> number

Gets the number of rows in the list.

Returns:

Type	Description
number

GetRow

function NamedTupleList:GetRow(rowIndex)
  -> ...any

Gets the data for a given row.

Parameters:

Name	Type	Description
rowIndex	number	The row index

Returns:

Type	Description
...any

GetRowField

function NamedTupleList:GetRowField(rowIndex, fieldName)
  -> any

Gets a single field for a given row.

Parameters:

Name	Type	Description
rowIndex	number	The row index
fieldName	string	The name of the field

Returns:

Type	Description
any

InsertRow

function NamedTupleList:InsertRow(...)
  -> number

Insert a row into the list and returns its index.

Parameters:

Name	Type	Description
...	any	The row values

Returns:

Type	Description
number

Iterator

function NamedTupleList:Iterator()
  -> fun():number, ...any, table, number

Iterates over each row in the list.

Returns:

Type	Description
fun():number, ...any	Iterator with fields: rowIndex, ...
table
number

RemoveRow

function NamedTupleList:RemoveRow(rowIndex)

Removes a row at a given index. NOTE: This will invalidate other row indexes.

Parameters:

Name	Type	Description
rowIndex	number	The row index

SetRowField

function NamedTupleList:SetRowField(rowIndex, fieldName, value)

Sets a single field for a given row.

Parameters:

Name	Type	Description
rowIndex	number	The row index
fieldName	string	The name of the field
value	any	The field value

Wipe

function NamedTupleList:Wipe()

Wipes the list.

Functions

New

function NamedTupleList.New(...)
  -> NamedTupleList

Creates a new named tuple list.

Parameters:

Name	Type	Description
...	string	The tuple field names, in order

Returns:

Type	Description
NamedTupleList