TableUtils

Returns whether every value in a table is true, iterating numerically.

@param tbl — The table to iterate through.

@return result — Whether every value was true or not.

Returns whether any individual value in a table is true, iterating numerically.

@param tbl — The table to iterate through.

@return result — Whether any value was true or not.

Empties a table of all defined values.

@param tbl — The table to clear.

Whether the table contains the specified value.

@param tbl — The table to check the value from.

@param val — The value to check.

@return result — Whether the table contains the specified value.

Makes a new copy of a table, giving it all of the same values.

@param tbl — The table to copy.

@param deep — Whether tables inside the specified table should be copied as well.

@param seen — (Used internally) A table of values used to keep track of which objects have been cloned.

@return new — The new table.

Copies the values of one table into a different one.

@param new_tbl — The table receiving the copied values.

@param tbl — The table to copy values from.

@param deep — Whether tables inside the specified table should be copied as well.

@param seen — (Used internally) A table of values used to keep track of which objects have been cloned.

Returns a string converting a table value into readable text. Useful for debugging table values.

@param o — The value to convert to a string.

@return result — The newly generated string.

Returns whether a table ends with the specified values.
The function will also return a second value, created by copying the initial value and removing the suffix.

@param value — The table to check the end of.

@param suffix — The values that should be checked.

@return success — Whether the value ended with the specified suffix.

@return rest — A new value created by removing the suffix substring or values from the initial value. If the result was unsuccessful, this value will simply be the initial unedited value.

Returns whether every value in a table satisfies a condition, iterating numerically.

@param tbl — The table to iterate through.

@param func — The condition function.

@return result — Whether every value satisfied the condition or not.

Returns a new table containing only values that a function returns true for.

@param tbl — An array of values.

@param filter — A function that should return true for all values in the table to keep, and false for values to discard.

@return result — A new array containing only approved values.

Removes values from a table if a function does not return true for them.

@param tbl — An array of values.

@param filter — A function that should return true for all values in the table to keep, and false for values to discard.

Merges a list of tables containing values into a single table containing each table's contents.

@param tbl — The array of tables to merge.

@param deep — If true, tables contained inside nested tables will also be merged.

@return result — The new table containing all values.

Flips the values of a 2-dimensional array, such that its columns become its rows, and vice versa.
As an example, the following table:

{
    {1, 2},
    {3, 4},
}

would result in this when passed into the function:

{
    {1, 3},
    {2, 4},
}

@param tbl — The table array to flip the values of.

@return result — The new flipped array.

Returns the position of a specified value found within an array.

@param t — The array to get the position from.

@param value — The value to find the position of.

@return position — The position found for the specified value.

Returns the key of a specified value found within a table.

@param t — The table to get the key from.

@param value — The value to find the key of.

@return key — The key found for the specified value.

Returns how many keys a table has.

@param t — The table to check.

@return result — The amount of keys found.

Returns a list of every key in a table.

@param t — The table to get the keys from.

@return result — An array of each key in the table.

Returns whether a table contains exclusively numerical indexes.

@param tbl — The table to check.

@return result — Whether the table contains only numerical indexes or not.

Lerp between each value in a table.

@param from — The start values of the range.

@param to — The end values of the range.

@param value — The percentage (from 0 to 1) that determines the point on the specified range.

@return result — The new table containing the values from the ranges.

Merges the values of one table into another one.

@param tbl — The table to merge values into.

@param other — The table to copy values from.

@param deep — Whether shared table values between the two tables should also be merged.

@return tbl — The initial table, now containing new values.

Merges many tables into a new table.

@param ... — The tables to merge values from.

@return result — A new table containing the values of the series of tables provided.

Returns a random value from an array.

@param tbl — An array of values.

@return result — The randomly selected value.

Remove duplicate elements from a table.

@param tbl — The table to remove duplicates from.

@param deep — Whether tables inside the tbl will also have their duplicates removed.

@return result — The new table that has its duplicates removed.

Removes the specified value from the table.

@param tbl — The table to remove the value from.

@param val — The value to be removed from the table.

@return val — The now removed value.

Returns a table containing the values of an array in reverse order.

@param tbl — An array of values.

@return result — The new table containing the values of the specified array.

Rotates the values of a 2-dimensional array.
As an example, the following table:

{
    {1, 2},
    {3, 4},
}

would result in this when passed into the function, rotating it clockwise:

{
    {3, 1},
    {4, 2},
}

@param tbl — The table array to rotate the values of.

@param ccw — Whether the rotation should be counterclockwise.

@return result — The new rotated array.

Returns a table containing the values of another table, randomly rearranged.

@param tbl — An array of values.

@return result — The new randomly shuffled array.

Returns whether any individual value in a table satisfies a condition, iterating numerically.

@param tbl — The table to iterate through.

@param func — The condition function.

@return result — Whether any value satisfied the condition or not.

Returns whether a table starts with the specified values.
The function will also return a second value, created by copying the initial value and removing the prefix.

@param value — The table to check the beginning of.

@param prefix — The values that should be checked.

@return success — Whether the value started with the specified prefix.

@return rest — A new value created by removing the prefix substring or values from the initial value. If the result was unsuccessful, this value will simply be the initial unedited value.

Returns every numerically indexed value of a table.
This fixes the issue with unpack() not returning nil values.

@param t — The table to unpack.

@return ... — The values of the table.