Garry's Mod Wiki

Home / History for Concepts - Userdata

Revision Difference

userdata#561702

<cat>Dev.Lua</cat> Userdata is a type primarily used in the Lua C API. The userdata points to data in C, such as an object. There are two types of userdata: full userdata and light userdata. The word userdata alone implies full userdata. See also <page>light userdata</page>.⤶ ⤶ Full userdata is more commonly used than light userdata. You've probably already worked with full userdata, but are unaware of it. Types like panels and entities are userdata, but function very similarly to tables. This is due to the fact that, like tables, full userdata can have metatables. Unlike tables, however, full userdata cannot be indexed, and will not work with functions in the table library. Arbitrary values can be assigned to types like entities because of the entity userdatum's metatable, which uses the __newindex metamethod to set values in the entity's internal Lua table. Correspondingly, the __index metamethod checks the entity's internal Lua table for the key, and returns its value. It is through these functions that types like entities can be indexed as if they are tables. Full userdata is garbage collected, and Lua lets full userdata know it's about to be collected by calling the userdatum's __gc metamethod, passing the userdatum itself as an argument. This allows for any resources used by the userdatum to be freed on the C side, such as deleting an object or releasing a file handle.⤶ ⤶ You can create empty userdata with <page>Global.newproxy</page>.<title>Userdata</title>⤶ ⤶ # Userdata⤶ ⤶ Userdata is a type primarily used in the **Lua C API** that points to ⤶ C data - such as objects - and comes in two flavors, full & light.⤶ ⤶ ⤶ ⤶ <br/>⤶ ⤶ ## Full Userdata⤶ ⤶ When people mention `userdata` they likely refer to `full userdata`.⤶ ⤶ Most of the time you will encounter full userdata objects, ⤶ such as panels & entities that function similar to tables.⤶ ⤶ Create empty userdata with <page>Global.newproxy</page>.⤶ ⤶ <br/>⤶ ⤶ ### Details⤶ ⤶ Full userdata can have metatables, however it be indexed, ⤶ and will not work with functions in the table library. ⤶ ⤶ Arbitrary values can be assigned to types like entities because ⤶ of the entity userdatum's metatable, which uses the `__newindex` ⤶ metamethod to set values in the entity's internal Lua table. ⤶ ⤶ Correspondingly, the `__index` metamethod checks the ⤶ entity's internal Lua table for the key, and returns its value. ⤶ ⤶ It is through these functions that types like ⤶ entities can be indexed as if they are tables. ⤶ ⤶ Full userdata is garbage collected, and Lua lets full userdata ⤶ know it's about to be collected by calling the userdata's `__gc` ⤶ metamethod, passing the userdatum itself as an argument. ⤶ ⤶ This allows for any resources used by the userdata to be freed ⤶ on the C side, such as deleting an object or releasing a file handle.⤶ ⤶ ⤶ <br/>⤶ ⤶ ## Light Userdata⤶ ⤶ Light userdata represents a pointer as a value in Lua.⤶ ⤶ <br/>⤶ ⤶ ### Details⤶ ⤶ Unlike full userdata, light userdata is not garbage collected, ⤶ has no individual metatable, and is only equal to other light ⤶ userdata when the pointers they hold are equal.⤶ ⤶ This is not inherently used in Garry's Mod.⤶ ⤶ See the [Programming in Lua documentation](https://www.lua.org/pil/28.5.html) for more information.

Account Management

Special Pages

Wiki List