# Table of Contents

- [Getting Started | Matcha](#getting-started-matcha)
- [Functions | Matcha](#functions-matcha)
- [Console Functions | Matcha](#console-functions-matcha)
- [Globals Functions | Matcha](#globals-functions-matcha)
- [Classes | Matcha](#classes-matcha)
- [Miscellaneous Functions | Matcha](#miscellaneous-functions-matcha)
- [Input Functions | Matcha](#input-functions-matcha)
- [Memory Functions | Matcha](#memory-functions-matcha)
- [BasePart | Matcha](#basepart-matcha)
- [Camera | Matcha](#camera-matcha)
- [DataModel | Matcha](#datamodel-matcha)
- [Model | Matcha](#model-matcha)
- [Workspace | Matcha](#workspace-matcha)
- [Humanoid | Matcha](#humanoid-matcha)
- [HttpGet Service | Matcha](#httpget-service-matcha)
- [ValueBase | Matcha](#valuebase-matcha)
- [Mouse | Matcha](#mouse-matcha)
- [Dataypes | Matcha](#dataypes-matcha)
- [Vector3 | Matcha](#vector3-matcha)
- [Vector2 | Matcha](#vector2-matcha)
- [TextLabel | Matcha](#textlabel-matcha)
- [Players | Matcha](#players-matcha)
- [Player | Matcha](#player-matcha)
- [Instance | Matcha](#instance-matcha)
- [MeshPart | Matcha](#meshpart-matcha)
- [GuiObject | Matcha](#guiobject-matcha)
- [UserInputService | Matcha](#userinputservice-matcha)
- [Drawing | Matcha](#drawing-matcha)
- [Color3 | Matcha](#color3-matcha)
- [Drawing | Matcha](#drawing-matcha)
- [Fonts | Matcha](#fonts-matcha)
- [DrawingObject | Matcha](#drawingobject-matcha)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Functions | Matcha](#functions-matcha)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)
- [Unknown](#unknown)

---

# Getting Started | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/introduction/getting-started.md)
.

This is the documentation for the Matcha LuaVM. Please note that the **LuaVM is not an executor, it does not internally hook any functions in the Roblox engine**. Instead it tries to emulate those functions externally. This makes it completely undetected, but also means it lacks direct access to internal Roblox API functions.

### 

[](https://matcha-latte.gitbook.io/matcha#resources)

Resources

To understand how the LuaVM works, you first need to understand the basics of Lua(U). For that, visit lua.org

[NextFunctions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions)

Last updated 8 months ago

---

# Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions.md)
.

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions#overview)

Overview


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

This article, and it's sub-pages document how to use functions built in Matcha.

[PreviousGetting Started](https://matcha-latte.gitbook.io/matcha)
[NextGlobals Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions)

Last updated 6 months ago

---

# Console Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions#print-printl)

print / printl

Copy

    function print(message: string)

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions#warn)

warn

Copy

    function warn(message: string)

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions#error)

error

Copy

    function error(message: string)

[PreviousGlobals Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions)
[NextInput Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions)

Last updated 6 months ago

---

# Globals Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#loadstring-load)

loadstring / load

Copy

    function loadstring(chunk: string, chunkname: string)

Loads `chunk` as a Lua function and returns it if compilation is successful. Otherwise, if an error has occurred during compilation, nil followed by the error message will be returned.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#decompile)

decompile

Copy

    function decompile(script: Instance): string

Decompiles `Script` and returns the decompiled script. If the decompilation fails, then notify an error message.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#worldtoscreen)

WorldToScreen

Copy

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

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#notify)

notify

Copy

    function notify(message: string, title: string, duration: number)

Sends a Matcha notification with a message, title, and duration in seconds

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#identifyexecutor)

identifyexecutor

Copy

    function identifyexecutor(): string

Returns "Matcha" and version

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#getscripthash)

getscripthash

Copy

    function getscripthash(script: Instance): string

Returns FNV-1a 64-bit hash of bytecode

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#getgetname)

getgetname

Copy

    function getgetname(): string

Returns the game name

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#getscripts)

getscripts

Copy

    function getscripts(): { Scripts }

Returns all script instances

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#getscriptbytecode)

getscriptbytecode

Copy

    function getscriptbytecode(script: Instance): string

Returns the raw bytecode of a script

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#base64encode)

base64encode

Copy

    function base64encode(data: string): string

Encodes a string to Base64 format

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions#base64decode)

base64decode

Copy

    function base64decode(data: string): string

Decodes a Base64 string back to normal string

[PreviousFunctions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions)
[NextConsole Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions)

Last updated 6 months ago

---

# Classes | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes.md)
.

[BasePart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart)
[Camera](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera)
[DataModel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel)
[HttpGet Service](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service)
[Humanoid](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid)
[Model](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model)
[Workspace](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace)
[Instance](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance)
[Mouse](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse)
[Players](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players)
[Player](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player)
[ValueBase](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase)
[GuiObject](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject)
[TextLabel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel)
[MeshPart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart)
[UserInputService](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice)

[PreviousMemory Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions)
[NextBasePart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart)

---

# Miscellaneous Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#run_secure)

run\_secure

Copy

    function run_secure(text: string)

Run protected code.

Code protection is not available to the public!

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#set-fast-flag)

Set Fast Flag

Copy

    function setfflag(FFlag: string, value: string)

Sets `FFlag` with `Value`.

This function is not complete!

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#set-fast-flag-1)

Get Fast Flag

Copy

    function getfflag(FFlag: string)

Sets `FFlag` with `Value`.

This function is not complete!

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#require)

require

Require only accepts files ending with `.lua` and `.luau`

Copy

    function require(path: string): table

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#wait)

wait

Copy

    function wait(time: number)

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#spawn)

spawn

Copy

    function spawn(target: function): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#task.spawn)

task.spawn

Copy

    function task.spawn(target: function): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions#task.wait)

task.wait

Copy

    function task.wait(time: number)

[PreviousInput Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions)
[NextMemory Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions)

Last updated 6 months ago

---

# Input Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#setrobloxinput)

setrobloxinput

Copy

    function setrobloxinput(state: boolean): nil

This function toggles sending inputs to the game.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#isrbxactive)

isrbxactive

Copy

    function isrbxactive(): bool

This function will return if your current window is Roblox.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#setclipboard)

setclipboard

Copy

    function setclipboard(value: string): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#keyrelease)

keyrelease

Copy

    function keyrelease(keycode: int): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#keypress)

keypress

Copy

    function keypress(keycode: int): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#iskeypressed)

iskeypressed

Copy

    function iskeypressed(keycode: int): bool

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#ismouse1pressed)

ismouse1pressed

Copy

    function ismouse1pressed(): bool

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#ismouse2pressed)

ismouse2pressed

Copy

    function ismouse2pressed(): bool

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse1press)

mouse1press

Copy

    function mouse1press(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse1release)

mouse1release

Copy

    function mouse1release(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse1click)

mouse1click

Copy

    function mouse1click(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse2press)

mouse2press

Copy

    function mouse2press(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse2release)

mouse2release

Copy

    function mouse2release(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mouse2click)

mouse2click

Copy

    function mouse2click(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mousemoveabs)

mousemoveabs

Copy

    function mousemoveabs(x: int, y: int): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mousemoverel)

mousemoverel

Copy

    function mousemoverel(x: int, y: int): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions#mousescroll)

mousescroll

Copy

    function mousescroll(amount: int): nil

[PreviousConsole Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions)
[NextMiscellaneous Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions)

Last updated 6 months ago

---

# Memory Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions.md)
.

You must allow unsafe LuaU execution before using these functions

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions#memory-types)

Memory Types

Memory Types

Returns

int

int

float

number

double

number

byte

int

string

string

uintptr\_t

int

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions#set-fast-flag)

getbase

Copy

    function getbase(): int

Return `RobloxPlayerBeta.exe` base address.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions#memory_write)

memory\_write

Ensure both memory address and address value are the correct type before writing to it. Improper usage may cause unexpected and dangerous behavior

Copy

    memory_write(memoryType: string, address: int, value: Any): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions#memory_read)

memory\_read

Copy

    memory_read(memoryType: string, address: int): Any

[PreviousMiscellaneous Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions)
[NextClasses](https://matcha-latte.gitbook.io/matcha/luau-environment/classes)

Last updated 6 months ago

---

# BasePart | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#size)

Size

Copy

    BasePart.Size: Vector3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#position)

Position

Copy

    BasePart.Position: Vector3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#transparency)

Transparency

Copy

    BasePart.Transparency: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#transparency-1)

Color

Copy

    BasePart.Color: Color3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#transparency-2)

Velocity

Copy

    BasePart.Velocity: Vector3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#transparency-3)

AssemblyLinearVelocity

Copy

    BasePart.AssemblyLinearVelocity: Vector3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart#cancollide)

CanCollide

Copy

    BasePart.CanCollide: bool

[PreviousClasses](https://matcha-latte.gitbook.io/matcha/luau-environment/classes)
[NextCamera](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera)

Last updated 6 months ago

---

# Camera | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#properties)

Constructors

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#size)

lookAt

Copy

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

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#properties-1)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#viewportsize)

ViewportSize

Copy

    Camera.ViewportSize: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#fieldofview)

FieldOfView

Copy

    Camera.FieldOfView: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera#position)

Position

Copy

    Camera.Position: Vector3

[PreviousBasePart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart)
[NextDataModel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel)

Last updated 6 months ago

---

# DataModel | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#placeid)

PlaceId

Copy

    Instance.PlaceId: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#gameid)

GameId

Copy

    Instance.GameId: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#jobid)

JobId

Copy

    Instance.JobId: string

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#methods)

Methods

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#httpget)

HttpGet

Copy

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

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel#getservice)

GetService

Copy

    function DataModel:GetService(name: string): Instance

[PreviousCamera](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera)
[NextHttpGet Service](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service)

Last updated 6 months ago

---

# Model | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model#primarypart)

PrimaryPart

Copy

    Model.PrimaryPart: BasePart

[PreviousHumanoid](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid)
[NextWorkspace](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace)

Last updated 6 months ago

---

# Workspace | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace#currentcamera)

CurrentCamera

Copy

    Workspace.CurrentCamera: Camera

[PreviousModel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model)
[NextInstance](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance)

Last updated 8 months ago

---

# Humanoid | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid#maxhealth)

MaxHealth

Copy

    Humanoid.MaxHealth: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid#health)

Health

Copy

    Humanoid.Health: number

[PreviousHttpGet Service](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service)
[NextModel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model)

Last updated 8 months ago

---

# HttpGet Service | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service.md)
.

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service#httpget)

HttpGet

Copy

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

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service#getservice)

JSONEncode

Copy

    function HttpService:JSONEncode(tbl: table): string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service#getservice-1)

JSONDecode

Copy

    function HttpService:JSONDecode(str: string): table

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service#getservice-2)

GenerateGUID

Copy

    function HttpService:GenerateGUID(): string

[PreviousDataModel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel)
[NextHumanoid](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid)

Last updated 6 months ago

---

# ValueBase | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase.md)
.

`ObjectValue`, `Color3Value`, `NumberValue`, `IntValue`, `FloatValue`, `BoolValue`, and `StringValue` all inherit from this class. For simplicity, they do not have separate sub-pages.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase#value)

Value

Copy

    ValueBase.Value: any

[PreviousPlayer](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player)
[NextGuiObject](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject)

Last updated 8 months ago

---

# Mouse | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse#primarypart)

Mouse

Copy

    Mouse.X: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse#primarypart-1)

Mouse

Copy

    Mouse.Y: number

[PreviousInstance](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance)
[NextPlayers](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players)

Last updated 8 months ago

---

# Dataypes | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes.md)
.

[Vector3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3)
[Vector2](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2)
[Color3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3)

[PreviousUserInputService](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice)
[NextVector3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3)

---

# Vector3 | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3.md)
.

The [Vector3](https://create.roblox.com/docs/reference/engine/datatypes/Vector3)
 data type represents a vector in 3D space, typically used as a point in 3D space or the dimensions of a rectangular prism.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#properties)

Constructors

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#size)

new

Copy

    Vector3.new(x : number, y : number, z : number)

Returns a new [Vector3](https://create.roblox.com/docs/reference/engine/datatypes/Vector3)
 from the given x, y, and z components.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#properties-1)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#size-1)

X

Copy

    Vector3.X: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#size-2)

Y

Copy

    Vector3.Y: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3#size-3)

Z

Copy

    Vector3.Z: number

[PreviousDataypes](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes)
[NextVector2](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2)

Last updated 8 months ago

---

# Vector2 | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2.md)
.

The [Vector2](https://create.roblox.com/docs/reference/engine/datatypes/Vector2)
 data type represents a 2D value with direction and magnitude. Some applications include GUI elements and 2D mouse positions.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2#properties)

Constructors

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2#size)

new

Copy

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

Returns a [Vector2](https://create.roblox.com/docs/reference/engine/datatypes/Vector2)
 from the given x and y components.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2#properties-1)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2#size-1)

X

Copy

    Vector2.X: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2#size-2)

Y

Copy

    Vector2.Y: number

[PreviousVector3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3)
[NextColor3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3)

Last updated 8 months ago

---

# TextLabel | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel#properties)

Properties

Copy

    TextLabel.Text: string

[PreviousGuiObject](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject)
[NextMeshPart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart)

Last updated 8 months ago

---

# Players | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players#localplayer)

LocalPlayer

Copy

    Players.LocalPlayer: Player

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players#localplayer-1)

GetPlayers

Copy

    function Players:GetPlayers(): Table

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players#playeradded)

PlayerAdded


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

Copy

    Players.PlayerAdded:Connect(function(player))

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players#playerremoving)

PlayerRemoving


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

Copy

    Players.PlayerRemoving:Connect(function(player))

[PreviousMouse](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse)
[NextPlayer](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player)

Last updated 6 months ago

---

# Player | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#localplayer)

Character

Copy

    Player.Character: Model

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#team)

Team

Copy

    Player.Team: Team

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#methods)

Methods

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#httpget)

GetMouse

Copy

    function Player:GetMouse(): Mouse

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player#httpget-1)

GetPlayers

Copy

    function Players:GetPlayers(): table

[PreviousPlayers](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players)
[NextValueBase](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase)

Last updated 6 months ago

---

# Instance | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#name)

Name

Copy

    Instance.Name: string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#classname)

ClassName

Copy

    Instance.ClassName: string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#parent)

Parent

Copy

    Instance.Parent: Instance

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#data)

Address

Copy

    Instance.Address: number

Hexadecimal number representing the Instance’s memory address.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#methods)

Methods

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#findfirstchildofclass)

FindFirstChildOfClass

Copy

    function Instance:FindFirstChildOfClass(name: string): Instance

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#findfirstchild)

FindFirstChild

Copy

    function Instance:FindFirstChild(name: string): Instance

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#findfirstchild-1)

IsA

Copy

    function Instance:IsA(name: string): boolean

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#findfirstchild-2)

GetFullName

Copy

    function Instance:GetFullName(): string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getchildren)

GetChildren

Copy

    function Instance:GetChildren(): { Instance }

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getattribute)

GetAttribute

Copy

    function Instance:GetAttribute(name: string): any

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getattributes)

GetAttributes

Copy

    function Instance:GetAttributes(): { string }

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#setattribute)

SetAttribute

Copy

    function Instance:SetAttribute(name: string, value: any): nil

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getdescendants)

GetDescendants

Copy

    function Instance:GetDescendants(): { Instance }

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getdescendants-1)

IsDescendantOf

Copy

    function Instance:IsDescendantOf(parent: Instance): boolean

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#getdescendants-2)

FindFirstChildWhichIsA

Copy

    function Instance:FindFirstChildWhichIsA(class: string): Instance

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance#waitforchild)

WaitForChild

Copy

    function Instance:WaitForChild(name: string): Instance

[PreviousWorkspace](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace)
[NextMouse](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse)

Last updated 6 months ago

---

# MeshPart | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart#textureid)

TextureId

Copy

    MeshPart.TextureId: string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart#meshid)

MeshId

Copy

    MeshPart.MeshId: string

[PreviousTextLabel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel)
[NextUserInputService](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice)

Last updated 6 months ago

---

# GuiObject | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject#properties)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject#absolutesize)

AbsoluteSize

Copy

    GuiObject.AbsoluteSize: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject#absoluteposition)

AbsolutePosition

Copy

    GuiObject.AbsolutePosition: Vector2

[PreviousValueBase](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase)
[NextTextLabel](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel)

Last updated 8 months ago

---

# UserInputService | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice.md)
.

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice#userinputservice)

UserInputService


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

Copy

    local UserInputService = game:GetService("UserInputService")

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice#inputbegan)

InputBegan


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

Copy

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

[](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice#inputended)

InputEnded


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

Copy

    UserInputService.InputEnded:Connect(function(input: InputObject, gameProcessed: boolean))

[PreviousMeshPart](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart)
[NextDataypes](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes)

Last updated 6 months ago

---

# Drawing | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing.md)
.

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing#example-code)

Example code

The following snippet will display a red square on the user's screen for 5 seconds.

Copy

    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()

[PreviousColor3](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3)
[NextDrawing](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing)

Last updated 6 months ago

---

# Color3 | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3.md)
.

The [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 data type describes a color using red, green, and blue components in the range of 0 to 1. Unlike the [BrickColor](https://create.roblox.com/docs/reference/engine/datatypes/BrickColor)
 data type which describes named colors, [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 is used for precise coloring of objects on screen through properties like [BasePart.Color](https://create.roblox.com/docs/reference/engine/classes/BasePart#Color)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#properties)

Constructors

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size)

new

Copy

    Color3.new(red: number, green: number, blue: number)

Returns a [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 with the given red, green, and blue values.

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-1)

fromRGB

Copy

    Color3.fromRGB(red: number, green: number, blue: number)

Returns a [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 from given components within the range of 0 to 255.

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-2)

fromHSV

Copy

    Color3.fromHSV(hue: number, saturation: number, value: number)

Returns a [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 from the given hue, saturation, and value components.

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-3)

fromHex

Copy

    Color3.fromHex(hex: string)

Returns a [Color3](https://create.roblox.com/docs/reference/engine/datatypes/Color3)
 from a given hex value.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#properties-1)

Properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-4)

R

Copy

    Color3.R: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-5)

G

Copy

    Color3.G: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3#size-6)

B

Copy

    Color3.B: number

[PreviousVector2](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2)
[NextDrawing](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing)

Last updated 8 months ago

---

# Drawing | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing#constructors)

Constructors

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing#new)

new

Copy

    Drawing.new(drawingType: string): DrawingObject

`drawingType` must be one of the following types:

*   Square
    
*   Line
    
*   Circle
    
*   Text
    
*   Triangle
    

[PreviousDrawing](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing)
[NextDrawingObject](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject)

Last updated 6 months ago

---

# Fonts | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts.md)
.

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts#fonts)

Fonts


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

Copy

    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

[PreviousDrawingObject](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject)

Last updated 6 months ago

---

# DrawingObject | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject.md)
.

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#methods)

Methods

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#remove)

Remove

Copy

    function DrawingObject:Remove(): nil

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#base-properties)

Base properties

Shared set of properties across all `DrawingObject` types

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#color)

Color

Copy

    DrawingObject.Color: Color3

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#transparency)

Transparency

Copy

    DrawingObject.Transparency: number

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#visible)

Visible

Copy

    DrawingObject.Visible: bool

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#position)

Position

Copy

    DrawingObject.Position: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#zindex)

ZIndex

Copy

    DrawingObject.ZIndex: int

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#square-properties)

Square properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#size)

Size

Copy

    DrawingObject.Size: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#filled)

Filled

Copy

    DrawingObject.Filled: bool

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#line-properties)

Line properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#from)

From

Copy

    DrawingObject.From: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#to)

To

Copy

    DrawingObject.To: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#thickness)

Thickness

Copy

    DrawingObject.Thickness: int

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#circle-properties)

Circle properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#radius)

Radius

Copy

    DrawingObject.Radius: float

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#numsides)

NumSides

Copy

    DrawingObject.NumSides: int

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#thickness-1)

Thickness

Copy

    DrawingObject.Thickness: int

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#text-properties)

Text properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#text)

Text

Copy

    DrawingObject.Text: string

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#outline)

Outline

Copy

    DrawingObject.Outline: bool

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#center)

Center

Copy

    DrawingObject.Center: bool

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#font)

Font

Copy

    DrawingObject.Font: Font

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#fontsize)

FontSize

Copy

    DrawingObject.Size: Int

### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#triangle-properties)

Triangle properties

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#pointa)

PointA

Copy

    DrawingObject.PointA: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#pointb)

PointB

Copy

    DrawingObject.PointB: Vector2

#### 

[](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject#pointc)

PointC

Copy

    DrawingObject.PointC: Vector2

[PreviousDrawing](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing)
[NextFonts](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts)

Last updated 6 months ago

---

# Unknown

\# Matcha

## Docs

- \[Getting Started\](https://matcha-latte.gitbook.io/matcha/introduction/getting-started.md)
- \[Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions.md)
- \[Globals Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions.md)
- \[Console Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions.md)
- \[Input Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions.md): List of key codes can be found here: https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
- \[Miscellaneous Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions.md)
- \[Memory Functions\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions.md)
- \[Classes\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes.md)
- \[BasePart\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart.md): https://create.roblox.com/docs/reference/engine/classes/BasePart
- \[Camera\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera.md): https://create.roblox.com/docs/reference/engine/classes/Camera
- \[DataModel\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel.md): https://create.roblox.com/docs/reference/engine/classes/DataModel
- \[HttpGet Service\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service.md)
- \[Humanoid\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid.md): https://create.roblox.com/docs/reference/engine/classes/Humanoid
- \[Model\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model.md): https://create.roblox.com/docs/reference/engine/classes/Model
- \[Workspace\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace.md): https://create.roblox.com/docs/reference/engine/classes/Workspace
- \[Instance\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance.md): https://create.roblox.com/docs/reference/engine/classes/Instance
- \[Mouse\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse.md): https://create.roblox.com/docs/reference/engine/classes/Mouse
- \[Players\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players.md): https://create.roblox.com/docs/reference/engine/classes/Players
- \[Player\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player.md): https://create.roblox.com/docs/reference/engine/classes/Player
- \[ValueBase\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase.md): https://create.roblox.com/docs/reference/engine/classes/ValueBase
- \[GuiObject\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject.md): https://create.roblox.com/docs/reference/engine/classes/GuiObject
- \[TextLabel\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel.md): https://create.roblox.com/docs/reference/engine/classes/TextLabel
- \[MeshPart\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart.md): https://create.roblox.com/docs/reference/engine/classes/MeshPart
- \[UserInputService\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice.md)
- \[Dataypes\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes.md)
- \[Vector3\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3.md): https://create.roblox.com/docs/reference/engine/datatypes/Vector3
- \[Vector2\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2.md): https://create.roblox.com/docs/reference/engine/datatypes/Vector2
- \[Color3\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3.md)
- \[Drawing\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing.md)
- \[Drawing\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing.md)
- \[DrawingObject\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject.md)
- \[Fonts\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the \`ask\` query parameter:
\`\`\`
GET https://matcha-latte.gitbook.io/matcha/introduction/getting-started.md?ask=<question>
\`\`\`
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/introduction/getting-started.md).

# Getting Started

This is the documentation for the Matcha LuaVM. Please note that the \*\*LuaVM is not an executor, it does not internally hook any functions in the Roblox engine\*\*. Instead it tries to emulate those functions externally. This makes it completely undetected, but also means it lacks direct access to internal Roblox API functions.

### Resources

To understand how the LuaVM works, you first need to understand the basics of Lua(U). For that, visit lua.org


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/introduction/getting-started.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions.md).

# Functions

## Overview

This article, and it's sub-pages document how to use functions built in Matcha.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions.md).

# Console Functions

### print / printl

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

### warn

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

### error

\`\`\`lua
function error(message: string)
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions/console-functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions.md).

# Globals Functions

### loadstring / load

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

Loads \`chunk\` as a Lua function and returns it if compilation is successful. Otherwise, if an error has occurred during compilation, nil followed by the error message will be returned.

### decompile

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

Decompiles \`Script\` and returns the decompiled script. If the decompilation fails, then notify an error message.

### WorldToScreen

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

### notify

\`\`\`lua
function notify(message: string, title: string, duration: number)
\`\`\`

Sends a Matcha notification with a message, title, and duration in seconds

### identifyexecutor

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

Returns "Matcha" and version

### getscripthash

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

Returns FNV-1a 64-bit hash of bytecode

### getgetname

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

Returns the game name

### getscripts

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

Returns all script instances

### getscriptbytecode

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

Returns the raw bytecode of a script

### base64encode

\`\`\`lua
function base64encode(data: string): string
\`\`\`

Encodes a string to Base64 format

### base64decode

\`\`\`lua
function base64decode(data: string): string
\`\`\`

Decodes a Base64 string back to normal string


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes.md).

# Classes

- \[BasePart\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart.md): https://create.roblox.com/docs/reference/engine/classes/BasePart
- \[Camera\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera.md): https://create.roblox.com/docs/reference/engine/classes/Camera
- \[DataModel\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel.md): https://create.roblox.com/docs/reference/engine/classes/DataModel
- \[HttpGet Service\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service.md)
- \[Humanoid\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid.md): https://create.roblox.com/docs/reference/engine/classes/Humanoid
- \[Model\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model.md): https://create.roblox.com/docs/reference/engine/classes/Model
- \[Workspace\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace.md): https://create.roblox.com/docs/reference/engine/classes/Workspace
- \[Instance\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance.md): https://create.roblox.com/docs/reference/engine/classes/Instance
- \[Mouse\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse.md): https://create.roblox.com/docs/reference/engine/classes/Mouse
- \[Players\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players.md): https://create.roblox.com/docs/reference/engine/classes/Players
- \[Player\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player.md): https://create.roblox.com/docs/reference/engine/classes/Player
- \[ValueBase\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase.md): https://create.roblox.com/docs/reference/engine/classes/ValueBase
- \[GuiObject\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject.md): https://create.roblox.com/docs/reference/engine/classes/GuiObject
- \[TextLabel\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel.md): https://create.roblox.com/docs/reference/engine/classes/TextLabel
- \[MeshPart\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart.md): https://create.roblox.com/docs/reference/engine/classes/MeshPart
- \[UserInputService\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions.md).

# Miscellaneous Functions

### run\\\_secure

\`\`\`lua
function run\_secure(text: string)
\`\`\`

Run protected code.

{% hint style="warning" %}
Code protection is not available to the public!
{% endhint %}

### Set Fast Flag <a href="#set-fast-flag" id="set-fast-flag"></a>

\`\`\`lua
function setfflag(FFlag: string, value: string)
\`\`\`

Sets \`FFlag\` with \`Value\`.&#x20;

{% hint style="danger" %}
This function is not complete!
{% endhint %}

### Get Fast Flag <a href="#set-fast-flag" id="set-fast-flag"></a>

\`\`\`lua
function getfflag(FFlag: string)
\`\`\`

Sets \`FFlag\` with \`Value\`.&#x20;

{% hint style="danger" %}
This function is not complete!
{% endhint %}

### require

{% hint style="info" %}
Require only accepts files ending with \`.lua\` and \`.luau\`
{% endhint %}

\`\`\`lua
function require(path: string): table
\`\`\`

### wait

\`\`\`lua
function wait(time: number)
\`\`\`

### spawn

\`\`\`lua
function spawn(target: function): nil
\`\`\`

### task.spawn

\`\`\`lua
function task.spawn(target: function): nil
\`\`\`

### task.wait

\`\`\`lua
function task.wait(time: number)
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions/miscellaneous-functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions.md).

# Input Functions

### setrobloxinput

\`\`\`lua
function setrobloxinput(state: boolean): nil
\`\`\`

This function toggles sending inputs to the game.

### isrbxactive

\`\`\`lua
function isrbxactive(): bool
\`\`\`

This function will return if your current window is Roblox.

### setclipboard

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

### keyrelease

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

### keypress

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

### iskeypressed

\`\`\`lua
function iskeypressed(keycode: int): bool
\`\`\`

### ismouse1pressed

\`\`\`lua
function ismouse1pressed(): bool
\`\`\`

### ismouse2pressed

\`\`\`lua
function ismouse2pressed(): bool
\`\`\`

### mouse1press

\`\`\`lua
function mouse1press(): nil
\`\`\`

### mouse1release

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

### mouse1click

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

### mouse2press

\`\`\`lua
function mouse2press(): nil
\`\`\`

### mouse2release

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

### mouse2click

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

### mousemoveabs

\`\`\`lua
function mousemoveabs(x: int, y: int): nil
\`\`\`

### mousemoverel

\`\`\`lua
function mousemoverel(x: int, y: int): nil
\`\`\`

### mousescroll

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions/input-functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions.md).

# Memory Functions

{% hint style="warning" %}
&#x20;You must allow unsafe LuaU execution before using these functions
{% endhint %}

### Memory Types

<table><thead><tr><th valign="middle">Memory Types</th><th>Returns</th></tr></thead><tbody><tr><td valign="middle">int</td><td>int</td></tr><tr><td valign="middle">float</td><td>number</td></tr><tr><td valign="middle">double</td><td>number</td></tr><tr><td valign="middle">byte</td><td>int</td></tr><tr><td valign="middle">string</td><td>string</td></tr><tr><td valign="middle">uintptr\_t</td><td>int</td></tr></tbody></table>

### getbase <a href="#set-fast-flag" id="set-fast-flag"></a>

\`\`\`lua
function getbase(): int
\`\`\`

Return \`RobloxPlayerBeta.exe\` base address.

### memory\\\_write

{% hint style="danger" %}
Ensure both memory address and address value are the correct type before writing to it. Improper usage may cause unexpected and dangerous behavior
{% endhint %}

\`\`\`lua
memory\_write(memoryType: string, address: int, value: Any): nil
\`\`\`

### memory\\\_read

\`\`\`lua
memory\_read(memoryType: string, address: int): Any
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/functions/memory-functions.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart.md).

# BasePart

### Properties <a href="#properties" id="properties"></a>

#### Size <a href="#size" id="size"></a>

\`\`\`
BasePart.Size: Vector3
\`\`\`

#### Position <a href="#position" id="position"></a>

\`\`\`
BasePart.Position: Vector3
\`\`\`

#### Transparency <a href="#transparency" id="transparency"></a>

\`\`\`
BasePart.Transparency: number
\`\`\`

#### Color <a href="#transparency" id="transparency"></a>

\`\`\`lua
BasePart.Color: Color3
\`\`\`

#### Velocity <a href="#transparency" id="transparency"></a>

\`\`\`
BasePart.Velocity: Vector3
\`\`\`

#### AssemblyLinearVelocity <a href="#transparency" id="transparency"></a>

\`\`\`
BasePart.AssemblyLinearVelocity: Vector3
\`\`\`

#### CanCollide <a href="#cancollide" id="cancollide"></a>

\`\`\`
BasePart.CanCollide: bool
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/basepart.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Functions | Matcha

For the complete documentation index, see [llms.txt](https://matcha-latte.gitbook.io/matcha/llms.txt)
. This page is also available as [Markdown](https://matcha-latte.gitbook.io/matcha/luau-environment/functions.md)
.

[](https://matcha-latte.gitbook.io/matcha/luau-environment#overview)

Overview


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

This article, and it's sub-pages document how to use functions built in Matcha.

[PreviousGetting Started](https://matcha-latte.gitbook.io/matcha)
[NextGlobals Functions](https://matcha-latte.gitbook.io/matcha/luau-environment/functions/globals-functions)

Last updated 6 months ago

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera.md).

# Camera

### Constructors <a href="#properties" id="properties"></a>

#### lookAt <a href="#size" id="size"></a>

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

### Properties <a href="#properties" id="properties"></a>

#### ViewportSize <a href="#viewportsize" id="viewportsize"></a>

\`\`\`
Camera.ViewportSize: Vector2
\`\`\`

#### FieldOfView <a href="#fieldofview" id="fieldofview"></a>

\`\`\`
Camera.FieldOfView: number
\`\`\`

#### Position <a href="#position" id="position"></a>

\`\`\`
Camera.Position: Vector3
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/camera.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel.md).

# DataModel

### Properties <a href="#properties" id="properties"></a>

#### PlaceId <a href="#placeid" id="placeid"></a>

\`\`\`
Instance.PlaceId: number
\`\`\`

#### GameId <a href="#gameid" id="gameid"></a>

\`\`\`
Instance.GameId: number
\`\`\`

#### JobId <a href="#jobid" id="jobid"></a>

\`\`\`
Instance.JobId: string
\`\`\`

### Methods <a href="#methods" id="methods"></a>

#### HttpGet <a href="#httpget" id="httpget"></a>

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

#### GetService <a href="#getservice" id="getservice"></a>

\`\`\`lua
function DataModel:GetService(name: string): Instance
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/datamodel.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace.md).

# Workspace

### Properties <a href="#properties" id="properties"></a>

#### CurrentCamera <a href="#currentcamera" id="currentcamera"></a>

\`\`\`
Workspace.CurrentCamera: Camera
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/workspace.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2.md).

# Vector2

The \[Vector2\](https://create.roblox.com/docs/reference/engine/datatypes/Vector2) data type represents a 2D value with direction and magnitude. Some applications include GUI elements and 2D mouse positions.

### Constructors <a href="#properties" id="properties"></a>

#### new <a href="#size" id="size"></a>

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

Returns a \[Vector2\](https://create.roblox.com/docs/reference/engine/datatypes/Vector2) from the given x and y components.

### Properties <a href="#properties" id="properties"></a>

#### X <a href="#size" id="size"></a>

\`\`\`lua
Vector2.X: number
\`\`\`

#### Y <a href="#size" id="size"></a>

\`\`\`lua
Vector2.Y: number
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model.md).

# Model

### Properties <a href="#properties" id="properties"></a>

#### PrimaryPart <a href="#primarypart" id="primarypart"></a>

\`\`\`
Model.PrimaryPart: BasePart
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/model.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid.md).

# Humanoid

### Properties <a href="#properties" id="properties"></a>

#### MaxHealth <a href="#maxhealth" id="maxhealth"></a>

\`\`\`
Humanoid.MaxHealth: number
\`\`\`

#### Health <a href="#health" id="health"></a>

\`\`\`
Humanoid.Health: number
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/humanoid.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service.md).

# HttpGet Service

#### HttpGet <a href="#httpget" id="httpget"></a>

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

#### JSONEncode <a href="#getservice" id="getservice"></a>

\`\`\`lua
function HttpService:JSONEncode(tbl: table): string
\`\`\`

#### JSONDecode <a href="#getservice" id="getservice"></a>

\`\`\`lua
function HttpService:JSONDecode(str: string): table
\`\`\`

#### GenerateGUID <a href="#getservice" id="getservice"></a>

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/httpget-service.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse.md).

# Mouse

### Properties <a href="#properties" id="properties"></a>

#### Mouse <a href="#primarypart" id="primarypart"></a>

\`\`\`
Mouse.X: number
\`\`\`

#### Mouse <a href="#primarypart" id="primarypart"></a>

\`\`\`
Mouse.Y: number
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/mouse.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase.md).

# ValueBase

\`ObjectValue\`, \`Color3Value\`, \`NumberValue\`, \`IntValue\`, \`FloatValue\`, \`BoolValue\`, and \`StringValue\` all inherit from this class. For simplicity, they do not have separate sub-pages.

### Properties <a href="#properties" id="properties"></a>

#### Value <a href="#value" id="value"></a>

\`\`\`
ValueBase.Value: any
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/valuebase.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart.md).

# MeshPart

### Properties

#### TextureId

\`\`\`lua
MeshPart.TextureId: string
\`\`\`

#### MeshId

\`\`\`lua
MeshPart.MeshId: string
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/meshpart.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance.md).

# Instance

### Properties <a href="#properties" id="properties"></a>

#### Name <a href="#name" id="name"></a>

\`\`\`lua
Instance.Name: string
\`\`\`

#### ClassName <a href="#classname" id="classname"></a>

\`\`\`lua
Instance.ClassName: string
\`\`\`

#### Parent <a href="#parent" id="parent"></a>

\`\`\`lua
Instance.Parent: Instance
\`\`\`

#### Address <a href="#data" id="data"></a>

\`\`\`lua
Instance.Address: number
\`\`\`

Hexadecimal number representing the Instance’s memory address.

### Methods <a href="#methods" id="methods"></a>

#### FindFirstChildOfClass <a href="#findfirstchildofclass" id="findfirstchildofclass"></a>

\`\`\`lua
function Instance:FindFirstChildOfClass(name: string): Instance
\`\`\`

#### FindFirstChild <a href="#findfirstchild" id="findfirstchild"></a>

\`\`\`lua
function Instance:FindFirstChild(name: string): Instance
\`\`\`

#### IsA <a href="#findfirstchild" id="findfirstchild"></a>

\`\`\`lua
function Instance:IsA(name: string): boolean
\`\`\`

#### GetFullName <a href="#findfirstchild" id="findfirstchild"></a>

\`\`\`lua
function Instance:GetFullName(): string
\`\`\`

#### GetChildren <a href="#getchildren" id="getchildren"></a>

\`\`\`lua
function Instance:GetChildren(): { Instance }
\`\`\`

#### GetAttribute <a href="#getattribute" id="getattribute"></a>

\`\`\`lua
function Instance:GetAttribute(name: string): any
\`\`\`

#### GetAttributes <a href="#getattributes" id="getattributes"></a>

\`\`\`lua
function Instance:GetAttributes(): { string }
\`\`\`

#### SetAttribute <a href="#setattribute" id="setattribute"></a>

\`\`\`lua
function Instance:SetAttribute(name: string, value: any): nil
\`\`\`

#### GetDescendants <a href="#getdescendants" id="getdescendants"></a>

\`\`\`lua
function Instance:GetDescendants(): { Instance }
\`\`\`

#### IsDescendantOf <a href="#getdescendants" id="getdescendants"></a>

\`\`\`lua
function Instance:IsDescendantOf(parent: Instance): boolean
\`\`\`

#### FindFirstChildWhichIsA <a href="#getdescendants" id="getdescendants"></a>

\`\`\`lua
function Instance:FindFirstChildWhichIsA(class: string): Instance
\`\`\`

#### WaitForChild <a href="#waitforchild" id="waitforchild"></a>

\`\`\`lua
function Instance:WaitForChild(name: string): Instance
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/instance.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3.md).

# Vector3

The \[Vector3\](https://create.roblox.com/docs/reference/engine/datatypes/Vector3) data type represents a vector in 3D space, typically used as a point in 3D space or the dimensions of a rectangular prism.

### Constructors <a href="#properties" id="properties"></a>

#### new <a href="#size" id="size"></a>

\`\`\`lua
Vector3.new(x : number, y : number, z : number)
\`\`\`

Returns a new \[Vector3\](https://create.roblox.com/docs/reference/engine/datatypes/Vector3) from the given x, y, and z components.

### Properties <a href="#properties" id="properties"></a>

#### X <a href="#size" id="size"></a>

\`\`\`lua
Vector3.X: number
\`\`\`

#### Y <a href="#size" id="size"></a>

\`\`\`lua
Vector3.Y: number
\`\`\`

#### Z <a href="#size" id="size"></a>

\`\`\`lua
Vector3.Z: number
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player.md).

# Player

### Properties <a href="#properties" id="properties"></a>

#### Character <a href="#localplayer" id="localplayer"></a>

\`\`\`
Player.Character: Model
\`\`\`

#### Team

\`\`\`lua
Player.Team: Team
\`\`\`

### Methods <a href="#methods" id="methods"></a>

#### GetMouse <a href="#httpget" id="httpget"></a>

\`\`\`lua
function Player:GetMouse(): Mouse
\`\`\`

#### GetPlayers <a href="#httpget" id="httpget"></a>

\`\`\`lua
function Players:GetPlayers(): table
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/player.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes.md).

# Dataypes

- \[Vector3\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector3.md): https://create.roblox.com/docs/reference/engine/datatypes/Vector3
- \[Vector2\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/vector2.md): https://create.roblox.com/docs/reference/engine/datatypes/Vector2
- \[Color3\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject.md).

# GuiObject

### Properties

#### AbsoluteSize

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

#### AbsolutePosition

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/guiobject.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice.md).

# UserInputService

## UserInputService

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

## InputBegan

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

## InputEnded

\`\`\`luau
UserInputService.InputEnded:Connect(function(input: InputObject, gameProcessed: boolean))
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/userinputservice.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject.md).

# DrawingObject

### Methods

#### Remove

\`\`\`lua
function DrawingObject:Remove(): nil
\`\`\`

### Base properties

Shared set of properties across all \`DrawingObject\` types

#### Color

\`\`\`lua
DrawingObject.Color: Color3
\`\`\`

#### Transparency

\`\`\`lua
DrawingObject.Transparency: number
\`\`\`

#### Visible

\`\`\`lua
DrawingObject.Visible: bool
\`\`\`

#### Position

\`\`\`lua
DrawingObject.Position: Vector2
\`\`\`

#### ZIndex

\`\`\`lua
DrawingObject.ZIndex: int
\`\`\`

### Square properties

#### Size

\`\`\`lua
DrawingObject.Size: Vector2
\`\`\`

#### Filled

\`\`\`lua
DrawingObject.Filled: bool
\`\`\`

### Line properties

#### From

\`\`\`lua
DrawingObject.From: Vector2
\`\`\`

#### To

\`\`\`lua
DrawingObject.To: Vector2
\`\`\`

#### Thickness

\`\`\`lua
DrawingObject.Thickness: int
\`\`\`

### Circle properties

#### Radius

\`\`\`lua
DrawingObject.Radius: float
\`\`\`

#### NumSides

\`\`\`lua
DrawingObject.NumSides: int
\`\`\`

#### Thickness

\`\`\`lua
DrawingObject.Thickness: int
\`\`\`

### Text properties

#### Text

\`\`\`lua
DrawingObject.Text: string
\`\`\`

#### Outline

\`\`\`lua
DrawingObject.Outline: bool
\`\`\`

#### Center

\`\`\`lua
DrawingObject.Center: bool
\`\`\`

#### Font

\`\`\`lua
DrawingObject.Font: Font
\`\`\`

#### FontSize

\`\`\`lua
DrawingObject.Size: Int
\`\`\`

### Triangle properties

#### PointA

\`\`\`lua
DrawingObject.PointA: Vector2
\`\`\`

#### PointB

\`\`\`lua
DrawingObject.PointB: Vector2
\`\`\`

#### PointC

\`\`\`
DrawingObject.PointC: Vector2
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawingobject.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3.md).

# Color3

The \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) data type describes a color using red, green, and blue components in the range of 0 to 1. Unlike the \[BrickColor\](https://create.roblox.com/docs/reference/engine/datatypes/BrickColor) data type which describes named colors, \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) is used for precise coloring of objects on screen through properties like \[BasePart.Color\](https://create.roblox.com/docs/reference/engine/classes/BasePart#Color).

### Constructors <a href="#properties" id="properties"></a>

#### new <a href="#size" id="size"></a>

\`\`\`lua
Color3.new(red: number, green: number, blue: number)
\`\`\`

Returns a \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) with the given red, green, and blue values.

#### fromRGB <a href="#size" id="size"></a>

\`\`\`lua
Color3.fromRGB(red: number, green: number, blue: number)
\`\`\`

Returns a \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) from given components within the range of 0 to 255.

#### fromHSV <a href="#size" id="size"></a>

\`\`\`lua
Color3.fromHSV(hue: number, saturation: number, value: number)
\`\`\`

Returns a \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) from the given hue, saturation, and value components.

#### fromHex <a href="#size" id="size"></a>

\`\`\`lua
Color3.fromHex(hex: string)
\`\`\`

Returns a \[Color3\](https://create.roblox.com/docs/reference/engine/datatypes/Color3) from a given hex value.

### Properties <a href="#properties" id="properties"></a>

#### R <a href="#size" id="size"></a>

\`\`\`lua
Color3.R: number
\`\`\`

#### G <a href="#size" id="size"></a>

\`\`\`lua
Color3.G: number
\`\`\`

#### B <a href="#size" id="size"></a>

\`\`\`lua
Color3.B: number
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/dataypes/color3.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players.md).

# Players

### Properties <a href="#properties" id="properties"></a>

#### LocalPlayer <a href="#localplayer" id="localplayer"></a>

\`\`\`luau
Players.LocalPlayer: Player
\`\`\`

#### GetPlayers <a href="#localplayer" id="localplayer"></a>

\`\`\`luau
function Players:GetPlayers(): Table
\`\`\`

## PlayerAdded

\`\`\`luau
Players.PlayerAdded:Connect(function(player))
\`\`\`

## PlayerRemoving

\`\`\`luau
Players.PlayerRemoving:Connect(function(player))
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/players.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing.md).

# Drawing

#### Example code

The following snippet will display a red square on the user's screen for 5 seconds.

\`\`\`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()
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/drawing.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel.md).

# TextLabel

### Properties

\`\`\`lua
TextLabel.Text: string
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/classes/textlabel.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing.md).

# Drawing

### Constructors

#### new

\`\`\`lua
Drawing.new(drawingType: string): DrawingObject
\`\`\`

\`drawingType\` must be one of the following types:

\* Square
\* Line
\* Circle
\* Text
\* Triangle


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/drawing.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---

# Unknown

\> For the complete documentation index, see \[llms.txt\](https://matcha-latte.gitbook.io/matcha/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts.md).

# Fonts

## Fonts

\`\`\`
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
\`\`\`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the \`ask\` query parameter:

\`\`\`
GET https://matcha-latte.gitbook.io/matcha/luau-environment/drawing/fonts.md?ask=<question>
\`\`\`

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

---