Difference between revisions of "Setmetatable"

Latest revision as of 15:32, 13 July 2023

Available since: Gideros 2011.6
Class: (global)

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.

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

Returns (table) provided table

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2011.6<br/>
+'''Class:''' [[(global)]]<br/>
 === Description ===
-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.
+=== Parameters ===
-<source lang="lua">
+'''table''': (table) table to set metatable to<br/>
-(table), = setmetatable(tablemetatable,)
+'''metatable''': (varies) value to use as metatable<br/>
-</source>
-'''table:''' (table) table to set metatable to ''''''<br/>
+=== Return values ===
-'''metatable:''' (varies) value to use as metatable ''''''<br/>
 '''Returns''' (table) provided table<br/>
+{{(global)}}