Lua Quick Start Guide

User data

Lua has a special data type called userdata. Userdata can store arbitrary C data structures as Lua data—it's just some arbitrary amount of memory. Userdata can have meta tables, which enables us to extend the type using the same mechanism we would use to extend tables. Like tables, userdata is compared by reference, not by value.

To create a new block of userdata memory, use the void* lua_newuserdata (lua_State*, size_t) function. The first argument of this function is the Lua state to work on, and the second argument is the number of bytes to reserve for user data. The function returns a pointer to the block of memory that Lua has reserved for this user data.

A three-dimensional vector might be stored in userdata like as follows: ...