Saiko documentation
What the Saiko module adds to Luau, and how to drive Saiko from a program of your own.
- Function reference145 functions in 19 groups, each with its signature, parameters and an example you can paste in.
- Custom UIStart Saiko with no window, then inject and run scripts from your own program over the command line or a local WebSocket.
Function reference
Actors
Run code inside actors, talk to them, and tell serial threads from parallel ones.
Cache
The engine's instance cache: drop or swap the reference an instance has.
Closures
Inspect, copy, wrap and hook functions.
Crypt
Encryption, hashing, HMAC and random data.
Debug
Read and rewrite the constants, upvalues and stack of live code.
Drawing
Shapes and text drawn over the game window.
Encoding
Base64 and LZ4 for strings.
Environment
The global tables the game and the executor run in, and the objects the VM keeps alive.
External
The console window and Windows message boxes.
FileDialog
Let the user pick files and folders anywhere on their computer.
Filesystem
Read and write files in the executor workspace.
Input
Press keys, click and move the mouse, and use the clipboard.
Instances
Find, clone and trigger instances the game does not expose.
Metatable
Raw metatables and the read-only flag.
Miscellaneous
HTTP requests and the executor name.
Reflection
Hidden properties and thread identity.
Scripts
Enumerate scripts and read their bytecode and environments.
Signals
Connections and firing events.
WebSocket
Raw WebSocket connections.
Reading a signature
Signatures are written in Luau type syntax, the same text the editor shows while you type.
name: string?- A trailing question mark means the argument can be left out.
...any- Any number of further values of that type.
{ Instance }- An array of that type.
{ [any]: any }- A table with keys and values of any type.
()- No return value.
A | B- Either type is accepted.