hookmetamethod

hookmetamethod(object: any, metamethod: string, hook: function) -> function

​

Parameters

​

Returns

​

Behavior

• Readonly metatables are handled. Game metatables are typically readonly; hookmetamethod records what it changed so restoremetamethod and restorefunction can both undo it, without leaving the metatable writable.
• The metamethod must already be a function. Hooking a metamethod that is not a function (or absent) is rejected.
• Pair with checkcaller. Inside the hook, use checkcaller to separate the game’s calls from your own and forward the rest unchanged.

​

Example

local oldNamecall
oldNamecall = hookmetamethod(game, "__namecall", function(self, ...)
    local method = getnamecallmethod()
    if not checkcaller() and method == "FireServer" then
        print("FireServer on", self:GetFullName())
    end
    return oldNamecall(self, ...)
end)

​

Errors

​

Related

• restoremetamethod: undo the hook.
• getnamecallmethod: read the method name inside a __namecall hook.
• checkcaller: tell your calls from the game’s.