checkcaller

checkcaller() -> boolean

Returns true when the thread currently executing is one Athena owns, and false when the call originated from the game’s own code.

Returns

boolean

true if the running thread belongs to Athena.

Behavior

Where isexecutorclosure asks about a function, checkcaller asks about the thread that is running right now. This is the standard way to tell, from inside a hook, whether the call came from your own code or from the game. Threads Athena creates, and threads you spawn from them with task.spawn, coroutine.create, or similar, are recognized as yours. Threads the engine created are not. This is what lets a hook handle only your own calls and pass the game’s straight through, which is the usual reason you reach for it.

Example

Inside a __namecall hook, act on the game’s remote calls while letting your own through untouched:

local oldNamecall
oldNamecall = hookmetamethod(game, "__namecall", function(self, ...)
    if not checkcaller() and getnamecallmethod() == "FireServer" then
        -- inspect or block the game's remote call
    end
    return oldNamecall(self, ...)
end)

isexecutorclosure: classify a function instead of a thread.

Getting Started

Environment

Closures

Scripts

Reflection

Metatable

Instances

Cache

Signals

Signal

Actors

LuaStateProxy

Console

Input

Drawing

Filesystem

Encoding

Crypt

HTTP

WebSocket

RakNet

Miscellaneous

oth

Returns

Behavior

Example

​Returns

​Behavior

​Example

​Related

Returns

Behavior

Example

Related