Skip to content

checkcaller

checkcaller returns a boolean indicating whether the current function was invoked from the executor's own thread. This is useful for differentiating between your own calls and those made by the game.

It is often used in hookfunction and/or hookmetamethod.

function checkcaller(): boolean

Parameters

Parameter Description
(none) This function takes no parameters.

Example

Identifying the source of a __namecall
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
local from_caller

local original; original = hookmetamethod(game, "__namecall", function(...)
    if not from_caller then
        from_caller = checkcaller()
    end

    return original(...)
end)

task.wait(0.1) -- Step a bit
hookmetamethod(game, "__namecall", original)

print(from_caller)       -- Output: false
print(checkcaller())    -- Output: true (current thread)