Setmetatable: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''Class:''' [[(global)]]<br/>
=== Description ===
=== Description ===
<translate>Sets the [[metatable` for the given table. (You cannot change the `metatable` of other types from Lua, only from C.) If `metatable` is nil, removes the `metatable` of the given table. If the original `metatable]] has a "__metatable" field, raises an error.
Sets the ''metatable'' for the given table.
<syntaxhighlight lang="lua">
(table) = setmetatable(table,metatable)
</syntaxhighlight>


You cannot change the ''metatable'' of other types from Lua, only from C.
If ''metatable'' is nil, removes the ''metatable'' of the given table.
If the original ''metatable'' has a "__metatable" field, raises an error.
This function returns a table.


This function returns table.</translate>
<source lang="lua">
(table) = setmetatable(table,metatable)
</source>
=== Parameters ===
=== Parameters ===
'''table''': (table) <translate>table to set metatable to</translate> <br/>
'''table''': (table) table to set metatable to<br/>
'''metatable''': (varies) <translate>value to use as metatable</translate> <br/>
'''metatable''': (varies) value to use as metatable<br/>
 
=== Return values ===
=== Return values ===
'''Returns''' (table) <translate>provided table</translate><br/>
'''Returns''' (table) provided table<br/>
 
=== See also ===
'''https://luau.org/library#global-functions'''<br/>
 
{{(global)}}

Latest revision as of 10:26, 21 July 2025

Available since: Gideros 2011.6
Class: (global)

Description

Sets the metatable for the given table.

(table) = setmetatable(table,metatable)
You cannot change the metatable of other types from Lua, only from C.

If metatable is nil, removes the metatable of the given table.

If the original metatable has a "__metatable" field, raises an error.

This function returns a table.

Parameters

table: (table) table to set metatable to
metatable: (varies) value to use as metatable

Return values

Returns (table) provided table

See also

https://luau.org/library#global-functions