setrawmetatable Synchronous

Replace or clear a table, userdata, or string metatable directly. It is useful for a local object whose metamethod behavior you control.

Syntax

Luau

setrawmetatable(
    value: Table | userdata | string,
    metatable: Table?
) -> Table | userdata | string

Parameters

Function parameters
Parameter	Type	Description
`value`	`Table \| userdata \| string`	Table, userdata, or string to update.
`metatable`	`Table?`	Replacement table, or nil to clear the metatable.

Table | userdata | string

The original value.

Passing a Roblox Instance returns that Instance without changing its metatable.

Luau

local object = {}
setrawmetatable(object, { __tostring = function() return "ready" end })
print(tostring(object)) -- ready