OrderedTable

Inherits: LibTSMModule

Functions

ConcatKeys

function BaseType.OrderedTable.ConcatKeys(tbl, sep)
  -> string

Concatenate the keys into a string.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>
sep	string	The separator string

Returns:

Type	Description
string

GetByIndex

function BaseType.OrderedTable.GetByIndex(tbl, index)
  -> <K>, <V>

Gets a value from an ordered table by index.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>
index	number

Returns:

Type	Description
<K>
<V>

Insert

function BaseType.OrderedTable.Insert(tbl, key, value)

Inserts into an ordered table.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table
key	K	The key to insert
value	V	The value to insert

InsertIfNotSet

function BaseType.OrderedTable.InsertIfNotSet(tbl, key, value)

Inserts into an ordered table if the key wasn't previously set.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table
key	K	The key to insert
value	V	The value to insert

Iterator

function BaseType.OrderedTable.Iterator(tbl)
  -> fun():number, K, V, V[] & table<K, V>

Iterates over an ordered table.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table

Returns:

Type	Description
fun():number, K, V	Iterator with fields: index, key, value
V[] & table<K, V>

KeyIterator

function BaseType.OrderedTable.KeyIterator(tbl)
  -> fun():number, K, V[] & table<K, V>

Iterates over the keys of an ordered table.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table

Returns:

Type	Description
fun():number, K	Iterator with fields: key
V[] & table<K, V>

Remove

function BaseType.OrderedTable.Remove(tbl, key)

Removes from an ordered table.

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table
key	K	The key to remove

SortByKeys

function BaseType.OrderedTable.SortByKeys(tbl)

Sorts the ordered table by its keys

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table

SortByValues

function BaseType.OrderedTable.SortByValues(tbl)

Sorts the ordered table by its values

Parameters:

Name	Type	Description
tbl	OrderedTable.Table<K, V>	The ordered table