### Getting ReplicatedStorage Service in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Obtains a reference to the `ReplicatedStorage` service. This service is often used for storing assets accessible by both client and server.

```Lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
```

--------------------------------

### Getting LocalPlayer Service in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Obtains a reference to the `LocalPlayer` object from the `Players` service. This is a common prerequisite for operations involving the client's player.

```Lua
local LocalPlayer = game:GetService("Players").LocalPlayer
```

--------------------------------

### Example Decompiled Roblox UI Creation (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/decompiler.md

This code snippet shows an example of Lua code decompiled by Synapse X. It demonstrates the creation of various Roblox UI instances like ScreenGui, Frame, TextLabel, TextBox, TextButton, and ImageLabel using `Instance.new()`. This illustrates the typical structure and variable naming found in decompiled scripts.

```Lua
-- Decompiled with the Synapse X Luau decompiler.

function CreateGui()
    local v1 = Instance.new("ScreenGui");
    local v2 = Instance.new("Frame");
    local v3 = Instance.new("Frame");
    local v4 = Instance.new("TextLabel");
    local v5 = Instance.new("TextBox");
    local v6 = Instance.new("Frame");
    local v7 = Instance.new("Frame");
    local v8 = Instance.new("TextButton");
    local v9 = Instance.new("TextLabel");
    local v10 = Instance.new("TextLabel");
    local v11 = Instance.new("ImageLabel");
    local v12 = Instance.new("Frame");
    local v13 = Instance.new("Frame");
end
```

--------------------------------

### Example Custom Encrypt/Decrypt - Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/crypt_lib.md

This Lua example demonstrates how to use the custom encryption and decryption functions with the 'aes-gcm' cipher. It shows the process of encrypting a string, printing the result, and then decrypting it back to the original string.

```lua
local enc = syn.crypt.custom.encrypt(
    "aes-gcm",
    "hi gamers!", 
    "$nLliCMdi7gcynsFCK9u0aVNdtkNIiZG",
    "Agd13KuKIL2$") -- in production, generate a nonce via syn.crypt.random

print(enc)

print(syn.crypt.custom.decrypt(
    "aes-gcm",
    enc,
    "$nLliCMdi7gcynsFCK9u0aVNdtkNIiZG",
    "Agd13KuKIL2$")) --"hi gamers"
```

--------------------------------

### Making a GET Request with syn.request in Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/web_api.md

This snippet demonstrates how to use the `syn.request` function in Synapse X to perform a basic GET request to a specified URL. It shows how to pass a configuration table with the `Url` and `Method` properties and then access the `Body` property of the returned response table to print the content.

```lua
local Response = syn.request({
    Url = "https://example.com",
    Method = "GET"
})

print(Response.Body)
```

--------------------------------

### Example Usage: rconsoleprint with Color (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Demonstrates how to use the `rconsoleprint` function, including how to apply colors using special color codes like `@@RED@@` before the text you want colored.

```syn
rconsoleprint('@@RED@@')
rconsoleprint('this is red')
```

--------------------------------

### Getting Synapse Asset (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Returns a string formatted as a fake Asset ID (`Content`) for a given `path` to a local file. This allows GUI elements to load local files as if they were Roblox assets, but the effect is client-side only.
Note: Certain instances only work with specific file types. For example, `VideoFrame`'s only work with `.webm` encoded videos.

```syn
<Content> getsynasset(<string> path)
```

--------------------------------

### Example Usage - Creating and Removing Line - Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Demonstrates creating a 'Line' drawing object, setting its properties like visibility, points, color, thickness, transparency, and ZIndex, waiting for 5 seconds, and then manually removing the object.

```lua
local Line = Drawing.new("Line")
Line.Visible = true
Line.From = Vector2.new(0, 0)
Line.To = Vector2.new(200, 200)
Line.Color = Color3.fromRGB(255, 255, 255)
Line.Thickness = 2
Line.Transparency = 1
LIne.ZIndex = 1

wait(5)

Line:Remove() --Drawing objects are manually managed.
```

--------------------------------

### Example Usage of Synapse X WebSocket Library (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/websocket_lib.md

Demonstrates connecting to a WebSocket server, handling incoming messages using the OnMessage event, sending periodic messages using the Send method, and closing the connection using the Close method.

```lua
local WebSocket = syn.websocket.connect("ws://localhost:123/test") -- Specify your WebSocket URL here.

WebSocket.OnMessage:Connect(function(Msg)
    print(Msg) -- Print messages sent to SX.
end)

local Ctr = 1
while wait(1) do 
    WebSocket:Send("gamer vision " .. tostring(Ctr)) -- Send messages to the WebSocket server.
    WebSocket:Send("epic gamer vision " .. tostring(Ctr))
    WebSocket:Send("epicer gamer vision " .. tostring(Ctr))
    Ctr = Ctr + 1

    if Ctr == 150 then 
        WebSocket:Close() -- Close the websocket when you are done! (this is done implicitly on teleports aswell)
        do return end
    end
end
```

--------------------------------

### Get Info (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Returns a table of info pertaining to the lua function `fi`.

```Synapse X Lua
<table> debug.getinfo(union<function, number> fi, <string> w = "flnSu")
```

--------------------------------

### Getting All Instances (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a table containing all instances currently present within the game's data model. This provides a comprehensive list of all objects in the game hierarchy.

```Synapse
<table<Instance>> getinstances(<void>)
```

--------------------------------

### Get Registry (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Returns the Lua registry.

```Synapse X Lua
<table> debug.getregistry(<void>)
```

--------------------------------

### Get Protos (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Returns a table containing the inner functions of function `f`. Note these functions will not have upvalues, use `debug.getproto` with activated `true` to get a list of instances.

```Synapse X Lua
<table> debug.getprotos(<function> f)
```

--------------------------------

### Get Proto (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Gets the inner function of `f` at `index`.

Note if `activated` is true, instead it will return a table of functions. These are the instances of that function that exist within the GC.

```Synapse X Lua
union<function, table<function>> debug.getproto(<function, number> f, <int> index, <bool?> activated)
```

--------------------------------

### Capturing Variable Arguments in Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Demonstrates how to collect all variable arguments passed to a function (`...`) into a table named `Args`. This is useful when dealing with functions that accept a variable number of parameters.

```Lua
local Args = {...}
```

--------------------------------

### Get Stack (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Gets the method stack at level `indice`.

```Synapse X Lua
<table> debug.getstack(<number> indice)
```

--------------------------------

### Getting Loaded ModuleScripts (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a table containing all ModuleScript instances that have been loaded (required) by scripts in the game. This provides access to the instances of required modules.

```Synapse
<table<ModuleScript>> getloadedmodules(<void>)
```

--------------------------------

### Using syn.secure_call with Custom Environment (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

An example demonstrating the use of `syn.secure_call` to call a function (`KeyHandler`) and a method (`Result.getKey`) while spoofing the environment using a custom table (`FakeEnv`). Note that this function is deprecated.

```lua
local KeyHandler = require(game:GetService("ReplicatedStorage").Assets.Modules.KeyHandler)
local PlayerName = game:GetService("Players").LocalPlayer.Name
local FakeEnv = game:GetService("Workspace").Live[PlayerName].CharacterHandler.Input

local Result = syn.secure_call(KeyHandler, FakeEnv)
local Event = syn.secure_call(Result.getKey, FakeEnv, "ApplyFallDamage", "plum")

--Do whatever
```

--------------------------------

### Getting All Scripts (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a table containing all LocalScript and ModuleScript instances currently present in the game. This allows inspection or manipulation of existing scripts.

```Synapse
<table<union<LocalScript, ModuleScript>>> getscripts(<void>)
```

--------------------------------

### Testing __index Hook on LocalPlayer.Character in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Demonstrates the effect of the `__index` hook by attempting to print the `Character` property of the `LocalPlayer`. If the hook is active and the call is from a game thread, it should print `nil`.

```Lua
print(game:GetService("Players").LocalPlayer.Character)
```

--------------------------------

### Testing __namecall Hook on GetService("Workspace") in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Demonstrates the effect of the `__namecall` hook by attempting to print the result of `game:GetService("Workspace")`. If the hook is active and the call is from a game thread, it should print the `ReplicatedStorage` service instead of `Workspace`.

```Lua
print(game:GetService("Workspace"))
```

--------------------------------

### Getting Connections to a Signal (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a list of Connection objects currently connected to the specified ScriptSignal object. Each Connection object provides properties and methods to interact with the connection.

```Synapse
<table<Connection>> getconnections(<ScriptSignal> obj)
```

--------------------------------

### Modifying an Upvalue using debug.setupvalue in Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/debug_api.md

This example shows how to use the `debug.setupvalue` function to change the value of an upvalue (`TestVariable`) associated with a function (`Test`) before it is executed.

```Lua
local TestVariable = "Hello, world!"

local function Test()
    print(TestVariable)
    TestVariable = "Still - Hello, world!"
    print(TestVariable)
end

debug.setupvalue(Test, 1, "Hello, modified world!")
Test()
```

--------------------------------

### Get Upvalues (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Retrieve the upvalues in function `fi` or at level `fi`.

```Synapse X Lua
<table> debug.getupvalues(union<function, number> fi)
```

--------------------------------

### Get Constants (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Retrieve the constants in function `fi` or at level `fi`.

```Synapse X Lua
<table> debug.getconstants(union<function, number> fi)
```

--------------------------------

### Line Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties specific to the Line drawing object type. Defines the thickness of the line and its start and end points using Vector2.

```syn
number Thickness;
Vector2 From;
Vector2 To;
```

--------------------------------

### Getting Special Instance Info (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Retrieves a table containing special, often internal, properties for specific instance types like `MeshParts`, `UnionOperations`, and `Terrain`. The returned table structure varies depending on the type of the input `obj`.

```syn
<table> getspecialinfo(<Instance> obj)
```

--------------------------------

### Getting Nil-Parented Instances (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a table containing all instances whose parent property is currently set to `nil`. These instances are not part of the main game hierarchy but may still exist in memory.

```Synapse
<table<Instance>> getnilinstances(<void>)
```

--------------------------------

### Hooking __index Metamethod in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Hooks the `__index` metamethod on the `game` object. It intercepts attempts to access `LocalPlayer.Character` from non-Synapse X threads (`checkcaller()`) and returns `nil` instead of the actual character. Requires a reference to the `LocalPlayer` and the original `__index` function.

```Lua
local LocalPlayer = game:GetService("Players").LocalPlayer
local OldIndex = nil

OldIndex = hookmetamethod(game, "__index", function(Self, Key)
    if not checkcaller() and Self == LocalPlayer and Key == "Character" then
        return nil
    end

    return OldIndex(Self, Key)
end)
```

--------------------------------

### Get Upvalue (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Returns the upvalue with name `idx` in function or level `fi`.

```Synapse X Lua
<variant> debug.getupvalue(union<function, number> fi, <number> idx)
```

--------------------------------

### Get Constant (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Returns the constant at index `idx` in function `fi` or level `fi`.

```Synapse X Lua
<variant> debug.getconstant(union<function, number> fi, <number> idx)
```

--------------------------------

### Hooking __namecall Metamethod in Roblox Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/metamethod_hook_examples.md

Hooks the `__namecall` metamethod on the `game` object. It intercepts calls to `game:GetService("Workspace")` from non-Synapse X threads (`checkcaller()`) and returns the `ReplicatedStorage` service instead of `Workspace`. Requires references to `ReplicatedStorage` and the original `__namecall` function.

```Lua
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local OldNameCall = nil

OldNameCall = hookmetamethod(game, "__namecall", function(Self, ...)
    local Args = {...}
    local NamecallMethod = getnamecallmethod()

    if not checkcaller() and Self == game and NamecallMethod == "GetService" and Args[1] == "Workspace" then
        return ReplicatedStorage
    end

    return OldNameCall(Self, ...)
end)
```

--------------------------------

### Get Raw Metatable (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/table.md

Retrieves the metatable of a given value, ignoring the `__metatable` field if it exists. Returns `nil` if the metatable does not exist.

```syn
<table> getrawmetatable(<table> value)
```

--------------------------------

### Disabling Signal Connections (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

This Lua example demonstrates how to use `getconnections` to retrieve all connections attached to a specific signal (in this case, `workspace.ChildAdded`) and then iterate through them to disable each connection.

```Lua
for i, connection in pairs(getconnections(workspace.ChildAdded)) do
    connection:Disable()
end
```

--------------------------------

### Getting a Hidden Property (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Retrieves the value of a property on an Instance that is not normally accessible or visible. Errors if the specified property does not exist on the object.

```Synapse
<variant> gethiddenproperty(<Instance> Object, <string> Property)
```

--------------------------------

### Get Current Thread Identity (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Returns the current identity level of the thread as an unsigned integer. This value indicates the permission level under which the current code is executing.

```syn
<uint> syn.get_thread_identity(<void>)
```

--------------------------------

### Getting Local Environment (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns the global environment table specific to the LocalScript state. This is useful for interacting with variables and functions accessible within the context of a client-side script.

```Synapse
<table> getrenv(<void>)
```

--------------------------------

### Getting Garbage Collection Data (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a list of values currently tracked by the Lua garbage collector. By default, it includes functions and userdata. Passing `true` as an argument will also include tables in the returned list.

```Synapse
<table> getgc(<bool?> include_tables)
```

--------------------------------

### Getting Global Environment (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns the environment table that is applied to every script executed by Synapse X. This environment typically contains custom functions and variables provided by the exploit.

```Synapse
<table> getgenv(<void>)
```

--------------------------------

### Getting Script Environment in Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/script.md

Retrieves the environment table associated with a given LocalScript or ModuleScript. This function will produce an error if the specified script is not currently loaded into memory.

```syn
<table> getsenv(union<LocalScript, ModuleScript> Script)
```

--------------------------------

### Getting Calling Script in Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/script.md

Returns the script (LocalScript or ModuleScript) that is currently executing and calling this function. Returns nil if called from a context not associated with a specific script.

```syn
<union<LocalScript, ModuleScript, nil>> getcallingscript(<void>)
```

--------------------------------

### Logging FireServer Function Hook - Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/function_hooks.md

An expanded example of hooking 'FireServer' that adds logging functionality. It checks if the caller is not the script itself using 'checkcaller()' and, if not, prints the RemoteEvent instance and all arguments passed to 'FireServer' before calling the original function.

```Lua
local OldFireServer
OldFireServer = hookfunction(Instance.new'RemoteEvent'.FireServer, newcclosure(function(Event, ...)
    if not checkcaller() then
        local Args = {...}

        print(Event)
        for I, V in pairs(Args) do
            print(V)
        end
    end

    return OldFireServer(Event, ...)
end))
```

--------------------------------

### Accessing Original Globals via getrenv (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/script_env.md

Shows how to retrieve the original `shared` or `_G` table that existed before Synapse X attached and created its own versions, using the `getrenv` function.

```Lua
getrenv().shared
```

--------------------------------

### Getting Namecall Method (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Retrieves the string name of the method currently being called if the function is invoked within a `__namecall` metatable hook. This is useful for inspecting or modifying the behavior of method calls.

```syn
<string> getnamecallmethod(<void>)
```

--------------------------------

### Getting Lua Registry (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns the Lua registry table. The registry is a special table accessible from C code, often used to store references to Lua values that need to persist across C function calls or garbage collection cycles.

```Synapse
<table> getreg(<void>)
```

--------------------------------

### Getting Script Hash in Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/script.md

Calculates and returns a SHA384 hash of the bytecode for the provided script. This hash can be utilized to detect if the script's content has been modified since it was last checked.

```syn
<string> getscripthash(union<LocalScript, ModuleScript> Script)
```

--------------------------------

### Modifying Function Constant using debug.setconstant in Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/debug_api.md

This example shows how to use `debug.setconstant` to change a constant value within a function's bytecode. In this case, it modifies the string literal 'Still - Hello, world!'.

```Lua
local TestVariable = "Hello, world!"

local function Test()
    print(TestVariable)
    TestVariable = "Still - Hello, world!"
    print(TestVariable)
end

debug.setconstant(Test, 2, "Modified - Hello, world!")
Test()
```

--------------------------------

### Creating New Folder (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Creates a new folder (directory) at the specified path. If the folder already exists, this function typically does nothing or succeeds without error.

```syn
<void> makefolder(<string> path)
```

--------------------------------

### Getting Script Closure in Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/script.md

Obtains a basic function object derived from the specified script. It's important to note that this function is a 'bare' version and will not retain the original script's upvalues or environment context correctly.

```syn
<function> getscriptclosure(union<LocalScript, ModuleScript> Script)
```

--------------------------------

### Making HTTP Requests with syn.request (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Demonstrates how to use `syn.request` to send an HTTP POST request with a JSON body. It includes setting the URL, method, headers, and body. The response is then iterated and printed.

```lua
local response = syn.request(
    {
        Url = "http://httpbin.org/post",  -- This website helps debug HTTP requests
        Method = "POST",
        Headers = {
            ["Content-Type"] = "application/json"  -- When sending JSON, set this!
        },
        Body = game:GetService("HttpService"):JSONEncode({hello = "world"})
    }
)
    
for i,v in pairs(response) do
    print(i,v)
    
    if type(v) == "table" then
        for i2,v2 in pairs(v) do
            warn(i2,v2)
        end
    end
end
```

--------------------------------

### Creating Files with writefile - Synapse X Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/filesystem_api.md

Creates a new file or overwrites an existing one in the Synapse X workspace directory. It takes the filename and the content to write as arguments.

```lua
writefile("test.txt", "Testing!")
```

--------------------------------

### Printing Script Identity (Normal Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/script_env.md

Demonstrates how to check the execution identity of a standard Roblox LocalScript, which typically runs at identity 2.

```Lua
printidentity()
```

--------------------------------

### Attempting to Modify Script Global (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/script_env.md

Illustrates an attempt to modify a property of the `script` global in a Synapse X environment, highlighting that such operations are often ineffective or fake.

```Lua
script.Disabled = true
```

--------------------------------

### Queue Code Execution After Teleport (Syn/Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Queues a string of `code` to be executed by Synapse after the player successfully teleports to a new place. This is commonly used to run initialization code in the new game instance.

```syn
<void> syn.queue_on_teleport(<string> code)
```

```lua
game:GetService("Players").LocalPlayer.OnTeleport:Connect(function(State)
    if State == Enum.TeleportState.Started then
        syn.queue_on_teleport("<script to execute after TP>")
    end
end)
```

--------------------------------

### Creating Message Box (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Displays a native operating system message box window to the user. It takes `text` for the message body, `caption` for the window title, and `flags` (an unsigned integer) to determine the buttons and style of the box. The function returns an unsigned integer indicating which button the user clicked.

```syn
<uint> messagebox(<string> text, <string> caption, <uint> flags)
```

--------------------------------

### Set Upvalue (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Set upvalue `idx` to value value at `level` or function `fi`.

```Synapse X Lua
<void> debug.setupvalue(<function, number> fi, <number> idx, <table> value)
```

--------------------------------

### Image Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Image drawing object. The 'Data' property requires raw image data (e.g., from game:HttpGet), not a URL. Defines the size, position, and rounding for the image.

```syn
writeonly<string> Data;
Vector2 Size;
Vector2 Position;
number Rounding;
```

--------------------------------

### Connecting to WebSocket using syn.websocket.connect (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/websocket_lib.md

Connects to a WebSocket server at the specified URL. Returns a WebSocket object upon successful connection. This function will error if the connection attempt fails.

```syn
<object> syn.websocket.connect(<string> url)
```

--------------------------------

### syn.run_secure_function Function Signature (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Provides the signature for the `syn.run_secure_function`. It takes a string of code protected by `create_secure_function` and executes it. The function returns void.

```syn
<void> syn.run_secure_function(<string> code)
```

--------------------------------

### Simulate Key Release (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates a key release event for the specified virtual key code. Key code values can be found via the link mentioned in the documentation.

```syn
<void> keyrelease(<uint> key)
```

--------------------------------

### Check if Using Synapse Beta (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Returns a boolean value indicating whether the user is currently running the beta version of Synapse X (`true`) or the stable release version (`false`).

```syn
<bool> syn.is_beta(<void>)
```

--------------------------------

### Listing Files in Folder (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Returns a table containing the names of all files located within the specified folder path.

```syn
<table> listfiles(<string> folder)
```

--------------------------------

### Saving Game Instance (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Saves the current state of the game instance to a file within the Synapse X workspace folder. An optional table `t` can be provided to configure the save operation, controlling aspects like save mode (optimized, full, scripts), script inclusion, script caching, and timeout.

```syn
<void> saveinstance(<table> t)
```

--------------------------------

### Creating Drawing Object - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Creates a new drawing object of the specified type. This function returns the newly created drawing object instance.

```syn
<object> Drawing.new(<string> type)
```

--------------------------------

### Write Content to Clipboard (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Writes the provided string `content` to the Windows clipboard. This allows scripts to programmatically copy text that can then be pasted elsewhere.

```syn
<void> syn.write_clipboard(<string> content)
```

--------------------------------

### Send HTTP Request (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Sends an HTTP request using the parameters specified in the `options` table. The function returns a table containing the response details, including success status, status code, headers, cookies, and body, as described in the documentation tables.

```syn
<table> syn.request(<table> options)
```

--------------------------------

### Loading File as Chunk (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Loads the contents of a file and attempts to compile it as a code chunk. If compilation is successful, it returns the compiled function. If an error occurs during compilation, it returns `nil` followed by a string containing the error message.

```syn
<union<function, nil>, <string?>> loadfile(<string> path)
```

--------------------------------

### Set Proto (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Replaces `fi` at `index` with function `replacement` at level or function `fi`.

```Synapse X Lua
<void> debug.setproto(<function> fi, <number> index, <function> replacement)
```

--------------------------------

### Firing a ProximityPrompt (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Simulates the activation of the designated ProximityPrompt instance. This triggers the prompt's action as if a player had interacted with it.

```Synapse
<void> fireproximityprompt(<ProximityPrompt> Prompt, <number> Distance)
```

--------------------------------

### Appending to Files with appendfile - Synapse X Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/filesystem_api.md

Appends content to an existing file in the Synapse X workspace directory. If the file does not exist, it is created. It takes the filename and the content to append.

```lua
appendfile("test.txt", "Testing!")
```

--------------------------------

### Handling Incoming Messages with WebSocket.OnMessage (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/websocket_lib.md

An event that fires when a message is received from the WebSocket server. Connect a function to this event to process incoming messages.

```syn
WebSocket.OnMessage
```

--------------------------------

### Simulate Key Press (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates a key press event for the specified virtual key code. A link to a list of valid keycodes is provided in the documentation.

```syn
<void> keypress(<uint> keycode)
```

--------------------------------

### Basic Metamethod Hooking Script Synapse X Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/object_mts.md

This is the base script for hooking the `__index` and `__namecall` metamethods on Roblox instances using Synapse X. It saves the original methods and replaces them with custom functions wrapped in `newcclosure`.

```Lua
local OldIndex = nil
local OldNameCall = nil

OldIndex = hookmetamethod(game, "__index", newcclosure(function(...)
    local Self, Key = ...
    return OldIndex(...)
end))

OldNameCall = hookmetamethod(game, "__namecall", newcclosure(function(...)
    local Self = ...
    local NamecallMethod = getnamecallmethod()

    return OldNameCall(...)
end))
```

--------------------------------

### Circle Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Circle drawing object. Defines thickness, number of sides (for approximation), radius, fill status, and position.

```syn
number Thickness;
number NumSides;
number Radius;
bool Filled;
Vector2 Position;
```

--------------------------------

### Text Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Text drawing object. Includes the text content, size, positioning, outline options, font, and a read-only property for text bounds.

```syn
string Text;
number Size;
bool Center;
bool Outline;
Color3 OutlineColor;
Vector2 Position;
readonly<Vector2> TextBounds;
Drawing.Font Font;
```

--------------------------------

### Simulate Left Mouse Up (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates releasing the left mouse button.

```syn
<void> mouse1release(<void>)
```

--------------------------------

### Setting Clipboard Value (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Sets the system clipboard content to the provided string `value`. This function allows scripts to interact with the user's clipboard.

```syn
<void> setclipboard(<string> value)
```

--------------------------------

### Quad Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Quad drawing object. Defines thickness, the four corner points (in counter-clockwise order: top-right, top-left, bottom-left, bottom-right), and fill status.

```syn
number Thickness;
Vector2 PointA;
Vector2 PointB;
Vector2 PointC;
Vector2 PointD;
bool Filled;
```

--------------------------------

### Square Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Square drawing object. Defines thickness, size (as a Vector2), position, and fill status.

```syn
number Thickness;
Vector2 Size;
Vector2 Position;
bool Filled;
```

--------------------------------

### Protect GUI from Recursive FindFirstChild (Syn/Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Protects a specific `GUI` instance and its descendants from recursive `FindFirstChild` calls originating from non-Synapse contexts. This helps prevent certain types of exploits or attacks; it should ideally be called before the GUI is parented.

```syn
<void> syn.protect_gui(<obj> GUI)
```

```lua
local GUI = game:GetObjects("whatever")[1]
syn.protect_gui(GUI) -- You should call protect_gui before your GUI is parented.
GUI.Parent = game:GetService("CoreGui")
```

--------------------------------

### Creating New C Closure in Synapse X (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/hooking.md

Creates and pushes a new CClosure that executes function 'f' when called.

```syn
<function> newcclosure(<function> f)
```

--------------------------------

### Triangle Drawing Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

Properties for the Triangle drawing object. Defines thickness, the three corner points, and fill status.

```syn
number Thickness;
Vector2 PointA;
Vector2 PointB;
Vector2 PointC;
bool Filled;
```

--------------------------------

### Dumping Bytecode - Synapse Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/reflection.md

Returns the Synapse-formatted bytecode representation for the given source string `script`.

```Synapse Lua
<string> dumpstring(<string> Script)
```

--------------------------------

### Simulate Right Mouse Up (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates releasing the right mouse button.

```syn
<void> mouse2release(<void>)
```

--------------------------------

### Bitwise Swap (bswap) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a bitwise swap operation on the unsigned integer 'val' using the bit library.

```syn
<int> bit.bswap(<uint> val)
```

--------------------------------

### Simulate Right Click (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates a complete right mouse button click, encompassing both the press and release actions.

```syn
<void> mouse2click(<void>)
```

--------------------------------

### Firing a Script Signal (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Manually triggers all connections attached to the specified ScriptSignal object. Optional arguments can be passed to the connected functions.

```Synapse
<void> firesignal(<ScriptSignal> Signal, <variant> Args...)
```

--------------------------------

### Basic FireServer Function Hook - Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/function_hooks.md

Demonstrates the basic structure for hooking the 'FireServer' function of a RemoteEvent. It declares a local variable to store the original function and then uses 'hookfunction' with 'newcclosure' to replace the original function while retaining a reference to it.

```Lua
local OldFireServer
OldFireServer = hookfunction(Instance.new'RemoteEvent'.FireServer, newcclosure(function(Event, ...)
    return OldFireServer(Event, ...)
end))
```

--------------------------------

### Writing File Content (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Writes the provided contents to the file at the specified path. Note that this function has restrictions on certain file extensions (.exe, .scr, .bat, etc.) and will error if an attempt is made to write to a file with one of these disallowed extensions.

```syn
<void> writefile(<string> path, <string> contents)
```

--------------------------------

### Firing a ClickDetector (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Simulates a click event on the designated ClickDetector instance. An optional distance can be provided, defaulting to 0 if omitted.

```Synapse
<void> fireclickdetector(<ClickDetector> Detector, <number> Distance)
```

--------------------------------

### Accessing Instance Properties/Methods Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/object_mts.md

This snippet demonstrates a typical operation on a Roblox instance, accessing properties and calling methods, which can trigger metamethods like `__index` and `__namecall`.

```Lua
print(game:GetService("Players").LocalPlayer.Character)
```

--------------------------------

### Bitwise AND (band) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a bitwise AND operation between unsigned integers 'val' and 'by' using the bit library.

```syn
<int> bit.band(<uint> val, <uint> by)
```

--------------------------------

### Base Drawing Object Properties - Synapse X

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/drawing_lib.md

These properties and the Remove method are common to all drawing objects. Transparency is inverse (1 is opaque, 0 is transparent). ZIndex controls rendering order (higher ZIndex renders on top), using 32-bit integers.

```syn
bool Visible;
int ZIndex;
number Transparency;
Color3 Color;
void Remove();
```

--------------------------------

### Perform Function Hook with hookfunction - Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/function_hooks.md

Executes the function hooking operation. It uses 'hookfunction' to replace the target function ('Instance.new('RemoteEvent').FireServer') with a new function created by 'newcclosure'. The original function is captured and assigned to the 'OldFireServer' variable.

```Lua
OldFireServer = hookfunction(Instance.new'RemoteEvent'.FireServer, newcclosure(function(Event, ...)
    return OldFireServer(Event, ...)
end))
```

--------------------------------

### Function Signature: printconsole (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `printconsole` function, which prints a message to the internal and integrated consoles with a specified RGB color value.

```syn
<void> printconsole(<string> message, <byte> red, <byte> green, <byte> blue)
```

--------------------------------

### Appending to File (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Appends the given content to the end of the file located at the specified path. If the file does not exist, this function will result in an error.

```syn
<void> appendfile(<string> path, <string> content)
```

--------------------------------

### Access Synapse Cryptography Library (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Provides access to the Synapse cryptography library functions. This is an alias for `syn.crypt.*`. Refer to the separate cryptography library documentation for details on available functions.

```syn
<...> syn.crypto.*
```

--------------------------------

### Deleting File (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Deletes the file located at the supplied path. This function will error if no file exists at the specified path.

```syn
<void> delfile(<string> path)
```

--------------------------------

### Function Signature: rconsoleinfo (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `rconsoleinfo` function, which prints an informational message to the console with a preceding info text.

```syn
<void> rconsoleinfo(<string> message)
```

--------------------------------

### syn.secure_call Function Signature (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Provides the signature for the deprecated `syn.secure_call` function. It shows the expected arguments: a function to call, a script or table for context, and optional arguments for the function.

```syn
<variant...> syn.secure_call(<function> func, union<LocalScript, ModuleScript, table> script, <variant> args...)
```

--------------------------------

### Converting to Hex String (tohex) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Converts the unsigned integer 'val' into its hexadecimal string representation using the bit library.

```syn
<string> bit.tohex(<uint> val)
```

--------------------------------

### Unprotect GUI from Recursive FindFirstChild (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Removes the protection previously applied to a `GUI` instance using `syn.protect_gui`. This function will raise an error if the provided GUI instance was not previously protected by Synapse.

```syn
<void> syn.unprotect_gui(<Instance> GUI)
```

--------------------------------

### Converting to Bitwise Form (tobit) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Converts the unsigned integer 'val' into a format suitable for other bitwise operations within the bit library.

```syn
<int> bit.tobit(<uint> val)
```

--------------------------------

### Bitwise XOR (bxor) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a bitwise XOR operation between unsigned integers 'val' and 'by' using the bit library.

```syn
<int> bit.bxor(<uint> val, <uint> by)
```

--------------------------------

### Simulate Left Click (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates a complete left mouse button click, which includes both pressing down and releasing the button.

```syn
<void> mouse1click(<void>)
```

--------------------------------

### Set Stack (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Set the stack indice at level `indice` to value `value` at level or function `fi`.

```Synapse X Lua
<void> debug.setstack(<number> indice, <number> indice, <table> value)
```

--------------------------------

### Deleting Folder (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Deletes the folder located at the supplied path. This function will error if no folder exists at the specified path.

```syn
<void> delfolder(<string> path)
```

--------------------------------

### Set Metatable (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Set the metatable of `o` to `mt`.

```Synapse X Lua
<table> debug.setmetatable(<table> o, <table> mt)
```

--------------------------------

### syn.create_secure_function Function Signature (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Provides the signature for the `syn.create_secure_function`. It takes a string of code and returns a string representing the protected function. This function is used to protect code from alteration or viewing.

```syn
<string> syn.create_secure_function(<string> code)
```

--------------------------------

### Reading Files with readfile - Synapse X Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/filesystem_api.md

Reads the entire content of a specified file from the Synapse X workspace directory. It returns the file content as a string if the file exists, otherwise it causes an error.

```lua
local contents = readfile("test.txt")
```

--------------------------------

### Modifying Upvalue using debug.setupvalue with Call-Stack Level in Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/debug_api.md

This snippet demonstrates using `debug.setupvalue` with a call-stack level (2, referring to the `Test` function) instead of the function object itself to modify an upvalue from within a nested function.

```Lua
local TestVariable = "Hello, world!"

local function Test()
    local function InnerFunction()
        --2 refers to the Test function
        debug.setupvalue(2, 1, "Hello, modified world!")
    end

    InnerFunction()

    print(TestVariable)
    TestVariable = "Still - Hello, world!"
    print(TestVariable)
end

Test()
```

--------------------------------

### Check Window Focus (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Returns a boolean indicating if the main window is currently in focus. This function must return true for any other mouse or keyboard input simulation function to work correctly.

```syn
<bool> iswindowactive(<void>)
```

--------------------------------

### Checking Network Ownership (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Returns a boolean indicating whether the specified BasePart instance is currently network-owned by the local player. This is relevant for physics and replication.

```Synapse
<bool> isnetworkowner(<BasePart> Part)
```

--------------------------------

### Detecting Metatable Hooks using xpcall (Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/development/newcclosure.md

This Lua snippet demonstrates a technique to detect metatable hooks by using `xpcall` to force an error and then inspecting the call stack (`getfenv`) within the error handler for suspicious environments that differ from the original function's environment.

```lua
local Env = getfenv()

xpcall(function()
    return game:_____()
end, function()
    for i = 0, 10 do
        if getfenv(i) ~= Env then
            warn("Detected metamethod tampering!")
        end
    end
end)
```

--------------------------------

### Handling WebSocket Closure with WebSocket.OnClose (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/websocket_lib.md

An event that fires when the WebSocket connection is closed, either initiated by the client using Close or by the server.

```syn
WebSocket.OnClose
```

--------------------------------

### Setting Fast Flag (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/misc.md

Modifies an internal Roblox Fast Flag (`FFlag`) to the specified `Value`. This function must be executed very early, ideally via auto-execute or auto-launch, before the game fully loads for the change to take effect.

```syn
<void> setfflag(<string> FFlag, <string> Value)
```

--------------------------------

### Function Signature: rconsoleinput (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `rconsoleinput` function, which pauses execution until the user provides input in the console and returns the entered string.

```syn
<string> rconsoleinput(<void>)
```

--------------------------------

### Reading File Content (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Reads the contents of the file located at the specified path and returns it as a string. This function will error if the file does not exist at the given path.

```syn
<string> readfile(<string> path)
```

--------------------------------

### Adding (badd) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Adds two unsigned integers, 'a' and 'b', using the bit library. This function allows for potential integer overflows.

```syn
<int> bit.badd(<uint> a, <uint> b)
```

--------------------------------

### Function Signature: rconsoleprint (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `rconsoleprint` function, which prints a string message to the console. It accepts a single string argument and returns nothing. This function supports special color codes.

```syn
<void> rconsoleprint(<string> message)
```

--------------------------------

### Firing a TouchInterest (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Fakes a .Touched or .TouchEnded event between two parts. The `Toggle` argument must be 0 (un-fire) or 1 (fire). The `ToTouch` part must have a `TouchTransmitter` child.

```Synapse
<void> firetouchinterest(<Instance> Part, <BasePart> ToTouch, <uint> Toggle)
```

--------------------------------

### Custom Encrypt Data - syn

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/crypt_lib.md

Encrypts the provided data using a specified cipher algorithm, key, and initialization vector (IV) or nonce. This allows for more control over the encryption process.

```syn
<string> syn.crypt.custom.encrypt(<string> cipher, <string> data, <string> key, <string> iv/nonce)
```

--------------------------------

### Dividing (bdiv) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Divides the 'dividend' by the 'divisor' using the bit library. This function performs integer division and does not return the remainder.

```syn
<int> bit.bdiv(<uint> dividend, <uint> divisor)
```

--------------------------------

### Hooking Function in Synapse X (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/hooking.md

Hooks the 'old' function, replacing it with the 'hook' function. Returns the original function, which must be called to execute the original logic.

```syn
<function> hookfunction(<function> old, <function> hook)
```

--------------------------------

### Loading String as Function - Synapse Lua

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/reflection.md

Loads a string chunk as a Lua function with an optional name. Returns the function on success or nil and an error message on failure during compilation.

```Synapse Lua
<union<function, nil>, <string?>> loadstring(<string> chunk, <string?> chunk_name)
```

--------------------------------

### Bitwise OR (bor) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a bitwise OR operation between unsigned integers 'val' and 'by' using the bit library.

```syn
<int> bit.bor(<uint> val, <uint> by)
```

--------------------------------

### Left Shift (lshift) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a left bit shift operation on the unsigned integer 'val' by 'by' positions using the bit library.

```syn
<int> bit.lshift(<uint> val, <uint> by)
```

--------------------------------

### Function Signature: rconsolewarn (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `rconsolewarn` function, which prints a warning message to the console with a preceding warning text.

```syn
<void> rconsolewarn(<string> message)
```

--------------------------------

### Replace Instance in Synapse Cache (Syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/syn_lib.md

Replaces an existing instance (`obj`) in the Synapse instance cache with a new instance (`t_obj`). This function modifies how Synapse looks up instances internally.

```syn
<void> syn.cache_replace(<Instance> obj, <Instance> t_obj)
```

--------------------------------

### Set Constant (Synapse X Lua)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/debug_lib.md

Set constant `idx` to tuple `value` at level or function `fi`.

```Synapse X Lua
<void> debug.setconstant(union<function, number> fi, union<string, int> idx, union<number, bool, nil, string> value)
```

--------------------------------

### Custom Hash Data - syn

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/crypt_lib.md

Computes the hash of the input data string using a specified hashing algorithm. This provides flexibility in choosing the desired hashing method.

```syn
<string> syn.crypt.custom.hash(<string> algorithm, <string> data)
```

--------------------------------

### Hooking Metamethod in Synapse X (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/hooking.md

Hooks the specified 'metamethod' of an 'object''s metatable with the 'hook' function. Returns a function to call the original metamethod. Errors if the object has no metatable or the metamethod is invalid.

```syn
<function> hookmetamethod(<Object> object, <string> metamethod, <function> hook)
```

--------------------------------

### Function Signature: rconsolename (Synapse Script)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/console.md

Defines the signature for the `rconsolename` function, which sets the title of the currently allocated console window.

```syn
<void> rconsolename(<string> title)
```

--------------------------------

### Generate Random String - syn

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/crypt_lib.md

Generates a random string of a specified size. The size parameter must be a positive integer and cannot exceed 1024.

```syn
<string> syn.crypt.random(<uint> size)
```

--------------------------------

### Move Mouse Absolutely (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Moves the mouse cursor to the specified absolute coordinates (`x`, `y`) within the main window, where (0,0) is the top-left corner.

```syn
<void> mousemoveabs(<number> x, <number> y)
```

--------------------------------

### Sending Message via WebSocket:Send (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/websocket_lib.md

Sends a string message to the connected WebSocket server. This method is called on a WebSocket object obtained from a successful connection.

```syn
WebSocket:Send(<string> message)
```

--------------------------------

### Right Shift (rshift) using bit (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/bit_lib.md

Performs a right bit shift operation on the unsigned integer 'val' by 'by' positions using the bit library.

```syn
<int> bit.rshift(<uint> val, <uint> by)
```

--------------------------------

### Simulate Right Mouse Down (Synapse X)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/input.md

Simulates pressing down the right mouse button.

```syn
<void> mouse2press(<void>)
```

--------------------------------

### Checking if Path is File (syn)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/filesystem.md

Checks if the entity at the given path is a file. Returns a boolean value: `true` if it is a file, `false` otherwise.

```syn
<bool> isfile(<string> path)
```

--------------------------------

### Setting Simulation Radius (Synapse)

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/environment.md

Sets the player's physics simulation radius. The optional `MaxSimulationRadius` argument can also be set if provided.

```Synapse
<void> setsimulationradius(<uint> SimulationRadius, <uint?> MaxSimulationRadius)
```

--------------------------------

### Base64 Encode - syn

Source: https://github.com/orangedoggo/synapse-x-docs/blob/main/src/reference/crypt_lib.md

Encodes the input data string into its Base64 representation. This is useful for converting binary data into a text format.

```syn
<string> syn.crypt.base64.encode(<string> data)
```