Matcha LuaVM

https://matcha-latte.gitbook.io/matcha
Admin
Matcha LuaVM is an undetected Lua virtual machine that emulates Roblox engine functions externally...
Tokens:15,036
Snippets:128
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get All Scripts

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Returns a table containing all script instances currently present in the game.

```lua
function getscripts(): { Scripts }
```

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

### Instance Methods for Attribute Management (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

Details methods for getting and setting attributes associated with an Instance. Attributes allow for custom data storage and retrieval, enhancing the flexibility of the Instance object.

```lua
function Instance:GetAttribute(name: string): any
function Instance:GetAttributes(): { string }
function Instance:SetAttribute(name: string, value: any): nil
```

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

### Get Script Bytecode

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Retrieves and returns the raw bytecode of a given script instance as a string.

```lua
function getscriptbytecode(script: Instance): string
```

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

### Get Script Hash

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Calculates and returns the FNV-1a 64-bit hash of a script's bytecode.

```lua
function getscripthash(script: Instance): string
```

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

### Draw Red Square with Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/drawing

This Lua snippet creates a red, filled square with specified position, size, and corner radius. It remains visible for 5 seconds before being removed. No external dependencies are required beyond the 'Drawing' and 'Color3' objects.

```lua
local square = Drawing.new("Square")
square.Filled = true
square.Color = Color3.fromRGB(255, 0, 0)
square.Position = Vector2.new(20, 20)
square.Size = Vector2.new(200, 200)
square.Visible = true
square.Corner = 20
wait(5)
square:Remove()
```

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

### Get Game Name

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Retrieves and returns the name of the current game.

```lua
function getgetname(): string
```

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

### DrawingObject Line Properties (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject

Properties for line objects, defining the start (From) and end (To) points, and the Thickness.

```lua
DrawingObject.From: Vector2
DrawingObject.To: Vector2
DrawingObject.Thickness: int
```

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

### Access UserInputService

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice

This snippet shows how to get the UserInputService instance from the Roblox game services. This service is essential for processing all forms of user input.

```luau
local UserInputService = game:GetService("UserInputService")
```

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

### Get All Players Function

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players

Provides a function to retrieve a table containing all players currently in the game. This function returns a table of player objects.

```Luau
function Players:GetPlayers(): Table
```

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

### Get RobloxPlayerBeta.exe Base Address

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions

Retrieves the base memory address of the RobloxPlayerBeta.exe process. This is essential for many memory manipulation tasks.

```lua
function getbase(): int
-- Returns RobloxPlayerBeta.exe base address
end
```

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

### GenerateGUID Service

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service

Generates a globally unique identifier (GUID).

```APIDOC
## POST /websites/matcha-latte_gitbook_io_matcha/http/generateguid

### Description
Generates a globally unique identifier (GUID).

### Method
POST

### Endpoint
/websites/matcha-latte_gitbook_io_matcha/http/generateguid

### Response
#### Success Response (200)
- **result** (string) - The generated GUID.
```

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

### HttpGet Service

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service

Makes an HTTP GET request to the specified URL.

```APIDOC
## GET /websites/matcha-latte_gitbook_io_matcha/http/get

### Description
Makes an HTTP GET request to the specified URL.

### Method
GET

### Endpoint
/websites/matcha-latte_gitbook_io_matcha/http/get

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to make the GET request to.
- **content** (string) - Optional - The content to send with the request (typically for POST, but included here as per original signature).

### Response
#### Success Response (200)
- **result** (any) - The response data from the URL.
```

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

### HttpGet Function

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service

Performs an HTTP GET request to a specified URL. It takes the URL and optional content as input and returns the response data. This function is part of the DataModel service.

```lua
function DataModel:HttpGet(url: string, content: string): any
```

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

### GenerateGUID Function

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service

Generates a globally unique identifier (GUID). This function is useful for creating unique keys or identifiers within an application. It is part of the HttpService.

```lua
function HttpService:GenerateGUID(): string
```

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

### Get GuiObject AbsolutePosition

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject

Retrieves the absolute pixel coordinates of a GuiObject's top-left corner. This property returns a Vector2 value representing the X and Y position of the object on the screen, unaffected by parent transformations.

```lua
GuiObject.AbsolutePosition: Vector2
```

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

### Get GuiObject AbsoluteSize

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject

Retrieves the absolute pixel dimensions of a GuiObject. This property returns a Vector2 value representing the width and height of the object, independent of its parent's scaling or offset.

```lua
GuiObject.AbsoluteSize: Vector2
```

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

### Get Fast Flag - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions

Retrieves the value of a specified fast flag (`FFlag`). This function is also marked as incomplete. It takes one string argument, `FFlag`, and is expected to return a value, though the return type is not explicitly defined in the provided snippet.

```lua
function getfflag(FFlag: string): any
-- Function body not provided
end
```

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

### Instance Methods

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

This section describes the methods available for the Instance object.

```APIDOC
## Instance Methods

### Description
Methods available for the Instance object.

### Methods
#### FindFirstChildOfClass
- **FindFirstChildOfClass** (name: string): Instance - Finds the first child of the instance that is of the specified class.

#### FindFirstChild
- **FindFirstChild** (name: string): Instance - Finds the first child of the instance with the specified name.

#### IsA
- **IsA** (name: string): boolean - Checks if the instance is of the specified class or inherits from it.

#### GetFullName
- **GetFullName** (): string - Returns the full name of the instance, including its parent hierarchy.

#### GetChildren
- **GetChildren** (): { Instance } - Returns a table of all the direct children of the instance.

#### GetAttribute
- **GetAttribute** (name: string): any - Gets the value of an attribute associated with the instance.

#### GetAttributes
- **GetAttributes** (): { string } - Returns a table of all attribute names associated with the instance.

#### SetAttribute
- **SetAttribute** (name: string, value: any): nil - Sets the value of an attribute associated with the instance.

#### GetDescendants
- **GetDescendants** (): { Instance } - Returns a table of all descendants of the instance (children, grandchildren, etc.).

#### IsDescendantOf
- **IsDescendantOf** (parent: Instance): boolean - Checks if the instance is a descendant of the specified parent instance.

#### FindFirstChildWhichIsA
- **FindFirstChildWhichIsA** (class: string): Instance - Finds the first child of the instance that is of the specified class or inherits from it.

#### WaitForChild
- **WaitForChild** (name: string): Instance - Waits for a child with the specified name to exist and then returns it.

```

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

### Instance Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

This section describes the properties of the Instance object.

```APIDOC
## Instance Properties

### Description
Properties of the Instance object.

### Properties
#### Name
- **Name** (string) - The name of the instance.

#### ClassName
- **ClassName** (string) - The class name of the instance.

#### Parent
- **Parent** (Instance) - The parent of the instance.

#### Address
- **Address** (number) - Hexadecimal number representing the Instance’s memory address.

```

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

### Instance Methods for Child Searching (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

Provides methods for searching and retrieving child objects of an Instance. These methods allow for flexible querying based on class name, name, or hierarchical relationships.

```lua
function Instance:FindFirstChildOfClass(name: string): Instance
function Instance:FindFirstChild(name: string): Instance
function Instance:FindFirstChildWhichIsA(class: string): Instance
function Instance:WaitForChild(name: string): Instance
```

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

### Handle Input Began Event

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice

This snippet demonstrates how to connect to the InputBegan event of the UserInputService. This event fires whenever a user initiates an input action, such as pressing a key or touching a screen. It provides the InputObject and a boolean indicating if the input was processed by the game.

```luau
UserInputService.InputBegan:Connect(function(input: InputObject, gameProcessed: boolean))
end)
```

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

### Player Methods

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player

Available methods for the Player object.

```APIDOC
## Player Methods

### Description
Provides access to methods for interacting with the Player object.

### Methods
#### GetMouse
- **GetMouse** (): Mouse - Returns the mouse object associated with the player.

#### GetPlayers
- **GetPlayers** (): table - Returns a table of all players.
```

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

### Instance Methods for Hierarchy and Type Checking (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

Includes methods for checking an instance's type and its relationship with other instances in the hierarchy. These are crucial for understanding object composition and performing type-safe operations.

```lua
function Instance:IsA(name: string): boolean
function Instance:GetFullName(): string
function Instance:GetChildren(): { Instance }
function Instance:GetDescendants(): { Instance }
function Instance:IsDescendantOf(parent: Instance): boolean
```

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

### DataModel Methods (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel

Outlines the methods available in the DataModel. HttpGet allows for making HTTP requests with a specified URL and content, returning any type of data. GetService retrieves an Instance object by its name.

```lua
function DataModel:HttpGet(url: string, content: string): any
function DataModel:GetService(name: string): Instance
```

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

### Vector2 Constructors and Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2

This section details how to create Vector2 instances and access their X and Y components.

```APIDOC
## Vector2 Data Type

### Description
The `Vector2` data type represents a 2D value with direction and magnitude. It is commonly used for GUI elements and 2D mouse positions.

### Constructors

#### `Vector2.new(x: number, y: number)`

**Description**: Returns a `Vector2` from the given x and y components.

**Method**: Constructor

**Parameters**:

*   **x** (number) - Required - The x-component of the Vector2.
*   **y** (number) - Required - The y-component of the Vector2.

### Properties

#### `X` (number)

**Description**: The x-component of the Vector2.

#### `Y` (number)

**Description**: The y-component of the Vector2.

### Usage Examples

#### Creating a Vector2
```lua
local myVector = Vector2.new(10, 20)
print(myVector.X) -- Output: 10
print(myVector.Y) -- Output: 20
```

#### Accessing Properties
```lua
local position = Vector2.new(50, 100)
local xPosition = position.X
local yPosition = position.Y

print("X Position:", xPosition)
print("Y Position:", yPosition)
```
```

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

### Instance Properties (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance

Defines the properties of an Instance object, including its name, class, parent, and memory address. These properties provide essential information about the instance's identity and state.

```lua
Instance.Name: string
Instance.ClassName: string
Instance.Parent: Instance
Instance.Address: number
```

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

### Camera Constructors

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera

Details about the constructors available for the Camera object.

```APIDOC
## Camera.lookAt Constructor

### Description
Sets the camera's orientation to look at a specific point from a given position.

### Method
`lookAt`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **at** (Vector3) - Required - The position of the camera.
- **lookAt** (Vector3) - Required - The point the camera should look at.

### Request Example
```lua
Camera.lookAt(Vector3.new(0, 0, 0), Vector3.new(0, 0, -10))
```

### Response
#### Success Response (200)
This method does not return a value.
```

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

### Accessing ValueBase.Value Property

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase

Demonstrates how to access the 'Value' property of a ValueBase object. This property can hold any data type, depending on the specific inherited value class.

```lua
local valueBaseInstance = --[[ instance of a ValueBase subclass ]]
local currentValue = valueBaseInstance.Value
print(currentValue)
```

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

### Identify Executor

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Returns the name and version of the current executor environment.

```lua
function identifyexecutor(): string
```

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

### Require Module - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions

Loads and returns a Lua module from the specified `path`. The `require` function only accepts files with `.lua` and `.luau` extensions. It takes a string `path` and returns a table.

```lua
function require(path: string): table
-- Function body not provided
end
```

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

### Simulate Mouse Button 1 Click

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a complete click action for the primary mouse button (press and release). This is a common way to simulate a user clicking an element.

```lua
function mouse1click(): nil
```

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

### Spawn Task - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions

Spawns a new thread to execute a given target function asynchronously. It takes a function `target` as input and returns `nil`.

```lua
function spawn(target: function): nil
-- Function body not provided
end
```

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

### Decompile Script

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Decompiles a given script instance and returns its source code as a string. Throws an error if decompilation fails.

```lua
function decompile(script: Instance): string
```

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

### Connect to PlayerAdded Event

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players

Allows connecting a function to the PlayerAdded event, which fires whenever a new player joins the game. The connected function receives the newly added player object as an argument.

```Luau
Players.PlayerAdded:Connect(function(player))
```

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

### UserInputService Events

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice

Connect to events that are fired when a user begins or ends an input action.

```APIDOC
## UserInputService

### Description
Provides access to user input events.

### Method
N/A (Service)

### Endpoint
N/A (Service)

## InputBegan

### Description
Fired when a user begins an input action (e.g., pressing a key, touching a screen).

### Method
Connect

### Endpoint
UserInputService.InputBegan

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```luau
local UserInputService = game:GetService("UserInputService")
UserInputService.InputBegan:Connect(function(input: InputObject, gameProcessed: boolean))
    -- Handle input here
end)
```

### Response
#### Success Response (200)
N/A (Event)

#### Response Example
N/A (Event)

## InputEnded

### Description
Fired when a user ends an input action (e.g., releasing a key, lifting a finger).

### Method
Connect

### Endpoint
UserInputService.InputEnded

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```luau
local UserInputService = game:GetService("UserInputService")
UserInputService.InputEnded:Connect(function(input: InputObject, gameProcessed: boolean))
    -- Handle input here
end)
```

### Response
#### Success Response (200)
N/A (Event)

#### Response Example
N/A (Event)
```

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

### Load Lua Chunk

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Compiles and loads a Lua chunk as a function. Returns the function on success or nil and an error message on compilation failure.

```lua
function loadstring(chunk: string, chunkname: string)
```

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

### Drawing Constructors

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing

Provides methods for creating new drawing objects.

```APIDOC
## Drawing.new

### Description
Creates a new drawing object of a specified type.

### Method
`new`

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

```

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

### Run Secure Code - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions

Executes a given string of code in a protected environment. Note that code protection features are not publicly available. The function takes a string `text` as input.

```lua
function run_secure(text: string)
-- Function body not provided
end
```

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

### Task Spawn - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions

Spawns a new task to execute a given target function asynchronously, likely part of a task scheduler system. It takes a function `target` as input and returns `nil`.

```lua
function task.spawn(target: function): nil
-- Function body not provided
end
```

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

### Simulate Mouse Button 2 Release

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a release event for the secondary mouse button. This simulates releasing a right-click.

```lua
function mouse2release(): nil
```

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

### BasePart Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart

This section outlines the properties of the BasePart object, detailing their types and potential values.

```APIDOC
## BasePart Properties

### Description
This section outlines the properties of the BasePart object, detailing their types and potential values.

### Properties

#### Size
- **Size** (Vector3) - The dimensions of the BasePart.

#### Position
- **Position** (Vector3) - The world-space position of the BasePart's origin.

#### Transparency
- **Transparency** (number) - Controls the visibility of the BasePart, ranging from 0 (fully opaque) to 1 (fully transparent).

#### Color
- **Color** (Color3) - The color of the BasePart.

#### Velocity
- **Velocity** (Vector3) - The current linear velocity of the BasePart.

#### AssemblyLinearVelocity
- **AssemblyLinearVelocity** (Vector3) - The current linear velocity of the BasePart, considering its assembly.

#### CanCollide
- **CanCollide** (bool) - Determines whether the BasePart can collide with other physical objects.
```

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

### Simulate Mouse Button 2 Click

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a complete click action for the secondary mouse button (press and release). This simulates a right-click.

```lua
function mouse2click(): nil
```

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

### Player Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player

Access properties of the Player object.

```APIDOC
## Player Properties

### Description
Provides access to properties of the Player object.

### Properties
#### Character
- **Character** (Model) - The character model associated with the player.

#### Team
- **Team** (Team) - The team the player belongs to.
```

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

### Access Local Player Object

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players

Retrieves the LocalPlayer object, which represents the player currently running the game. This is a direct property access.

```Luau
Players.LocalPlayer: Player
```

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

### Simulate Mouse Button 1 Release

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a release event for the primary mouse button. This function simulates releasing a button that was previously pressed.

```lua
function mouse1release(): nil
```

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

### Define Fonts in Matcha Latte

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts

This snippet shows the font definitions used in the Matcha Latte project. It maps internal font identifiers to specific font names, covering UI, system, and custom fonts like Minecraft and Fortnite.

```text
Drawing.Fonts.UI | ProggyClean
Drawing.Fonts.System | San Francisco
Drawing.Fonts.SystemBold | SF Bold
Drawing.Fonts.Minecraft | Minecraft
Drawing.Fonts.Monospace | JetBrains
Drawing.Fonts.Pixel | Pixel
Drawing.Fonts.Fortnite | Fortnite
```

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

### Set Clipboard Content

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Copies a specified string value to the system clipboard. This function allows for easy data transfer between the application and the user's clipboard.

```lua
function setclipboard(value: string): nil
```

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

### DataModel Methods

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel

This section outlines the methods available on the DataModel for performing operations.

```APIDOC
## DataModel Methods

### Description
Provides functions for making HTTP requests and retrieving services.

### Methods
#### HttpGet

##### Description
Performs an HTTP GET request to the specified URL.

##### Method
`DataModel:HttpGet`

##### Parameters
- **url** (string) - Required - The URL to send the GET request to.
- **content** (string) - Optional - The content to be sent with the request (typically for POST, but included here as per signature).

##### Returns
- `any` - The result of the HTTP request.

#### GetService

##### Description
Retrieves a specific service by its name.

##### Method
`DataModel:GetService`

##### Parameters
- **name** (string) - Required - The name of the service to retrieve (e.g., "Players", "Workspace").

##### Returns
- `Instance` - The requested service instance.
```

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

### Camera lookAt Constructor (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera

The Camera.lookAt constructor sets the camera's orientation. It takes two Vector3 arguments: 'at' for the camera's position and 'lookAt' for the point the camera should face. This function is crucial for defining the camera's viewpoint in a 3D scene.

```lua
Camera.lookAt(at: Vector3, lookAt: Vector3)
```

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

### Create Vector2 Instance (Lua)

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2

Constructs a new Vector2 object using the provided x and y numerical components. This is essential for initializing 2D vectors in Lua-based environments like Roblox.

```lua
Vector2.new(x : number, y : number)
```

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

### Model Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model

This section details the properties available for the Model, including the PrimaryPart.

```APIDOC
## Model Properties

### Description
Provides information about the properties of a Model object, including its primary component.

### Method
GET

### Endpoint
/model/properties

### Parameters
#### Query Parameters
- **modelId** (string) - Required - The unique identifier for the model.

### Response
#### Success Response (200)
- **PrimaryPart** (BasePart) - The primary component of the model.

#### Response Example
```json
{
  "PrimaryPart": {
    "type": "BasePart",
    "name": "ExamplePart"
  }
}
```
```

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

### Camera Properties

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera

Details about the properties of the Camera object.

```APIDOC
## Camera Properties

### Description
Properties that define the camera's viewport size, field of view, and position.

### Properties

#### ViewportSize
- **Type**: Vector2
- **Description**: The size of the camera's viewport.

#### FieldOfView
- **Type**: number
- **Description**: The field of view of the camera in degrees.

#### Position
- **Type**: Vector3
- **Description**: The current position of the camera in 3D space.
```

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

### Connect to PlayerRemoving Event

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players

Enables connecting a function to the PlayerRemoving event, which is triggered when a player is about to leave the game. The function receives the player object that is leaving.

```Luau
Players.PlayerRemoving:Connect(function(player))
```

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

### Print Message to Console - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions

The `print` function is used to display a string message to the console. It is a fundamental utility for debugging and logging information during runtime. This function takes a single string argument.

```lua
function print(message: string)
end
```

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

### Simulate Mouse Scroll

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Simulates mouse wheel scrolling by a specified amount. Positive values typically scroll up, and negative values scroll down. This function is used for simulating scroll actions.

```lua
function mousescroll(amount: int): nil
```

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

### Simulate Key Release

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a key release event for a specified keycode. This is part of simulating keyboard input and is often used in conjunction with key press events.

```lua
function keyrelease(keycode: int): nil
```

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

### Convert World Position to Screen Coordinates

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions

Converts a 3D world position to 2D screen coordinates. Returns the screen coordinates and a boolean indicating if the position is on screen.

```lua
function WorldToScreen(position: Vector3): (Vector2, boolean)
```

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

### Simulate Key Press

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a key press event for a specified keycode. This function is used to programmatically simulate keyboard input, which can be useful for automation or testing.

```lua
function keypress(keycode: int): nil
```

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

### Log Warning to Console - Lua

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions

The `warn` function is used to log a warning message to the console. This is typically used to indicate potential issues or non-critical errors that do not halt program execution. It accepts a single string argument.

```lua
function warn(message: string)
end
```

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

### Simulate Mouse Button 2 Press

Source: https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions

Triggers a press event for the secondary mouse button. This simulates a right-click down action.

```lua
function mouse2press(): nil
```
Tokens:
Raw