Difference between revisions of "Table.freeze"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
Line 7: Line 7:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
(table) = table.freeze(t)
 
(table) = table.freeze(t)
</source>
+
</syntaxhighlight>
  
 
  '''This freezing effect is shallow, which means that you can write to a table within a frozen table. To deep freeze a table, call this function recursively on all of the descending tables'''
 
  '''This freezing effect is shallow, which means that you can write to a table within a frozen table. To deep freeze a table, call this function recursively on all of the descending tables'''

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2022.3
Class: table

Description

This function makes the given table read-only, effectively "freezing" it in its current state. Attempting to modify a frozen table throws an error.

(table) = table.freeze(t)
This freezing effect is shallow, which means that you can write to a table within a frozen table. To deep freeze a table, call this function recursively on all of the descending tables

Parameters

t: (table) table to freeze

Return values

Returns (table) the frozen table