sUNC Standard

Executor Functions

Complete reference of 79executor functions tested under the sUNC (senS' Unified Naming Convention) standard. Organized by library with signatures and descriptions.

12 Libraries79 Functionsdocs.sunc.su ↗

Closures

11 functions

Inspection, modification, and creation of Luau closures — one of the most powerful tools for hooking functions and modifying game logic.

Docs ↗

Function	Signature	Description
`hookfunction`	`hookfunction(func, hook) → original`	Hook a function with another function, returning the original unhooked function.
`hookmetamethod`	`hookmetamethod(object, name, hook) → original`	Hook a specific metamethod on any Luau object with a metatable.
`restorefunction`	`restorefunction(func)`	Restore a hooked function back to the very first original, even after multiple hooks.
`clonefunction`	`clonefunction(func) → clone`	Create a new function with the exact same behaviour as the passed function.
`newcclosure`	`newcclosure(func) → cfunc`	Wrap any Luau function into a C closure.
`checkcaller`	`checkcaller() → boolean`	Check if the current function was invoked from the executor's own thread.
`iscclosure`	`iscclosure(func) → boolean`	Check whether a given function is a C closure.
`islclosure`	`islclosure(func) → boolean`	Check whether a given function is a Luau closure.
`isexecutorclosure`	`isexecutorclosure(func) → boolean`	Check whether a function is a closure of the executor (includes loadstring and getscriptclosure).
`getfunctionhash`	`getfunctionhash(func) → string`	Get the SHA384 hash of a function's instructions and constants.
`loadstring`	`loadstring(source, chunkname?) → func\|nil, err?`	Compile a string of Luau code and return it as a runnable function.

Debug

10 functions

Powerful tools for inspecting and modifying Luau functions at a bytecode level — constants, upvalues, stack frames, and protos.

Docs ↗

Function	Signature	Description
`debug.getconstant`	`debug.getconstant(func, index) → value`	Get the constant at a specific index from a Luau function's bytecode.
`debug.getconstants`	`debug.getconstants(func) → {constants}`	Get all constants used within a Luau function's bytecode.
`debug.setconstant`	`debug.setconstant(func, index, value)`	Modify a constant at a specific index in a Luau function's bytecode.
`debug.getupvalue`	`debug.getupvalue(func, index) → value`	Get the upvalue at a specific index from a Luau function's closure.
`debug.getupvalues`	`debug.getupvalues(func) → {upvalues}`	Get all upvalues captured by a Luau function (external variables from surrounding scope).
`debug.setupvalue`	`debug.setupvalue(func, index, value)`	Replace an upvalue at a specific index in a Luau function with a new value.
`debug.getproto`	`debug.getproto(func, index, activated?) → func`	Get a specific function prototype from a Luau function by index.
`debug.getprotos`	`debug.getprotos(func) → {funcs}`	Get all function prototypes defined within a Luau function.
`debug.getstack`	`debug.getstack(level, index?) → value`	Retrieve values from the stack at a specific call level.
`debug.setstack`	`debug.setstack(level, index, value)`	Replace a value in a specified stack frame.

Filesystem

11 functions

Access to the executor's virtual file system — reading, writing, creating, and deleting files and folders.

Docs ↗

Function	Signature	Description
`readfile`	`readfile(path) → string`	Retrieve the contents of a file at the specified path as a string.
`writefile`	`writefile(path, data)`	Write data to a file. Overwrites if it already exists.
`appendfile`	`appendfile(path, contents)`	Append string content to the end of a file. Creates the file if it doesn't exist.
`delfile`	`delfile(path)`	Delete the file at the specified path if it exists.
`loadfile`	`loadfile(path) → func\|nil, err?`	Compile Luau source code from a file and return the resulting function.
`listfiles`	`listfiles(path) → {strings}`	Return all files and folders within the specified directory.
`makefolder`	`makefolder(path)`	Create a folder at the specified path if one doesn't already exist.
`delfolder`	`delfolder(path)`	Delete the folder at the specified path if it exists.
`isfile`	`isfile(path) → boolean`	Check whether a given path exists and refers to a file.
`isfolder`	`isfolder(path) → boolean`	Check whether a given path exists and refers to a folder.
`getcustomasset`	`getcustomasset(path) → string`	Return a content ID (e.g. rbxasset://) for loading audio, meshes, UI images, and other asset types.

Instances

9 functions

Direct access to and manipulation of Instance objects — listing, referencing, and firing Roblox-native interactions.

Docs ↗

Function	Signature	Description
`getinstances`	`getinstances() → {Instance}`	Retrieve every Instance from the registry, including those parented to nil.
`getnilinstances`	`getnilinstances() → {Instance}`	Return unparented Instance objects that exist in memory but are no longer in the DataModel hierarchy.
`gethui`	`gethui() → BasePlayerGui\|Folder`	Return a hidden Instance container for safely storing UI elements (designed to avoid detection).
`cloneref`	`cloneref(object) → clone`	Return a reference clone of an Instance that behaves identically but is not strictly equal (==) to it.
`compareinstances`	`compareinstances(a, b) → boolean`	Check if two Instances are equal.
`getcallbackvalue`	`getcallbackvalue(object, property) → any?`	Retrieve the assigned callback property on an Instance, such as OnInvoke.
`fireclickdetector`	`fireclickdetector(detector, distance?, event?)`	Trigger a ClickDetector event (defaults to MouseClick).
`fireproximityprompt`	`fireproximityprompt(prompt)`	Instantly trigger a ProximityPrompt, bypassing HoldDuration and activation distance.
`firetouchinterest`	`firetouchinterest(part1, part2, toggle)`	Simulate a physical touch event between two BasePart objects.

Signals

3 functions

Inspecting and manipulating RBXScriptSignal and RBXScriptConnection objects.

Docs ↗

Function	Signature	Description
`getconnections`	`getconnections(signal) → {Connection}`	Retrieve all Connection objects currently attached to an RBXScriptSignal.
`firesignal`	`firesignal(signal, ...)`	Invoke all Luau connections connected to a given RBXScriptSignal.
`replicatesignal`	`replicatesignal(signal, ...)`	Replicate a signal to the server with the provided arguments.

Scripts

9 functions

Inspect and interact with script objects — bytecode analysis, closure retrieval, environment access, and script simulation.

Docs ↗

Function	Signature	Description
`getscripts`	`getscripts() → {Script}`	Return all Script, LocalScript, and ModuleScript instances present.
`getrunningscripts`	`getrunningscripts() → {Script}`	Return all running scripts in the caller's global state (excluding CoreScripts by default).
`getloadedmodules`	`getloadedmodules() → {ModuleScript}`	Return all ModuleScript instances that have been loaded (require'd).
`getcallingscript`	`getcallingscript() → Script?`	Return the Script/LocalScript/ModuleScript that triggered the current code execution.
`getscriptfromthread`	`getscriptfromthread(thread) → Script?`	Return the script associated with a given Luau thread.
`getscriptclosure`	`getscriptclosure(script) → func`	Create and return a Luau function closure from a script's compiled bytecode.
`getscriptbytecode`	`getscriptbytecode(script) → string?`	Retrieve the bytecode of a Script, LocalScript, or ModuleScript.
`getscripthash`	`getscripthash(script) → string?`	Return a SHA-384 hash of the raw bytecode for a given script.
`getsenv`	`getsenv(script) → env?`	Return the global environment table of a given Script, LocalScript, or ModuleScript.

Metatable

5 functions

Advanced interaction with metatables — direct access to core metamethods and internal table behaviours.

Docs ↗

Function	Signature	Description
`getrawmetatable`	`getrawmetatable(object) → table?`	Return the raw metatable of an object, even if a __metatable field is set.
`setrawmetatable`	`setrawmetatable(object, metatable) → object`	Forcibly set the metatable of a value, bypassing __metatable protection.
`getnamecallmethod`	`getnamecallmethod() → string?`	Return the name of the method that invoked the __namecall metamethod.
`isreadonly`	`isreadonly(table) → boolean`	Check whether a table is currently set as readonly.
`setreadonly`	`setreadonly(table, state)`	Set whether a table is readonly (true) or writable (false).

Reflection

6 functions

Access hidden or non-scriptable properties of Instances and internal execution context.

Docs ↗

Function	Signature	Description
`gethiddenproperty`	`gethiddenproperty(instance, name) → value, bool`	Retrieve a hidden or non-scriptable property from an Instance.
`sethiddenproperty`	`sethiddenproperty(instance, name, value) → bool`	Assign a value to a hidden or non-scriptable property of an Instance.
`isscriptable`	`isscriptable(instance, property) → boolean?`	Check whether a property of an Instance is scriptable.
`setscriptable`	`setscriptable(instance, name, state) → boolean?`	Toggle the scriptability of a hidden or non-scriptable property on an Instance.
`getthreadidentity`	`getthreadidentity() → number`	Retrieve the thread's identity of the running Luau thread.
`setthreadidentity`	`setthreadidentity(id)`	Set the current Luau thread identity and capabilities.

Encoding

4 functions

Binary transformation operations — Base64 and LZ4 encoding, decoding, compression, and decompression.

Docs ↗

Function	Signature	Description
`base64encode`	`base64encode(data) → string`	Encode a string with Base64 encoding.
`base64decode`	`base64decode(data) → string`	Decode a Base64-encoded string back into its original form.
`lz4compress`	`lz4compress(data) → string`	Compress a string with the LZ4 compression algorithm.
`lz4decompress`	`lz4decompress(data) → string`	Decompress a string that was encoded using LZ4 back to regular data.

Environment

5 functions

Access and inspection of the executor and Roblox environments — global tables, registry, and garbage collector.

Docs ↗

Function	Signature	Description
`getgenv`	`getgenv() → table`	Return the executor's global environment table, shared across all executor-made threads.
`getrenv`	`getrenv() → table`	Return the Roblox global environment used by the entire game.
`getreg`	`getreg() → table`	Return the Luau registry table used internally for threads, functions, and userdata.
`getgc`	`getgc(includeTables?) → {values}`	Return non-dead garbage-collectable values — functions, userdatas, and optionally tables.
`filtergc`	`filtergc(type, options, returnOne?) → value\|{values}`	Retrieve specific garbage-collected values using fine-tuned filters.

Drawing

4 functions

Client-only 2D rendering primitives — creating and manipulating graphical objects on the screen.

Docs ↗

Function	Signature	Description
`isrenderobj`	`isrenderobj(object) → boolean`	Check whether a given value is a valid Drawing object.
`getrenderproperty`	`getrenderproperty(drawing, property) → value`	Retrieve the value of a property from a Drawing object.
`setrenderproperty`	`setrenderproperty(drawing, property, value)`	Assign a value to a property of a Drawing object.
`cleardrawcache`	`cleardrawcache()`	Remove all active drawing objects created with Drawing.new.

Miscellaneous

2 functions

Utility functions that don't belong to a specific category — executor identification and HTTP requests.

Docs ↗

Function	Signature	Description
`identifyexecutor`	`identifyexecutor() → name, version`	Return the name and version of the currently running executor.
`request`	`request(options) → response`	Send an HTTP request with a configuration table. Yields until complete and returns a structured response.

Function data sourced from the sUNC Documentation Metadata API. sUNC evolves over time — some functions may be deprecated or added. Always refer to the official docs for the latest information.