The __tostring Metamethod

When you print a table in Lua, you typically see something unhelpful like table: 0x5f8a20—just a memory address. The __tostring metamethod lets you change this behavior by defining exactly what should be displayed when your table is converted to a string.

This metamethod is particularly useful for debugging and creating cleaner output. When Lua needs to convert your table to a string (like when using print()), it checks if the table has a metatable with a __tostring field. If it does, Lua calls that function and uses its return value instead of the default representation.

Here's how to implement it:

local vector = {x = 3, y = 4}
local meta = {
    __tostring = function(t)
        return "Vector(" .. t.x .. ", " .. t.y .. ")"
    end
}

setmetatable(vector, meta)

print(vector)  -- Output: Vector(3, 4)

The __tostring function receives the table as its argument and must return a string. In this example, it constructs a formatted string showing the vector's x and y values in a readable format.

This makes your code much easier to work with. Instead of seeing cryptic memory addresses during debugging, you get meaningful information about what your table contains.