hookmetamethod - Real Function Reference

hookmetamethod(object: any, metamethod: string, replacement: function): function

Arguments

any

required

Value whose methods is inspected with raw metafield lookup.

string

required

Metafield name passed to raw metafield lookup.

function

required

Function passed to hookfunction as the replacement for the found metamethod function.

Returns

function

Cloned original metamethod closure returned by hookfunction.

Example

Hook an existing metamethod function.

local object = setmetatable({}, {
    __index = function(_, key)
        return key
    end,
})

local original
original = hookmetamethod(object, "__index", function(self, key)
    if key == "Name" then
        return "Real"
    end

    return original(self, key)
end)

​Arguments

​Returns

​Example

Arguments

Returns

Example