AAtlas
Open navigation
Sign in
Atlas docs
Matcha
Matcha
Matcha/Reference/Classes

Classes

BasePart

https://create.roblox.com/docs/reference/engine/classes/BasePart

Properties

Size

lua
BasePart.Size: Vector3

Position

lua
BasePart.Position: Vector3

Transparency

lua
BasePart.Transparency: number

Color

lua
BasePart.Color: Color3

Velocity

lua
BasePart.Velocity: Vector3

AssemblyLinearVelocity

lua
BasePart.AssemblyLinearVelocity: Vector3

CanCollide

lua
BasePart.CanCollide: bool

CFrame

lua
BasePart.CFrame: CFrame

Verified against the live local player's HumanoidRootPart.

Camera

https://create.roblox.com/docs/reference/engine/classes/Camera

Properties

ViewportSize

lua
Camera.ViewportSize: Vector2

FieldOfView

lua
Camera.FieldOfView: number

Position

lua
Camera.Position: Vector3

CFrame

lua
Camera.CFrame: CFrame

CameraSubject

lua
Camera.CameraSubject: Instance

Verified to return the live camera subject.

Camera:WorldToScreenPoint and Camera:WorldToViewportPoint returned nil in Matcha 1.0.0. Use the global WorldToScreen(position) function for projection.

DataModel

https://create.roblox.com/docs/reference/engine/classes/DataModel

Properties

PlaceId

lua
Instance.PlaceId: number

GameId

lua
Instance.GameId: number

JobId

lua
Instance.JobId: string

Methods

IsLoaded

lua
function DataModel:IsLoaded(): boolean

Verified to return true in a running place.

HttpGet

lua
function DataModel:HttpGet(url: string, headers: table?): string

HttpPost

lua
function DataModel:HttpPost(url: string, data: string, contentType: string?, headers: table?): string

GetService

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

GetService exists, but the Matcha 1.0.0 audit only received a service for UserInputService. Requests for Workspace, Players, RunService, HttpService, ReplicatedStorage, Lighting, Teams, and the other audited services returned nil. Use the available globals such as workspace where applicable and nil-check service lookups.

HttpService

Methods

JSONEncode

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

JSONDecode

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

GenerateGUID

lua
function HttpService:GenerateGUID(): string

Humanoid

https://create.roblox.com/docs/reference/engine/classes/Humanoid

Properties

MaxHealth

lua
Humanoid.MaxHealth: number

Health

lua
Humanoid.Health: number

Model

https://create.roblox.com/docs/reference/engine/classes/Model

Properties

PrimaryPart

lua
Model.PrimaryPart: BasePart

Workspace

https://create.roblox.com/docs/reference/engine/classes/Workspace

Properties

CurrentCamera

lua
Workspace.CurrentCamera: Camera

Terrain

lua
Workspace.Terrain: Instance

Verified to return the live Terrain instance.

Methods

Raycast

lua
function Workspace:Raycast(origin: Vector3, direction: Vector3): RaycastResult?

Casts a ray from origin along direction and returns the first hit, or nil when nothing is hit.

Instance

https://create.roblox.com/docs/reference/engine/classes/Instance

Properties

Name

lua
Instance.Name: string

ClassName

lua
Instance.ClassName: string

Parent

lua
Instance.Parent: Instance

Address

lua
Instance.Address: number

Hexadecimal number representing the Instance’s memory address.

Methods

FindFirstChildOfClass

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

FindFirstChild

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

IsA

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

Do not use IsA for class filtering in Matcha 1.0.0. The audit observed both workspace:IsA("Workspace") and workspace:IsA("MeshPart") return true. Compare ClassName instead.

GetFullName

lua
function Instance:GetFullName(): string

GetChildren

lua
function Instance:GetChildren(): { Instance }

GetAttribute

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

GetAttributes

lua
function Instance:GetAttributes(): { string }

SetAttribute

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

GetDescendants

lua
function Instance:GetDescendants(): { Instance }

IsDescendantOf

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

FindFirstChildWhichIsA

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

WaitForChild

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

Mouse

https://create.roblox.com/docs/reference/engine/classes/Mouse

Properties

X

lua
Mouse.X: number

Y

lua
Mouse.Y: number

Players

https://create.roblox.com/docs/reference/engine/classes/Players

Properties

LocalPlayer

lua
Players.LocalPlayer: Player

GetPlayers

lua
function Players:GetPlayers(): Table

Events

PlayerAdded

lua
Players.PlayerAdded:Connect(function(player))

PlayerRemoving

lua
Players.PlayerRemoving:Connect(function(player))

Player

https://create.roblox.com/docs/reference/engine/classes/Player

Properties

Character

lua
Player.Character: Model

Team

lua
Player.Team: Team

UserId

lua
Player.UserId: number

Methods

GetMouse

lua
function Player:GetMouse(): Mouse

RemoteEvent

https://create.roblox.com/docs/reference/engine/classes/RemoteEvent

Methods

FireServer

lua
function RemoteEvent:FireServer(...: any): nil

Sends the supplied arguments to the server. This method is provided through Matcha's hybrid runtime.

RemoteEvent:FireServer only works when Hybrid is enabled in Matcha. If Hybrid is disabled, remote calls will not work.

RemoteFunction

https://create.roblox.com/docs/reference/engine/classes/RemoteFunction

Methods

InvokeFunction

lua
function RemoteFunction:InvokeFunction(...: any): any

Invokes the remote function through Matcha's hybrid runtime and returns its result.

RemoteFunction:InvokeFunction only works when Hybrid is enabled in Matcha. If Hybrid is disabled, remote calls will not work.

ValueBase

https://create.roblox.com/docs/reference/engine/classes/ValueBase

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

Properties

Value

lua
ValueBase.Value: any

GuiObject

https://create.roblox.com/docs/reference/engine/classes/GuiObject

Properties

AbsoluteSize

lua
GuiObject.AbsoluteSize: Vector2

AbsolutePosition

lua
GuiObject.AbsolutePosition: Vector2

TextLabel

https://create.roblox.com/docs/reference/engine/classes/TextLabel

Properties

Text

lua
TextLabel.Text: string

MeshPart

https://create.roblox.com/docs/reference/engine/classes/MeshPart

Properties

TextureID

lua
MeshPart.TextureID: string

Matcha uses the capitalized ID spelling. TextureId returned nil on the same live MeshPart.

MeshId

lua
MeshPart.MeshId: string

UserInputService

lua
local UserInputService = game:GetService("UserInputService")

Events

InputBegan

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

InputEnded

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

Methods

IsKeyDown

lua
function UserInputService:IsKeyDown(keyCode: EnumItem): boolean

The method is exposed as a function. The safe audit did not invoke it.

RunService

https://create.roblox.com/docs/reference/engine/classes/RunService

A global RunService proxy was present in the Matcha 1.0.0 audit, but its name was reported as Unreadable_name and the tested members returned nil.

RenderStepped, Heartbeat, Stepped, and every tested RunService method were unavailable in the audited build. Do not depend on them without retesting the exact Matcha runtime you are targeting.