we are awere of the black game bug
Build with BrickBit

LuX API reference

Find a global, library, service, class, datatype or enum. Choose where your script runs: available members and behavior can differ between the client, Studio and a hosted server.

Read the context before using an API

Client scripts handle local input, UI and world presentation. Studio runs local playtests and authoring tools. Hosted scripts own shared gameplay, persistence and messages to players. A service name in one context does not promise the same members in another.

Read properties with a dot (part.Position), call methods with a colon (workspace:GetChildren()), and call library functions with a dot (Vector3.new(0, 0, 4)). Event values support subscriptions such as Players.PlayerAdded:Connect(callback). A ? marks an optional parameter or a possibly absent result.

Client catalog 2026.9.23, Studio catalog 2026.9.23; hosted API 0.4.0. The reference describes this release. Older installed clients and running servers may expose fewer members.

The hosted catalog describes the game-manager runtime. The standalone native host is an opt-in preview with a separately tested subset; matching service names do not establish complete native gameplay parity.

Service-first migration · Practical examples · Script placement and delivery

Language limits and compatibility
desktopBulkEntries
100000
desktopSplitInputCodeUnits
1048576
portableBulkEntries
100000
portableUnpackResults
10000
portableStringUnits
1048576
unicodeScalars
100000
sharedKeysPerNamespace
1024
sharedKeyUnits
256
sharedValueDepth
16
sharedValueCount
16384
sharedRetainedNodes
4096
sharedNestedKeys
4096
sharedEncodedValueUnits
262144
sharedSessionUnits
4194304
strings
Client, Studio and hosted native string length/indexing use UTF-8 bytes. The desktop VM preserves incomplete byte fragments reversibly while retaining normal Unicode text for UI. Use unicode helpers for scalar-oriented operations.
globalScope
Each script retains its own normal globals. _G and shared are separate session-wide data namespaces across scripts in one Client, Studio or hosted runtime; they do not replicate or cross games. Session stop clears the stores and revokes old proxies.
sharedValues
Session-local live object graphs preserve nested table identity, aliases and cycles across script VMs. Nested writes are immediately readable by other scripts in the same runtime. Tables assigned into shared are adopted as proxies. Functions, threads and unsupported userdata remain rejected. This is not network replication or persistent storage.
sharedOperations
Indexed reads/writes, length, rawget/rawset, next/pairs/ipairs, and table clone/clear/find/insert/remove/sort/move/concat/unpack use the live graph. Session stop revokes proxies. Up to 4096 nodes are retained until session teardown so detached references remain valid.
unicode
unicode.len/char/codepoints/sub use Unicode scalar values on all runtimes and reject invalid UTF-8/UTF-16 and surrogate code points. They do not count grapheme clusters or normalize text. Native strings are byte-oriented on all runtimes.
random
Random.new explicit seeds produce the same Park-Miller gameplay stream across runtimes; seeds are finite exact-range numbers, floored and normalized modulo 2147483646. NextInteger supports inclusive int32 ranges; Clone copies state; NextUnitVector trigonometric rounding may differ slightly. Native math.random streams remain different. Not for secrets.
hostedLibraries
Global table.create/find/clone/clear/move/concat and table.unpack have portable entry/result limits. Global string.rep/split have portable output/input limits. Hosted native string method syntax such as value:rep resolves the readonly native metatable and does not use these wrappers. Other native library operations and operators are not newly bounded.
stringBudgetUnits
Portable string limits count UTF-8 bytes. Native Lua strings can contain arbitrary bytes, but JSONEncode, RPC values/map keys, StringValue/attributes, shared graphs and datastores require valid Unicode text and reject malformed byte strings; there is no binary network codec.
datatypes
NumberRange, UDim/UDim2, Vector2/Vector3 and CFrame are values. Hosted CFrame math uses the same Y-up center-space coordinates as desktop CFrames; legacy Bridge positions remain corner-based Z-up.
Globals Client

Values and functions available without retrieving a service. Constructor tables such as Vector3 are values; use their named functions.

Member Kind Description
game: DataModel # value Root of the game tree. Use game:GetService(name).
workspace: Workspace # value Shortcut for game:GetService("Workspace").
script: Script # value The running script. script.Parent is the owning brick.
task: task # value Task scheduler: wait, spawn, delay, defer, cancel. Scheduling returns a coroutine handle. Cancel your own suspended tasks; delay/defer always queue, including delay(0).
Enum: Enums # value Table of enum values (Material, KeyCode, ...).
wait(seconds: number?): number # function Yields the current thread for the given seconds (default 1/30). Returns elapsed time.
spawn(fn: function): void # function Runs fn on a new scheduled thread as soon as possible.
delay(seconds: number, fn: function): void # function Runs fn on a new scheduled thread after the given delay.
tick(): number # function Seconds since the engine started (monotonic game clock).
time(): number # function Alias of tick(); seconds since the engine started.
typeof(value: any): string # function Returns the datatype name of a value (Vector3, Color3, Instance, ...).
print(...: any): void # function Prints values to the output log.
warn(...: any): void # function Prints values to the output log as a warning.
Instance: Instance # value Instance.new(className). Part/Block/WedgePart/Truss/SpawnLocation/Seat/MeshPart/BasePart/Brick all make a brick; ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox make GUI elements; ParticleEmitter makes an emitter. Anything else becomes a generic tree node.
Vector2: Vector2 # value Vector2 datatype constructor table.
Vector3: Vector3 # value Vector3 datatype constructor table.
Color3: Color3 # value Color3 datatype constructor table.
CFrame: CFrame # value CFrame datatype constructor table (position + rotation).
UDim2: UDim2 # value UDim2 datatype constructor table.
NumberSequence: NumberSequence # value NumberSequence constructor table (a value over a particle's lifetime).
NumberSequenceKeypoint: NumberSequenceKeypoint # value NumberSequenceKeypoint constructor table.
ColorSequence: ColorSequence # value ColorSequence constructor table (a colour over a particle's lifetime).
ColorSequenceKeypoint: ColorSequenceKeypoint # value ColorSequenceKeypoint constructor table.
TweenInfo: TweenInfo # value Timing configuration. Defaults: 1 second, Quad, Out, zero repeats, no reverse or delay.
math: math # value Numeric helpers. Client/Studio and hosted LuX use double-precision numbers; random sequences differ between engines.
string: string # value Native indexing uses UTF-16 code units on desktop and UTF-8 bytes on hosted LuX; unicode helpers offer portable scalar indexing. Hosted string method syntax uses the native readonly metatable and bypasses the global rep/split limit wrappers.
table: table # value Array and dictionary helpers. Portable create/find/clone/clear/move/concat helpers cap work at 100000 entries and use signed 32-bit indices; unpack caps results at 10000.
coroutine: coroutine # value Manual cooperative coroutines. Use task for frame scheduling; manually resumed coroutines do not gain task.wait scheduling.
bit32: bit32 # value Unsigned 32-bit bit operations.
os: os # value Time helpers only. Process execution, environment access, and filesystem mutation are unavailable.
Random: Random # value Deterministic gameplay pseudorandom generator. Explicit seeds match across desktop and hosted LuX; not for secrets.
unicode: unicode # value Portable Unicode scalar helpers, distinct from native string indexing. Reject invalid UTF-8/UTF-16; at most 100000 scalars and 1048576 native string units.
NumberRange: NumberRange # value Immutable numeric interval with finite endpoints; minimum must not exceed maximum.
UDim: UDim # value A scale and pixel-offset coordinate. Supports addition, subtraction, unary negation, and equality.
RaycastParams: RaycastParams # value Mutable query options table. Queries use oriented bounds of Workspace bricks, not exact mesh surfaces. Only Default collision group is supported.
OverlapParams: OverlapParams # value Mutable oriented-box overlap query options. Checks at most 20,000 Workspace bricks.
assert(value: any, message: string?): any # function Return value when truthy; otherwise raise an error.
error(message: any, level: number?): void # function Raise a script error.
pcall(callback: function, ...: any): tuple # function Protected call; returns success followed by results or the error.
xpcall(callback: function, handler: function, ...: any): tuple # function Protected call with an error handler.
pairs(value: table): tuple # function Iterator over dictionary entries; order is unspecified.
ipairs(value: table): tuple # function Iterate sequential indices from 1 until the first nil.
next(value: table, key: any?): tuple # function Return the next key/value pair, or nil.
select(index: any, ...: any): tuple # function Select arguments; '#' returns their count.
tonumber(value: any, base: number?): number? # function Parse a number, or return nil when conversion fails.
tostring(value: any): string # function Convert a value to its text representation.
type(value: any): string # function Lua primitive type. Use typeof for engine datatypes.
unpack(values: table, first: number?, last: number?): tuple # function Return an array interval as multiple values.
pack(...: any): table # function Client/Studio convenience alias of table.pack; use table.pack in portable scripts.
getmetatable(value: any): any # function Return a metatable, protected metatable value, or nil.
setmetatable(value: table, metatable: table?): table # function Set a table's metatable; protected metatables cannot be replaced.
rawget(value: table, key: any): any # function Read a table key without __index.
rawset(value: table, key: any, item: any): table # function Write a table key without __newindex.
rawequal(left: any, right: any): boolean # function Compare without equality metamethods.
rawlen(value: any): number # function Length without __len.
collectgarbage(option: string?, argument: number?): any # function Client/Studio garbage-collection controls; behavior differs from the hosted runtime.
_G: table # value Shared data proxy across scripts in this runtime session. Plain data is copied on assignment and read; reassign nested edits. Isolated from shared, other sessions and the network. Functions, userdata, metatables and cycles are rejected.
shared: table # value A second session-shared data namespace with the same snapshot and size restrictions as _G. It is not network replication.
_VERSION: string # value Underlying Lua runtime version string; not the LuX API version.
Libraries Client

Reusable functions and constants. Call functions with a dot, for example math.clamp(value, 0, 1).

math Client · library

Numeric helpers. Client/Studio and hosted LuX use double-precision numbers; random sequences differ between engines.

Member Kind Description
abs(x: number): number # function Absolute value.
acos(x: number): number # function Inverse cosine in radians.
asin(x: number): number # function Inverse sine in radians.
atan(x: number): number # function Inverse tangent in radians.
ceil(x: number): number # function Round up.
cos(x: number): number # function Cosine of radians.
cosh(x: number): number # function Hyperbolic cosine.
deg(x: number): number # function Convert radians to degrees.
exp(x: number): number # function Euler's number raised to x.
floor(x: number): number # function Round down.
sin(x: number): number # function Sine of radians.
sinh(x: number): number # function Hyperbolic sine.
sqrt(x: number): number # function Square root.
tan(x: number): number # function Tangent of radians.
tanh(x: number): number # function Hyperbolic tangent.
rad(x: number): number # function Convert degrees to radians.
atan2(y: number, x: number): number # function Inverse tangent with quadrant selection.
fmod(x: number, y: number): number # function Remainder with the sign of x.
frexp(x: number): tuple # function Return mantissa and base-two exponent.
ldexp(mantissa: number, exponent: number): number # function Multiply mantissa by two raised to exponent.
log(x: number, base: number?): number # function Logarithm; natural logarithm when base is omitted.
max(...: number): number # function Largest argument.
min(...: number): number # function Smallest argument.
modf(x: number): tuple # function Return integer and fractional components.
pow(x: number, exponent: number): number # function Raise x to exponent.
random(lower: number?, upper: number?): number # function No arguments: random [0,1). One: integer [1,lower]. Two: integer [lower,upper].
randomseed(seed: number): void # function Seed this sandbox's pseudorandom generator; sequences differ across runtimes.
clamp(x: number, minimum: number, maximum: number): number # function Clamp to inclusive bounds; reversed bounds raise an error.
round(x: number): number # function Nearest integer; exact half values round away from zero.
sign(x: number): number # function Return -1, 0, or 1; NaN returns 0.
lerp(a: number, b: number, alpha: number): number # function Linear interpolation or extrapolation; alpha is not clamped.
map(x: number, inmin: number, inmax: number, outmin: number, outmax: number): number # function Map between numeric ranges without clamping; equal input bounds produce IEEE infinity or NaN.
isfinite(x: number): boolean # function True for finite numbers.
isinf(x: number): boolean # function True for positive or negative infinity.
isnan(x: number): boolean # function True for NaN.
pi: number # property Pi.
huge: number # property Positive infinity.
e: number # property Euler's number.
tau: number # property Two times pi.
sqrt2: number # property Square root of two.
phi: number # property Golden ratio.
nan: number # property Not-a-number; use math.isnan to test.
string Client · library

Native indexing uses UTF-16 code units on desktop and UTF-8 bytes on hosted LuX; unicode helpers offer portable scalar indexing. Hosted string method syntax uses the native readonly metatable and bypasses the global rep/split limit wrappers.

Member Kind Description
byte(value: string, first: number?, last: number?): tuple # function Numeric character values; defaults to the first character.
char(...: number): string # function Build a string from numeric character values.
find(value: string, pattern: string, init: number?, plain: boolean?): tuple # function Find a pattern or literal; return start/end and captures, or nil.
format(format: string, ...: any): string # function Format values using printf-style conversions.
gmatch(value: string, pattern: string): function # function Iterator over pattern matches.
gsub(value: string, pattern: string, replacement: any, count: number?): tuple # function Replace matches; returns resulting string and replacement count.
len(value: string): number # function String length in this runtime's character units.
lower(value: string): string # function Lowercase text.
upper(value: string): string # function Uppercase text.
match(value: string, pattern: string, init: number?): any # function First match or captures, or nil.
rep(value: string, count: number, separator: string?): string # function Repeat text with an optional separator; count and output are capped at 1048576 native string units.
reverse(value: string): string # function Reverse character units.
sub(value: string, first: number, last: number?): string # function Substring; negative positions count from the end.
split(value: string, separator: string?): table # function Split on a literal separator (default comma), preserving empty fields. Empty separator splits native string units. All runtimes cap inputs at 1048576 native units and results at 100000.
table Client · library

Array and dictionary helpers. Portable create/find/clone/clear/move/concat helpers cap work at 100000 entries and use signed 32-bit indices; unpack caps results at 10000.

Member Kind Description
concat(values: table, separator: string?, first: number?, last: number?): string # function Join array values; maximum 100000 entries and 1048576 native string units of output.
insert(values: table, positionOrValue: any, value: any?): void # function Append a value, or insert before a supplied index.
remove(values: table, position: number?): any # function Remove and return an array element; defaults to last.
sort(values: table, compare: function?): void # function Sort the array in place.
pack(...: any): table # function Pack arguments; n stores the argument count including nil values.
unpack(values: table, first: number?, last: number?): tuple # function Return at most 10000 array entries as multiple values.
create(count: number, value: any?): table # function Create a table filled with repeated references to value. Nil creates an empty table. Maximum count: 100000.
find(values: table, value: any, init: number?): number? # function Find the first equal value at or after init (default 1), stopping at the first nil; returns nil if absent.
clone(value: table): table # function Shallow copy keys, values, and metatable; protected metatables are rejected.
clear(value: table): void # function Remove all keys without changing identity or metatable.
move(source: table, first: number, last: number, target: number, destination: table?): table # function Copy an interval, safely handling overlap and nil values; returns destination (default source).
coroutine Client · library

Manual cooperative coroutines. Use task for frame scheduling; manually resumed coroutines do not gain task.wait scheduling.

Member Kind Description
create(callback: function): thread # function Create a suspended coroutine.
resume(thread: thread, ...: any): tuple # function Resume and return success plus yielded/results or error.
running(): thread # function Return the running coroutine.
status(thread: thread): string # function Return suspended, running, normal, or dead.
wrap(callback: function): function # function Create a function that resumes the coroutine and propagates errors.
yield(...: any): tuple # function Suspend to the coroutine's caller.
bit32 Client · library

Unsigned 32-bit bit operations.

Member Kind Description
band(...: number): number # function Combine unsigned 32-bit values using AND.
bor(...: number): number # function Combine unsigned 32-bit values using OR.
bxor(...: number): number # function Combine unsigned 32-bit values using XOR.
bnot(value: number): number # function Bitwise complement.
btest(...: number): boolean # function True when bitwise AND is nonzero.
arshift(value: number, displacement: number): number # function Arithmetic right shift.
lshift(value: number, displacement: number): number # function Logical left shift.
rshift(value: number, displacement: number): number # function Logical right shift.
lrotate(value: number, displacement: number): number # function Rotate left.
rrotate(value: number, displacement: number): number # function Rotate right.
extract(value: number, field: number, width: number?): number # function Extract a bit field; default width 1.
replace(value: number, replacement: number, field: number, width: number?): number # function Replace a bit field; default width 1.
os Client · library

Time helpers only. Process execution, environment access, and filesystem mutation are unavailable.

Member Kind Description
clock(): number # function Runtime clock; use time() for the game clock.
date(format: string?, timestamp: number?): any # function Format a date, or return date fields for *t; ! prefix requests UTC.
difftime(later: number, earlier: number): number # function Difference in seconds.
time(date: table?): number # function Unix timestamp now, or for supplied date fields.
task Client · library

Owned coroutine scheduler; handles returned by spawn/defer/delay can be cancelled while suspended.

Member Kind Description
wait(seconds: number?): number # function Yield until a later scheduler update; defaults to 1/30 second on desktop.
spawn(callback: function, ...: any): thread # function Start immediately until first yield.
defer(callback: function, ...: any): thread # function Schedule for a later update.
delay(seconds: number, callback: function, ...: any): thread # function Schedule after seconds; even delay(0) queues.
cancel(thread: thread): void # function Cancel a suspended task owned by this sandbox.
unicode Client · library

Portable Unicode scalar helpers, distinct from native string indexing. Reject invalid UTF-8/UTF-16; at most 100000 scalars and 1048576 native string units.

Member Kind Description
len(value: string): number # function Count Unicode scalars, not bytes, UTF-16 units or grapheme clusters.
char(...: number): string # function Build text from valid Unicode scalar values; surrogate code points are rejected.
codepoints(value: string): table # function Return an array of Unicode scalar values.
sub(value: string, first: number, last: number?): string # function Slice one-based inclusive scalar positions; negative indices count from the end.
Services Client
DataStoreService Client · service

Server/Studio storage only; client calls explicitly error. Studio uses local JSON, local hosted play uses memory, and published servers use authenticated game-scoped persistence.

Member Kind Description
Name: string # property DataStoreService.
ClassName: string # property DataStoreService.
GetDataStore(name: string, scope: string?): DataStore # method Open a standard scoped store. Names/keys require 1-255 UTF-8 bytes without control characters. Scope defaults to global.
GetOrderedDataStore(name: string, scope: string?): OrderedDataStore # method Open a separate numeric store, isolated from standard stores with the same name/scope. Client access is denied.
GetGlobalDataStore(): DataStore # method Equivalent to GetDataStore('global'). Client access is denied.
Workspace Client · service

Container for the 3D world and bricks.

Member Kind Description
GetBrick(id: number): Instance? # method Returns the brick with the given id, or nil.
FindFirstChild(name: string): Instance? # method Finds a brick by name (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a named brick exists; optional timeout in seconds returns nil.
GetBricks(): {Instance} # method Returns an array of every brick in the map.
Raycast(origin: Vector3, direction: Vector3, params: RaycastParams?): RaycastResult? # method Nearest finite-segment hit against full-basis oriented Workspace brick bounds. Direction includes length; no exact mesh/player hits. At most 20,000 bricks.
GetPartBoundsInBox(cframe: CFrame, size: Vector3, params: OverlapParams?): {Instance} # method Workspace bricks whose oriented boxes overlap the supplied oriented box; no exact mesh surface test.
GetChildren(): {Instance} # method Alias of GetBricks().
BrickCount: number # property Number of bricks currently loaded.
Gravity: number # property World gravity in studs/s^2 (best-effort, read-only).
Players Client · service

Container of connected players.

Member Kind Description
LocalPlayer: Instance? # property The local player (client only).
GetPlayers(): {Instance} # method Returns an array of all players.
GetPlayerByNetId(netId: number): Instance? # method Returns the player with the given network id.
PlayerAdded: Event # event Fires when a player joins. Handler receives the player.
PlayerRemoving: Event # event Fires when a player leaves. Handler receives the player.
Lighting Client · service

Environment/lighting properties (best-effort mapping to the world env).

Member Kind Description
Ambient: Color3 # property Indoor ambient color; blended into the env ambient (best-effort).
OutdoorAmbient: Color3 # property Outdoor ambient color; blended into the env ambient (best-effort).
Brightness: number # property Sun light energy (best-effort).
ClockTime: number # property Time of day 0-24; drives the sun elevation (best-effort).
FogColor: Color3 # property Fog color (best-effort).
FogStart: number # property Fog start distance; combined with FogEnd to derive density (best-effort).
FogEnd: number # property Fog end distance; large values disable fog (best-effort).
GlobalShadows: bool # property Toggles directional shadows (best-effort).
ReplicatedStorage Client · service

Shared container. Holds children parented into it in-memory, visible across scripts (no network replication).

Member Kind Description
Name: string # property Container name.
ClassName: string # property Always "ReplicatedStorage".
Parent: Instance? # property Parent in the instance tree (settable).
FindFirstChild(name: string): Instance? # method Finds a stored child by name (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the stored children.
RunService Client · service

Frame stepping events and run context queries.

Member Kind Description
Heartbeat: Event # event Fires every frame with the frame delta (seconds).
RenderStepped: Event # event Fires every frame before rendering (delta seconds).
Stepped: Event # event Fires every frame (time, delta). Best-effort alias of Heartbeat.
IsClient(): bool # method Always true in the client.
IsServer(): bool # method Always false in the client.
IsStudio(): bool # method Always false in the client.
UserInputService Client · service

Keyboard/mouse input (best-effort).

Member Kind Description
InputBegan: Event # event Fires when an input begins. Handler receives an InputObject.
InputEnded: Event # event Fires when an input ends. Handler receives an InputObject.
InputChanged: Event # event Mouse movement and touch dragging. Handler receives (input, gameProcessedEvent); ignore processed input for gameplay.
IsKeyDown(keyCode: string): bool # method Returns whether the given KeyCode is currently held.
PlayerGui Client · service

The local player's live on-screen UI. Hosted server scripts use player.PlayerGui for an isolated tree replicated only to that player; hosted StarterGui remains a shared live tree.

Member Kind Description
Name: string # property Always "PlayerGui".
ClassName: string # property Always "PlayerGui".
FindFirstChild(path: string): Instance? # method Finds a rendered element by name, or by a slash-separated path.
WaitForChild(path: string, timeout: number?): Instance? # method Yield until the GUI path exists; optional timeout in seconds returns nil.
GetChildren(): {Instance} # method Returns the rendered ScreenGui roots.
RemoteEvents Client · service

Authenticated game-scoped events. Server events use a 16 KiB JSON payload limit.

Member Kind Description
OnClientEvent(eventName: string): Signal # method Returns a signal for this named server event.
FireServer(eventName: string, payload: any?): nil # method Submits an intent to the hosted game script. The server must validate it.
SoundService Client · service

Local audio playback. Numeric IDs resolve through BrickBit's asset API.

Member Kind Description
Play(asset: string, volume: number?, pitch: number?): nil # method Plays an asset ID or approved HTTPS sound URL locally.
HttpService Client · service

Local JSON, URL, and GUID helpers. Outbound HTTP is disabled.

Member Kind Description
JSONEncode(value: any): string # method Encode JSON; rejects cycles, unsupported values, over 32 levels, or output above 1 MiB.
JSONDecode(json: string): any # method Decode JSON up to 1 MiB and 32 levels. JSON null maps to nil.
GenerateGUID(wrapInCurlyBraces: boolean?): string # method Generate a random GUID; braces default to true.
UrlEncode(value: string): string # method Percent-encode a URL component.
UrlDecode(value: string): string # method Decode a URL component; plus is treated as space.
CollectionService Client · service

Runtime instance tags and membership signals. Client tags are session-local.

Member Kind Description
AddTag(instance: Instance, tag: string): void # method Add a tag once; duplicates do not emit another added signal.
RemoveTag(instance: Instance, tag: string): void # method Remove a tag and emit its removed signal.
HasTag(instance: Instance, tag: string): boolean # method Check tag membership.
GetTags(instance: Instance): table # method Sorted array of this instance's tags.
GetAllTags(): table # method Sorted unique tags on instances in the game.
GetTagged(tag: string): table # method Return current matching instances in the game.
GetInstanceAddedSignal(tag: string): RBXScriptSignal # method Connect to instances entering this tag.
GetInstanceRemovedSignal(tag: string): RBXScriptSignal # method Connect to instances leaving this tag or being destroyed.
Debris Client · service

Schedule instance destruction without yielding. Maximum 1000 queued instances.

Member Kind Description
AddItem(instance: Instance, lifetime: number?): void # method Destroy after lifetime seconds (default 10). Re-adding keeps the earlier deadline.
TweenService Client · service

Animate Part transforms/color/transparency and GUI Position, Size, AnchorPoint, background color/transparency, text color/size, and scrolling offsets.

Member Kind Description
Create(instance: Instance, info: TweenInfo, goals: table): Tween # method Create a paused tween; Play starts it. Conflicting properties cancel the previous tween.
GetValue(alpha: number, easingStyle: string?, easingDirection: string?): number # method Evaluate an easing curve at alpha between zero and one.
RemoteFunctions Client · service

Named RemoteFunction handles shared by hosted games and Studio play sessions.

Member Kind Description
Get(name: string): RemoteFunction # method Get a named RemoteFunction. Uses the same bounded transport as replicated RemoteFunction instances.
Classes Client
Instance Client · class

Base scriptable object. Instance.new("Part") maps onto a brick; other class names create generic tree nodes.

Member Kind Description
new(className: string): Instance # function Constructs an instance of the given class name.
Name: string # property Instance name.
ClassName: string # property Class name of the instance.
Parent: Instance? # property Parent in the instance tree (settable).
GetChildren(): {Instance} # method Returns the direct children.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
IsA(className: string): bool # method Best-effort class check.
Destroy(): void # method Detaches the instance from the tree (and removes a brick-backed part).
Value: any # property Free-form value slot. Backs the *Value classes (IntValue, StringValue, Vector3Value, Color3Value) - but it is untyped and present on every generic instance, so nothing enforces that an IntValue holds a number. Not replicated: it is local to the script's own instance tree.
Brick Client · class

A brick or part in the world.

Member Kind Description
ID: number # property Unique brick id.
Name: string # property Brick name.
Position: Vector3 # property World position (BH studs).
CFrame: CFrame # property Rendered center and orientation. Assigning preserves the brick's center-based transform; Position retains the map-corner coordinate convention.
Scale: Vector3 # property Size in studs.
Size: Vector3 # property Alias of Scale.
Color: Color3 # property Brick color.
Transparency: number # property 0 opaque .. 1 fully transparent.
Material: string # property Material name (see Enum.Material).
Collision: bool # property Whether the brick is collidable.
CanCollide: bool # property Alias of Collision with the same polarity.
Roughness: number # property Surface roughness override 0-1. -1 inherits the Material's own profile.
Metalness: number # property Metalness override 0-1. -1 inherits the Material's own profile.
Clickable: bool # property Whether the brick raises OnClick.
Rotation: number # property Yaw rotation in degrees.
ClassName: string # property Always "Part" for brick-backed parts.
Parent: Instance? # property Parent in the instance tree (settable; brick keeps rendering regardless).
OnClick: Event # property Fires when a player clicks the brick (receives the player).
MouseClick: Event # property Alias of OnClick.
Clicked: Event # property Alias of OnClick. Was already implemented but undocumented here.
Touched: Event # property Fires when the local player touches the brick (best-effort AABB).
GetTouchingParts(): {Instance} # method Other collidable Workspace bricks overlapping this full-basis oriented box. Detached and storage-only parts are excluded.
GetChildren(): {Instance} # method Returns instances parented to this brick.
FindFirstChild(name: string): Instance? # method Finds a child by name (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
IsA(className: string): bool # method Best-effort class check. Inherited; ApiSurfaceProbe flagged it as exposed but undocumented.
Destroy(): void # method Removes the brick from the world.
InputObject Client · class

The input passed to UserInputService.InputBegan and InputEnded. Best-effort: only the fields below are populated.

Member Kind Description
UserInputType: string # property What produced the input - see Enum.UserInputType. "Keyboard" for keys, "MouseButton1"/"MouseButton2"/"MouseButton3" for clicks.
KeyCode: string # property Key name for keyboard input, e.g. "Space". Empty for mouse input.
X: number # property Cursor X for mouse input; 0 otherwise.
Y: number # property Cursor Y for mouse input; 0 otherwise.
DeltaX: number # property Horizontal motion in pixels for mouse movement or touch dragging.
DeltaY: number # property Vertical motion in pixels for mouse movement or touch dragging.
TouchId: number # property Finger index for touch events; -1 for other input.
Player Client · class

A connected player.

Member Kind Description
Name: string # property Display name.
UserId: number # property Authenticated account id, distinct from the network id.
NetID: number # property Network id.
Score: number # property Leaderboard score.
GetLeaderstat(name: string): string? # method Read a replicated named stat. Server scripts publish stats with the hosted Player:SetLeaderstat API.
Health: number # property Current health.
MaxHealth: number # property Maximum health.
Position: Vector3 # property Character position.
ParticleEmitter Client · class

A particle effect. Free-floating, or following a brick or a player. Emitters live in world space, so moving one leaves a trail rather than dragging its particles along.

Member Kind Description
Name: string # property Emitter name. Local to the script; emitters are not in the instance tree.
ClassName: string # property Always "ParticleEmitter".
Enabled: bool # property Whether particles are being emitted. Default true. Emit() ignores this.
Rate: number # property Particles per second, minimum 0. Default 20. The pool is capped at 4000 particles per emitter, so a very large Rate stops scaling rather than stalling the client.
Lifetime: number # property Seconds each particle lives, clamped 0.05-60. Default 2.
Speed: number # property Initial speed in studs/second. Default 8.
SpeedVariation: number # property Random spread of the initial speed as a fraction of Speed, clamped 0-1. Default 0.2.
SpreadAngle: number # property Cone half-angle in degrees around Direction, clamped 0-180. Default 20; 0 is a straight line.
Direction: Vector3 # property Emission direction, normalised on assignment. A zero vector falls back to up.
Acceleration: Vector3 # property Constant acceleration in studs/s^2. Gravity is not applied unless you set it here.
Position: Vector3 # property World position in the same studs as brick.Position. Ignored while attached to a brick or player.
Offset: Vector3 # property Extra offset applied on top of whatever the emitter is attached to.
Size: number # property Particle size in studs, minimum 0.01. Assign a NumberSequence instead for size over lifetime. Reading it always gives the number, never the sequence.
Color: Color3 # property Flat tint, or assign a ColorSequence for colour over lifetime. Reading it always gives a Color3.
Transparency: number # property 0 opaque .. 1 invisible, or assign a NumberSequence for transparency over lifetime. Reading it always gives the number.
Texture: string # property res:// path or http(s) URL of the particle sprite. A value that fails to load logs a warning and keeps the default sprite.
Parent: Instance? # property Assign a brick or player to follow it, or nil to leave it where it is. Write-only in practice: reading it always gives nil.
Emit(count: number): void # method Emits a one-off burst of the given count, whatever Enabled is set to.
AttachToBrick(brick: Instance|number): void # method Follows a brick. Takes a brick or a brick id.
AttachToPlayer(player: Instance|number): void # method Follows a player's character. Takes a player or a net id.
AttachToWorld(position: Vector3?): void # method Detaches and pins the emitter to a fixed position, defaulting to where it currently is.
IsA(className: string): bool # method True for "ParticleEmitter" or "Instance".
Destroy(): void # method Removes the emitter. A proxy kept after this is inert, not dangerous.
UIListLayout Client · class

Arranges visible siblings in a row or column.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
Padding: UDim # property Space between siblings.
FillDirection: string # property Horizontal or Vertical.
SortOrder: string # property Name, Custom insertion order, or LayoutOrder.
HorizontalAlignment: string # property Left, Center, or Right.
VerticalAlignment: string # property Top, Center, or Bottom.
UIPadding Client · class

Insets the parent content rectangle.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
PaddingLeft: UDim # property Left inset.
PaddingRight: UDim # property Right inset.
PaddingTop: UDim # property Top inset.
PaddingBottom: UDim # property Bottom inset.
UISizeConstraint Client · class

Clamps the parent size.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
MinSize: Vector2 # property Minimum dimensions.
MaxSize: Vector2 # property Maximum dimensions.
UIAspectRatioConstraint Client · class

Constrains the parent width/height ratio.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
AspectRatio: number # property Positive width divided by height.
AspectType: string # property FitWithinMaxSize or ScaleWithParentSize.
DominantAxis: string # property Width or Height.
ScreenGui Client · class

A full-screen layer. Parent one to PlayerGui, then parent elements to it. Always fills the viewport, so it has no Position/Size of its own.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
Enabled: bool # property Whether this screen draws. The same flag as Visible.
Frame Client · class

A rectangular container.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
BackgroundColor3: Color3 # property Background colour.
BackgroundColor: Color3 # property Alias of BackgroundColor3, under the name the published-GUI JSON uses.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
ScrollingFrame Client · class

A clipped scrolling container. Imported canvas size and position are supported; automatic canvas sizing is not implemented.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
BackgroundColor3: Color3 # property Background colour.
BackgroundColor: Color3 # property Alias of BackgroundColor3, under the name the published-GUI JSON uses.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
CanvasSize: UDim2 # property Authored scrollable canvas size.
CanvasPosition: Vector2 # property Current scroll offset in pixels, clamped to the canvas.
ScrollingEnabled: bool # property Whether wheel/touch scrolling is enabled.
TextLabel Client · class

Non-interactive text.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
BackgroundColor3: Color3 # property Background colour.
BackgroundColor: Color3 # property Alias of BackgroundColor3, under the name the published-GUI JSON uses.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Displayed text.
TextColor3: Color3 # property Text colour.
TextColor: Color3 # property Alias of TextColor3, under the name the published-GUI JSON uses.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
TextButton Client · class

Clickable text button.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
BackgroundColor3: Color3 # property Background colour.
BackgroundColor: Color3 # property Alias of BackgroundColor3, under the name the published-GUI JSON uses.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Displayed text.
TextColor3: Color3 # property Text colour.
TextColor: Color3 # property Alias of TextColor3, under the name the published-GUI JSON uses.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
MouseButton1Click: Event # event Fires when the button is activated. :Connect(fn), :Once(fn) or :Wait().
Activated: Event # event Alias of MouseButton1Click.
ImageLabel Client · class

Non-interactive image. Drawn by a node with no background stylebox, so BackgroundColor3 would be inert and is deliberately not offered.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
Image: string # property Image URL, fetched asynchronously (PNG/JPG/WebP). A grey placeholder shows while it loads and stays if the fetch fails.
ImageButton Client · class

Clickable image. Same lack of a background as ImageLabel.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
Image: string # property Image URL, fetched asynchronously (PNG/JPG/WebP). A grey placeholder shows while it loads and stays if the fetch fails.
MouseButton1Click: Event # event Fires when the button is activated. :Connect(fn), :Once(fn) or :Wait().
Activated: Event # event Alias of MouseButton1Click.
TextBox Client · class

Editable single-line text field.

Member Kind Description
Name: string # property Element name. Also the key FindFirstChild matches on.
ClassName: string # property Read-only class name.
Parent: Instance? # property Assign PlayerGui for a ScreenGui, another element for anything else, nil to detach. A non-ScreenGui assigned to PlayerGui is refused and left detached.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
FindFirstChild(name: string): Instance? # method Finds a direct child by name (case-insensitive).
FindFirstChildOfClass(className: string): Instance? # method Finds the first direct child of the given class (case-insensitive).
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a child exists. Optional timeout in seconds returns nil; parent destruction also ends the wait.
GetChildren(): {Instance} # method Returns the direct children.
GetFullName(): string # method Dotted path from PlayerGui, e.g. "PlayerGui.MainGui.PlayButton". Studio names the same element from StarterGui.
IsA(className: string): bool # method True for the own class and Instance; GuiObject is true only for drawable elements, not ScreenGui or layout components.
Destroy(): void # method Removes the element and everything under it.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
MouseEnter: Event # event Fires when the cursor enters the element. Connecting or waiting on this is what makes the element take part in mouse picking at all - until something listens, clicks and camera movement pass straight through it to the world behind.
MouseLeave: Event # event Fires when the cursor leaves the element. Same opt-in as MouseEnter.
BackgroundColor3: Color3 # property Background colour.
BackgroundColor: Color3 # property Alias of BackgroundColor3, under the name the published-GUI JSON uses.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Displayed text.
TextColor3: Color3 # property Text colour.
TextColor: Color3 # property Alias of TextColor3, under the name the published-GUI JSON uses.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
FocusLost: Event # event Text is updated before FocusLost(enterPressed, inputObject). Enter sets true; blur sets false. Hosted handlers receive nil inputObject and the authenticated player as a third argument. Hosted input is limited to 4096 UTF-8 bytes and rejected for another player's private tree or hidden/disabled UI.
Tween Client · class

An animation returned by TweenService:Create.

Member Kind Description
Play(): void # method Start or resume. Replay captures the current starting properties.
Pause(): void # method Pause while preserving elapsed time.
Cancel(): void # method Stop without restoring the original properties.
Destroy(): void # method Release this tween and its listeners without firing Completed; future actions fail.
PlaybackState: string # property Begin, Delayed, Playing, Paused, Completed, or Cancelled.
Completed: Event # event Fires with Completed or Cancelled; supports Connect and Wait.
RemoteFunction Client · class

Yielding request/response endpoint. Supports nil, booleans, finite numbers, strings, arrays, string-keyed tables and visible Instance/Player/GUI references. Hidden or removed references become nil; functions, cycles and other userdata are rejected. Maximum 64 arguments/results, 15 KiB payload, 64 pending requests, 10-second timeout.

Member Kind Description
OnServerInvoke: function # property Server callback receives the authenticated Player followed by arguments. Client assignment is rejected. Studio uses its active local player.
OnClientInvoke: function # property Client callback invoked by the server. Assign a function or nil. Callback execution may yield.
InvokeServer(...: any): tuple # method Client-only. Yield until the authoritative server callback returns; propagates callback errors, timeout, and disconnect failure.
InvokeClient(player: Player, ...: any): tuple # method Server-only. Yield until the selected connected client responds. Never trust client-returned gameplay decisions.
DataStore Client · class

Server/Studio JSON storage (4 MiB, depth 64, 100,000 values per payload). Hosted operations yield for IO; Studio completes locally. Each successful mutation has an opaque revision; revisions persist until explicitly removed. No Roblox retention/hourly-version policy or user metadata APIs.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
ClassName: string # property DataStore or OrderedDataStore.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta: number?): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetVersionAsync(key: string, version: string): any # method Read a retained version, returning value and DataStoreKeyInfo. Missing version returns nil; tombstones return nil plus IsDeleted info.
ListVersionsAsync(key: string, sortDirection: Enum.SortDirection?, minDate: number?, maxDate: number?, pageSize: number?): DataStoreVersionPages # method List key revisions. Defaults Ascending and pageSize 50; size 1-100. Date bounds are inclusive Unix milliseconds. Pages are live keyset pages, not a snapshot.
RemoveVersionAsync(key: string, version: string): void # method Permanently delete a retained revision. Deleting the current revision removes the current value and never resurrects an older revision.
OrderedDataStore Client · class

Server/Studio integer store. Values must be exact integers between -9007199254740991 and 9007199254740991. No version-history APIs. Hosted operations yield; Studio completes locally.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
ClassName: string # property DataStore or OrderedDataStore.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta: number?): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetSortedAsync(ascending: boolean, pageSize: number?, minValue: number?, maxValue: number?): DataStorePages # method List {key,value} entries sorted numerically, with key tie-break. Ascending is required; page size defaults to 50 and must be 1-100. Optional bounds are inclusive safe integers. Live keyset pages may reflect intervening writes.
DataStorePages Client · class

Paged ordered-store entries with key and value fields.

Member Kind Description
ClassName: string # property DataStorePages or DataStoreVersionPages.
IsFinished: boolean # property True when no further page is available.
GetCurrentPage(): table # method Return a fresh copy of this page's entries.
AdvanceToNextPageAsync(): void # method Fetch the next page; errors after the final page. Hosted IO yields; Studio completes locally.
DataStoreVersionPages Client · class

Paged revision info entries with Version, CreatedTime and IsDeleted fields.

Member Kind Description
ClassName: string # property DataStorePages or DataStoreVersionPages.
IsFinished: boolean # property True when no further page is available.
GetCurrentPage(): table # method Return a fresh copy of this page's entries.
AdvanceToNextPageAsync(): void # method Fetch the next page; errors after the final page. Hosted IO yields; Studio completes locally.
DataStoreKeyInfo Client · class

Plain revision information table. Times are Unix milliseconds.

Member Kind Description
Version: string # property Opaque version token; do not parse it.
CreatedTime: number # property Revision creation time in Unix milliseconds.
UpdatedTime: number # property Revision timestamp in Unix milliseconds.
IsDeleted: boolean # property True for a remove tombstone.
RaycastResult Client · class

Nearest hit against a Workspace brick's full-basis oriented box. No player, terrain, or exact mesh-surface intersection.

Member Kind Description
Instance: Part # property Hit brick Instance.
Position: Vector3 # property World hit position.
Normal: Vector3 # property Outward unit surface normal.
Distance: number # property Distance from ray origin.
Material: string # property Brick material.
Data types Client
Vector2 Client · datatype

2D vector.

Member Kind Description
new(x: number?, y: number?): Vector2 # constructor Creates a Vector2.
X: number # property X component.
Y: number # property Y component.
Magnitude: number # property Length of the vector.
Vector3 Client · datatype

3D vector.

Member Kind Description
new(x: number?, y: number?, z: number?): Vector3 # constructor Creates a Vector3.
X: number # property X component.
Y: number # property Y component.
Z: number # property Z component.
Magnitude: number # property Length of the vector.
Dot(other: Vector3): number # method Dot product with another Vector3.
Color3 Client · datatype

RGB color with 0-1 components.

Member Kind Description
new(r: number?, g: number?, b: number?): Color3 # constructor Creates a Color3 from 0-1 components.
fromRGB(r: number, g: number, b: number): Color3 # constructor Creates a Color3 from 0-255 components.
R: number # property Red 0-1.
G: number # property Green 0-1.
B: number # property Blue 0-1.
CFrame Client · datatype

Coordinate frame with position and rotation.

Member Kind Description
new(...: any?): CFrame # constructor Construct identity, from a Vector3, from x/y/z, from position and target Vector3s, from x/y/z plus quaternion x/y/z/w, or from x/y/z plus nine row-major rotation entries.
identity: CFrame # property Zero position and identity rotation on the CFrame constructor table.
Angles(rx: number, ry: number, rz: number): CFrame # constructor Creates a rotation-only CFrame from XYZ Euler angles in radians.
fromEulerAnglesXYZ(rx: number, ry: number, rz: number): CFrame # constructor Alias of Angles.
fromOrientation(rx: number, ry: number, rz: number): CFrame # constructor Rotation-only frame in YXZ order; angles are radians.
fromEulerAnglesYXZ(rx: number, ry: number, rz: number): CFrame # constructor Alias of fromOrientation.
fromAxisAngle(axis: Vector3, angle: number): CFrame # constructor Rotation around a finite nonzero axis by radians.
fromMatrix(position: Vector3, right: Vector3, up: Vector3, back: Vector3?): CFrame # constructor Construct from position and basis columns. Back defaults to right cross up.
lookAt(at: Vector3, target: Vector3, up: Vector3?): CFrame # constructor Face the target from at; local -Z is forward. Default up is world +Y.
lookAlong(at: Vector3, direction: Vector3, up: Vector3?): CFrame # constructor Face a nonzero direction from at; local -Z is forward.
X: number # property X position.
Y: number # property Y position.
Z: number # property Z position.
Position: Vector3 # property Position component.
p: Vector3 # property Position component (legacy alias).
LookVector: Vector3 # property Forward direction (-Z) of the rotation.
RightVector: Vector3 # property Right direction (+X) of the rotation.
UpVector: Vector3 # property Up direction (+Y) of the rotation.
Rotation: CFrame # property Rotation only, with zero position.
XVector: Vector3 # property Alias of RightVector.
YVector: Vector3 # property Alias of UpVector.
ZVector: Vector3 # property Back (+Z) direction, opposite LookVector.
Inverse(): CFrame # method Returns the inverse CFrame.
ToWorldSpace(other: CFrame): CFrame # method Composes this CFrame with another: this * other.
ToObjectSpace(other: CFrame): CFrame # method Expresses another CFrame relative to this one.
PointToWorldSpace(point: Vector3): Vector3 # method Transform a point including translation.
PointToObjectSpace(point: Vector3): Vector3 # method Inverse-transform a world point including translation.
VectorToWorldSpace(vector: Vector3): Vector3 # method Rotate a direction without translation.
VectorToObjectSpace(vector: Vector3): Vector3 # method Inverse-rotate a direction without translation.
GetComponents(): (number, number, number, number, number, number, number, number, number, number, number, number) # method Return 12 numbers: x, y, z followed by nine row-major rotation entries; not a table.
components(): (number, number, number, number, number, number, number, number, number, number, number, number) # method Legacy alias of GetComponents; returns 12 numbers.
ToAxisAngle(): (Vector3, number) # method Return axis and angle in radians as two values, not a table.
FuzzyEq(other: CFrame, epsilon: number?): bool # method Compare every position and basis component; epsilon defaults to 0.00001.
Lerp(goal: CFrame, alpha: number): CFrame # method Linearly interpolate position and spherically interpolate rotation.
UDim2 Client · datatype

Two scale/offset coordinate axes. Supports addition, subtraction, unary negation, and equality.

Member Kind Description
new(xScale: number?, xOffset: number?, yScale: number?, yOffset: number?): UDim2 # constructor Construct a coordinate pair; components default to zero.
fromScale(xScale: number?, yScale: number?): UDim2 # constructor Construct with zero offsets.
fromOffset(xOffset: number?, yOffset: number?): UDim2 # constructor Construct with zero scale.
X: UDim # property Horizontal coordinate.
Y: UDim # property Vertical coordinate.
Lerp(goal: UDim2, alpha: number): UDim2 # method Interpolate or extrapolate components; alpha is not clamped.
UDim Client · datatype

A scale and pixel-offset coordinate. Supports addition, subtraction, unary negation, and equality.

Member Kind Description
new(scale: number?, offset: number?): UDim # constructor Construct one coordinate axis; both components default to zero. LuX retains fractional offsets.
Scale: number # property Fraction of the parent dimension.
Offset: number # property Pixel offset.
NumberSequence Client · datatype

A number over a particle's 0..1 lifetime. Assign to ParticleEmitter.Size or .Transparency.

Member Kind Description
new(value: number|table, endValue: number?): NumberSequence # constructor Constant value, or a start/end pair, or a table: keypoints, {time, value} pairs, or plain numbers spaced evenly. An unrecognised argument yields an empty sequence, which every consumer treats as "no sequence".
NumberSequenceKeypoint Client · datatype

One point of a NumberSequence.

Member Kind Description
new(time: number, value: number): NumberSequenceKeypoint # constructor Creates a keypoint at time 0-1.
Time: number # property Position along the lifetime, 0-1.
Value: number # property Value at that time.
ColorSequence Client · datatype

A colour over a particle's 0..1 lifetime. Assign to ParticleEmitter.Color.

Member Kind Description
new(color: Color3|table, endColor: Color3?): ColorSequence # constructor Constant colour, or a start/end pair, or a table of keypoints, {time, Color3} pairs, or plain Color3s spaced evenly.
ColorSequenceKeypoint Client · datatype

One point of a ColorSequence.

Member Kind Description
new(time: number, color: Color3): ColorSequenceKeypoint # constructor Creates a keypoint at time 0-1.
Time: number # property Position along the lifetime, 0-1.
Value: Color3 # property Colour at that time.
TweenInfo Client · datatype

Timing configuration. Defaults: 1 second, Quad, Out, zero repeats, no reverse or delay.

Member Kind Description
new(time: number?, easingStyle: string?, easingDirection: string?, repeatCount: number?, reverses: boolean?, delayTime: number?): TweenInfo # constructor Construct timing. RepeatCount -1 repeats indefinitely.
Random Client · datatype

Deterministic gameplay pseudorandom generator. Explicit seeds match across desktop and hosted LuX; not for secrets.

Member Kind Description
new(seed: number?): Random # constructor Create a private stream. Finite seed is floored and normalized modulo 2147483646; omitted seed varies.
NextInteger(minimum: number, maximum: number): number # method Uniform integer between inclusive signed 32-bit bounds.
NextNumber(minimum: number?, maximum: number?): number # method Random number in the ordered finite range, default 0..1; upper bound excluded except floating-point rounding.
Clone(): Random # method Copy the current generator state without advancing it.
NextUnitVector(): Vector3 # method Unit vector sampled uniformly on the sphere; trigonometric rounding may vary across runtimes.
NumberRange Client · datatype

Immutable numeric interval with finite endpoints; minimum must not exceed maximum.

Member Kind Description
new(value: number?, maximum: number?): NumberRange # constructor Construct [value,maximum]. Defaults to [0,0]; one value uses it for both endpoints.
Min: number # property Lower endpoint.
Max: number # property Upper endpoint.
RaycastParams Client · datatype

Mutable query options table. Queries use oriented bounds of Workspace bricks, not exact mesh surfaces. Only Default collision group is supported.

Member Kind Description
new(): RaycastParams # constructor Create default exclusion-filter options.
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
CollisionGroup: string # property Only Default is accepted.
IgnoreWater: boolean # property Compatibility option; these queries do not include terrain or water.
OverlapParams Client · datatype

Mutable oriented-box overlap query options. Checks at most 20,000 Workspace bricks.

Member Kind Description
new(): OverlapParams # constructor Create default exclusion-filter options.
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
CollisionGroup: string # property Only Default is accepted.
MaxParts: number # property Result limit 0-20,000. Zero uses the 20,000 safety cap.
Enums Client
Enum.Material Client
NameValue
Enum.Material.Plastic"plastic"
Enum.Material.SmoothPlastic"smoothplastic"
Enum.Material.Neon"neon"
Enum.Material.Wood"wood"
Enum.Material.WoodPlanks"woodplanks"
Enum.Material.Marble"marble"
Enum.Material.Basalt"basalt"
Enum.Material.Slate"slate"
Enum.Material.CrackedLava"crackedlava"
Enum.Material.Concrete"concrete"
Enum.Material.Limestone"limestone"
Enum.Material.Granite"granite"
Enum.Material.Pavement"pavement"
Enum.Material.Brick"brick"
Enum.Material.Pebble"pebble"
Enum.Material.Cobblestone"cobblestone"
Enum.Material.Rock"rock"
Enum.Material.Sandstone"sandstone"
Enum.Material.CorrodedMetal"corrodedmetal"
Enum.Material.DiamondPlate"diamondplate"
Enum.Material.Foil"foil"
Enum.Material.Metal"metal"
Enum.Material.Grass"grass"
Enum.Material.LeafyGrass"leafygrass"
Enum.Material.Sand"sand"
Enum.Material.Fabric"fabric"
Enum.Material.Snow"snow"
Enum.Material.Mud"mud"
Enum.Material.Ground"ground"
Enum.Material.Asphalt"asphalt"
Enum.Material.Salt"salt"
Enum.Material.Ice"ice"
Enum.Material.Glacier"glacier"
Enum.Material.Glass"glass"
Enum.Material.ForceField"forcefield"
Enum.Material.Air"air"
Enum.Material.Water"water"
Enum.Material.Cardboard"cardboard"
Enum.Material.Carpet"carpet"
Enum.Material.CeramicTiles"ceramictiles"
Enum.Material.ClayRoofTiles"clayrooftiles"
Enum.Material.RoofShingles"roofshingles"
Enum.Material.Leather"leather"
Enum.Material.Plaster"plaster"
Enum.Material.Rubber"rubber"
Enum.FillDirection Client
NameValue
Enum.FillDirection.Horizontal"Horizontal"
Enum.FillDirection.Vertical"Vertical"
Enum.SortOrder Client
NameValue
Enum.SortOrder.Name"Name"
Enum.SortOrder.Custom"Custom"
Enum.SortOrder.LayoutOrder"LayoutOrder"
Enum.HorizontalAlignment Client
NameValue
Enum.HorizontalAlignment.Center"Center"
Enum.HorizontalAlignment.Left"Left"
Enum.HorizontalAlignment.Right"Right"
Enum.VerticalAlignment Client
NameValue
Enum.VerticalAlignment.Center"Center"
Enum.VerticalAlignment.Top"Top"
Enum.VerticalAlignment.Bottom"Bottom"
Enum.AspectType Client
NameValue
Enum.AspectType.FitWithinMaxSize"FitWithinMaxSize"
Enum.AspectType.ScaleWithParentSize"ScaleWithParentSize"
Enum.DominantAxis Client
NameValue
Enum.DominantAxis.Width"Width"
Enum.DominantAxis.Height"Height"
Enum.SortDirection Client
NameValue
Enum.SortDirection.Ascending"Ascending"
Enum.SortDirection.Descending"Descending"
Enum.RaycastFilterType Client
NameValue
Enum.RaycastFilterType.Include"Include"
Enum.RaycastFilterType.Exclude"Exclude"
Enum.Shape Client
NameValue
Enum.Shape.Cube0
Enum.Shape.Slope1
Enum.Shape.Wedge2
Enum.Shape.Spawnpoint3
Enum.Shape.Arch4
Enum.Shape.Dome5
Enum.Shape.Bars6
Enum.Shape.Flag7
Enum.Shape.Pole8
Enum.Shape.Cylinder9
Enum.Shape.RoundSlope10
Enum.Shape.Vent11
Enum.Shape.Sphere12
Enum.PartType Client
NameValue
Enum.PartType.Block0
Enum.PartType.Wedge2
Enum.PartType.Cylinder9
Enum.UserInputType Client
NameValue
Enum.UserInputType.MouseButton1"MouseButton1"
Enum.UserInputType.MouseButton2"MouseButton2"
Enum.UserInputType.MouseButton3"MouseButton3"
Enum.UserInputType.MouseMovement"MouseMovement"
Enum.UserInputType.MouseWheel"MouseWheel"
Enum.UserInputType.Keyboard"Keyboard"
Enum.UserInputType.Touch"Touch"
Enum.UserInputState Client
NameValue
Enum.UserInputState.Begin"Begin"
Enum.UserInputState.End"End"
Enum.UserInputState.Change"Change"
Enum.KeyCode Client
NameValue
Enum.KeyCode.A"A"
Enum.KeyCode.B"B"
Enum.KeyCode.C"C"
Enum.KeyCode.D"D"
Enum.KeyCode.E"E"
Enum.KeyCode.F"F"
Enum.KeyCode.G"G"
Enum.KeyCode.H"H"
Enum.KeyCode.I"I"
Enum.KeyCode.J"J"
Enum.KeyCode.K"K"
Enum.KeyCode.L"L"
Enum.KeyCode.M"M"
Enum.KeyCode.N"N"
Enum.KeyCode.O"O"
Enum.KeyCode.P"P"
Enum.KeyCode.Q"Q"
Enum.KeyCode.R"R"
Enum.KeyCode.S"S"
Enum.KeyCode.T"T"
Enum.KeyCode.U"U"
Enum.KeyCode.V"V"
Enum.KeyCode.W"W"
Enum.KeyCode.X"X"
Enum.KeyCode.Y"Y"
Enum.KeyCode.Z"Z"
Enum.KeyCode.Space"Space"
Enum.KeyCode.Return"Return"
Enum.KeyCode.Escape"Escape"
Enum.KeyCode.LeftShift"LeftShift"
Enum.KeyCode.LeftControl"LeftControl"
Enum.KeyCode.Tab"Tab"
Enum.KeyCode.Up"Up"
Enum.KeyCode.Down"Down"
Enum.KeyCode.Left"Left"
Enum.KeyCode.Right"Right"
Enum.KeyCode.Zero"0"
Enum.KeyCode.One"1"
Enum.KeyCode.Two"2"
Enum.KeyCode.Three"3"
Enum.KeyCode.Four"4"
Enum.KeyCode.Five"5"
Enum.KeyCode.Six"6"
Enum.KeyCode.Seven"7"
Enum.KeyCode.Eight"8"
Enum.KeyCode.Nine"9"
Enum.Font Client
NameValue
Enum.Font.Legacy"Legacy"
Enum.Font.Arial"Arial"
Enum.Font.ArialBold"ArialBold"
Enum.Font.SourceSans"SourceSans"
Enum.Font.SourceSansBold"SourceSansBold"
Enum.Font.SourceSansLight"SourceSansLight"
Enum.Font.SourceSansItalic"SourceSansItalic"
Enum.EasingStyle Client
NameValue
Enum.EasingStyle.Linear"Linear"
Enum.EasingStyle.Sine"Sine"
Enum.EasingStyle.Quad"Quad"
Enum.EasingStyle.Cubic"Cubic"
Enum.EasingStyle.Quart"Quart"
Enum.EasingStyle.Quint"Quint"
Enum.EasingStyle.Exponential"Exponential"
Enum.EasingStyle.Circular"Circular"
Enum.EasingStyle.Back"Back"
Enum.EasingStyle.Bounce"Bounce"
Enum.EasingStyle.Elastic"Elastic"
Enum.EasingDirection Client
NameValue
Enum.EasingDirection.In"In"
Enum.EasingDirection.Out"Out"
Enum.EasingDirection.InOut"InOut"
Enum.PlaybackState Client
NameValue
Enum.PlaybackState.Begin"Begin"
Enum.PlaybackState.Delayed"Delayed"
Enum.PlaybackState.Playing"Playing"
Enum.PlaybackState.Paused"Paused"
Enum.PlaybackState.Completed"Completed"
Enum.PlaybackState.Cancelled"Cancelled"
Globals Studio playtest

Values and functions available without retrieving a service. Constructor tables such as Vector3 are values; use their named functions.

Member Kind Description
print(...): any # function Print values to the output console.
warn(...): any # function Print a warning to the output console.
tick(): number # function Seconds since the engine started.
time(): number # function Seconds the game has been running.
typeof(value): string # function Runtime type name of a value.
Vector3: Vector3 # value 3D vector library.
Vector2: Vector2 # value 2D vector library.
Color3: Color3 # value RGB color library.
CFrame: CFrame # value Coordinate-frame (position + rotation).
Enum: Enum # value Enumeration table.
brick: Part # value
script: Script # value The script currently running.
game: DataModel # value Root of the experience hierarchy.
workspace: Workspace # value Shortcut for game.Workspace.
Instance: Instance # value Object constructor library.
wait(seconds?): number # function Yield the current thread for seconds (default ~1/30).
spawn(fn): any # function Run fn on a new thread next frame.
delay(seconds, fn): any # function Run fn after a delay on a new thread.
TweenInfo: TweenInfo # value Timing configuration. Defaults: 1 second, Quad, Out, zero repeats, no reverse or delay.
math: math # value Numeric helpers. Client/Studio and hosted LuX use double-precision numbers; random sequences differ between engines.
string: string # value Native indexing uses UTF-16 code units on desktop and UTF-8 bytes on hosted LuX; unicode helpers offer portable scalar indexing. Hosted string method syntax uses the native readonly metatable and bypasses the global rep/split limit wrappers.
table: table # value Array and dictionary helpers. Portable create/find/clone/clear/move/concat helpers cap work at 100000 entries and use signed 32-bit indices; unpack caps results at 10000.
coroutine: coroutine # value Manual cooperative coroutines. Use task for frame scheduling; manually resumed coroutines do not gain task.wait scheduling.
bit32: bit32 # value Unsigned 32-bit bit operations.
os: os # value Time helpers only. Process execution, environment access, and filesystem mutation are unavailable.
task: task # value Owned coroutine scheduler; handles returned by spawn/defer/delay can be cancelled while suspended.
Random: Random # value Deterministic gameplay pseudorandom generator. Explicit seeds match across desktop and hosted LuX; not for secrets.
unicode: unicode # value Portable Unicode scalar helpers, distinct from native string indexing. Reject invalid UTF-8/UTF-16; at most 100000 scalars and 1048576 native string units.
NumberRange: NumberRange # value Immutable numeric interval with finite endpoints; minimum must not exceed maximum.
UDim: UDim # value A scale and pixel-offset coordinate. Supports addition, subtraction, unary negation, and equality.
UDim2: UDim2 # value Two scale/offset coordinate axes. Supports addition, subtraction, unary negation, and equality.
RaycastParams: RaycastParams # value Mutable query options table. Queries use oriented bounds of Workspace bricks, not exact mesh surfaces. Only Default collision group is supported.
OverlapParams: OverlapParams # value Mutable oriented-box overlap query options. Checks at most 20,000 Workspace bricks.
assert(value: any, message?: string): any # function Return value when truthy; otherwise raise an error.
error(message: any, level?: number): void # function Raise a script error.
pcall(callback: function, ...: any): tuple # function Protected call; returns success followed by results or the error.
xpcall(callback: function, handler: function, ...: any): tuple # function Protected call with an error handler.
pairs(value: table): tuple # function Iterator over dictionary entries; order is unspecified.
ipairs(value: table): tuple # function Iterate sequential indices from 1 until the first nil.
next(value: table, key?: any): tuple # function Return the next key/value pair, or nil.
select(index: any, ...: any): tuple # function Select arguments; '#' returns their count.
tonumber(value: any, base?: number): number? # function Parse a number, or return nil when conversion fails.
tostring(value: any): string # function Convert a value to its text representation.
type(value: any): string # function Lua primitive type. Use typeof for engine datatypes.
unpack(values: table, first?: number, last?: number): tuple # function Return an array interval as multiple values.
pack(...: any): table # function Client/Studio convenience alias of table.pack; use table.pack in portable scripts.
getmetatable(value: any): any # function Return a metatable, protected metatable value, or nil.
setmetatable(value: table, metatable?: table): table # function Set a table's metatable; protected metatables cannot be replaced.
rawget(value: table, key: any): any # function Read a table key without __index.
rawset(value: table, key: any, item: any): table # function Write a table key without __newindex.
rawequal(left: any, right: any): boolean # function Compare without equality metamethods.
rawlen(value: any): number # function Length without __len.
collectgarbage(option?: string, argument?: number): any # function Client/Studio garbage-collection controls; behavior differs from the hosted runtime.
_G: table # value Shared data proxy across scripts in this runtime session. Plain data is copied on assignment and read; reassign nested edits. Isolated from shared, other sessions and the network. Functions, userdata, metatables and cycles are rejected.
shared: table # value A second session-shared data namespace with the same snapshot and size restrictions as _G. It is not network replication.
_VERSION: string # value Underlying Lua runtime version string; not the LuX API version.
Libraries Studio playtest

Reusable functions and constants. Call functions with a dot, for example math.clamp(value, 0, 1).

bit32 Studio playtest · library

Unsigned 32-bit bit operations.

Member Kind Description
band(...: number): number # function Combine unsigned 32-bit values using AND.
bor(...: number): number # function Combine unsigned 32-bit values using OR.
bxor(...: number): number # function Combine unsigned 32-bit values using XOR.
bnot(value: number): number # function Bitwise complement.
btest(...: number): boolean # function True when bitwise AND is nonzero.
arshift(value: number, displacement: number): number # function Arithmetic right shift.
lshift(value: number, displacement: number): number # function Logical left shift.
rshift(value: number, displacement: number): number # function Logical right shift.
lrotate(value: number, displacement: number): number # function Rotate left.
rrotate(value: number, displacement: number): number # function Rotate right.
extract(value: number, field: number, width?: number): number # function Extract a bit field; default width 1.
replace(value: number, replacement: number, field: number, width?: number): number # function Replace a bit field; default width 1.
coroutine Studio playtest · library

Manual cooperative coroutines. Use task for frame scheduling; manually resumed coroutines do not gain task.wait scheduling.

Member Kind Description
create(callback: function): thread # function Create a suspended coroutine.
resume(thread: thread, ...: any): tuple # function Resume and return success plus yielded/results or error.
running(): thread # function Return the running coroutine.
status(thread: thread): string # function Return suspended, running, normal, or dead.
wrap(callback: function): function # function Create a function that resumes the coroutine and propagates errors.
yield(...: any): tuple # function Suspend to the coroutine's caller.
math Studio playtest · library

Numeric helpers. Client/Studio and hosted LuX use double-precision numbers; random sequences differ between engines.

Member Kind Description
abs(x: number): number # function Absolute value.
acos(x: number): number # function Inverse cosine in radians.
asin(x: number): number # function Inverse sine in radians.
atan(x: number): number # function Inverse tangent in radians.
ceil(x: number): number # function Round up.
cos(x: number): number # function Cosine of radians.
cosh(x: number): number # function Hyperbolic cosine.
deg(x: number): number # function Convert radians to degrees.
exp(x: number): number # function Euler's number raised to x.
floor(x: number): number # function Round down.
sin(x: number): number # function Sine of radians.
sinh(x: number): number # function Hyperbolic sine.
sqrt(x: number): number # function Square root.
tan(x: number): number # function Tangent of radians.
tanh(x: number): number # function Hyperbolic tangent.
rad(x: number): number # function Convert degrees to radians.
atan2(y: number, x: number): number # function Inverse tangent with quadrant selection.
fmod(x: number, y: number): number # function Remainder with the sign of x.
frexp(x: number): tuple # function Return mantissa and base-two exponent.
ldexp(mantissa: number, exponent: number): number # function Multiply mantissa by two raised to exponent.
log(x: number, base: number?): number # function Logarithm; natural logarithm when base is omitted.
max(...: number): number # function Largest argument.
min(...: number): number # function Smallest argument.
modf(x: number): tuple # function Return integer and fractional components.
pow(x: number, exponent: number): number # function Raise x to exponent.
random(lower: number?, upper: number?): number # function No arguments: random [0,1). One: integer [1,lower]. Two: integer [lower,upper].
randomseed(seed: number): void # function Seed this sandbox's pseudorandom generator; sequences differ across runtimes.
clamp(x: number, minimum: number, maximum: number): number # function Clamp to inclusive bounds; reversed bounds raise an error.
round(x: number): number # function Nearest integer; exact half values round away from zero.
sign(x: number): number # function Return -1, 0, or 1; NaN returns 0.
lerp(a: number, b: number, alpha: number): number # function Linear interpolation or extrapolation; alpha is not clamped.
map(x: number, inmin: number, inmax: number, outmin: number, outmax: number): number # function Map between numeric ranges without clamping; equal input bounds produce IEEE infinity or NaN.
isfinite(x: number): boolean # function True for finite numbers.
isinf(x: number): boolean # function True for positive or negative infinity.
isnan(x: number): boolean # function True for NaN.
pi: number # property Pi.
huge: number # property Positive infinity.
e: number # property Euler's number.
tau: number # property Two times pi.
sqrt2: number # property Square root of two.
phi: number # property Golden ratio.
nan: number # property Not-a-number; use math.isnan to test.
os Studio playtest · library

Time helpers only. Process execution, environment access, and filesystem mutation are unavailable.

Member Kind Description
clock(): number # function Runtime clock; use time() for the game clock.
date(format?: string, timestamp?: number): any # function Format a date, or return date fields for *t; ! prefix requests UTC.
difftime(later: number, earlier: number): number # function Difference in seconds.
time(date?: table): number # function Unix timestamp now, or for supplied date fields.
string Studio playtest · library

Native indexing uses UTF-16 code units on desktop and UTF-8 bytes on hosted LuX; unicode helpers offer portable scalar indexing. Hosted string method syntax uses the native readonly metatable and bypasses the global rep/split limit wrappers.

Member Kind Description
byte(value: string, first: number?, last: number?): tuple # function Numeric character values; defaults to the first character.
char(...: number): string # function Build a string from numeric character values.
find(value: string, pattern: string, init: number?, plain: boolean?): tuple # function Find a pattern or literal; return start/end and captures, or nil.
format(format: string, ...: any): string # function Format values using printf-style conversions.
gmatch(value: string, pattern: string): function # function Iterator over pattern matches.
gsub(value: string, pattern: string, replacement: any, count: number?): tuple # function Replace matches; returns resulting string and replacement count.
len(value: string): number # function String length in this runtime's character units.
lower(value: string): string # function Lowercase text.
upper(value: string): string # function Uppercase text.
match(value: string, pattern: string, init: number?): any # function First match or captures, or nil.
rep(value: string, count: number, separator: string?): string # function Repeat text with an optional separator; count and output are capped at 1048576 native string units.
reverse(value: string): string # function Reverse character units.
sub(value: string, first: number, last: number?): string # function Substring; negative positions count from the end.
split(value: string, separator: string?): table # function Split on a literal separator (default comma), preserving empty fields. Empty separator splits native string units. All runtimes cap inputs at 1048576 native units and results at 100000.
table Studio playtest · library

Array and dictionary helpers. Portable create/find/clone/clear/move/concat helpers cap work at 100000 entries and use signed 32-bit indices; unpack caps results at 10000.

Member Kind Description
concat(values: table, separator: string?, first: number?, last: number?): string # function Join array values; maximum 100000 entries and 1048576 native string units of output.
insert(values: table, positionOrValue: any, value: any?): void # function Append a value, or insert before a supplied index.
remove(values: table, position: number?): any # function Remove and return an array element; defaults to last.
sort(values: table, compare: function?): void # function Sort the array in place.
pack(...: any): table # function Pack arguments; n stores the argument count including nil values.
unpack(values: table, first: number?, last: number?): tuple # function Return at most 10000 array entries as multiple values.
create(count: number, value: any?): table # function Create a table filled with repeated references to value. Nil creates an empty table. Maximum count: 100000.
find(values: table, value: any, init: number?): number? # function Find the first equal value at or after init (default 1), stopping at the first nil; returns nil if absent.
clone(value: table): table # function Shallow copy keys, values, and metatable; protected metatables are rejected.
clear(value: table): void # function Remove all keys without changing identity or metatable.
move(source: table, first: number, last: number, target: number, destination: table?): table # function Copy an interval, safely handling overlap and nil values; returns destination (default source).
task Studio playtest · library

Task scheduler library.

Member Kind Description
wait(seconds?): number # function Yield the current thread for seconds (default ~1/30).
spawn(callback: function, ...: any): thread # function Run immediately until yielding; returns a cancellable task.
defer(callback: function, ...: any): thread # function Schedule a callback for a later frame; returns a cancellable task.
cancel(): any # function
delay(seconds: number, callback: function, ...: any): thread # function Schedule a callback for a later frame; returns a cancellable task.
Services Studio playtest

Retrieve services with game:GetService("Name"). Use the members listed for this context.

CollectionService Studio playtest · service

Runtime instance tags and membership signals. Client tags are session-local.

Member Kind Description
AddTag(instance: Instance, tag: string): void # method Add a tag once; duplicates do not emit another added signal.
RemoveTag(instance: Instance, tag: string): void # method Remove a tag and emit its removed signal.
HasTag(instance: Instance, tag: string): boolean # method Check tag membership.
GetTags(instance: Instance): table # method Sorted array of this instance's tags.
GetAllTags(): table # method Sorted unique tags on instances in the game.
GetTagged(tag: string): table # method Return current matching instances in the game.
GetInstanceAddedSignal(tag: string): RBXScriptSignal # method Connect to instances entering this tag.
GetInstanceRemovedSignal(tag: string): RBXScriptSignal # method Connect to instances leaving this tag or being destroyed.
DataStoreService Studio playtest · service

Server/Studio storage only; client calls explicitly error. Studio uses local JSON, local hosted play uses memory, and published servers use authenticated game-scoped persistence.

Member Kind Description
Name: string # property DataStoreService.
ClassName: string # property DataStoreService.
GetDataStore(name: string, scope?: string): DataStore # method Open a standard scoped store. Names/keys require 1-255 UTF-8 bytes without control characters. Scope defaults to global.
GetOrderedDataStore(name: string, scope?: string): OrderedDataStore # method Open a separate numeric store, isolated from standard stores with the same name/scope. Client access is denied.
GetGlobalDataStore(): DataStore # method Equivalent to GetDataStore('global'). Client access is denied.
Debris Studio playtest · service

Schedule instance destruction without yielding. Maximum 1000 queued instances.

Member Kind Description
AddItem(instance: Instance, lifetime?: number): void # method Destroy after lifetime seconds (default 10). Re-adding keeps the earlier deadline.
HttpService Studio playtest · service

Local JSON, URL, and GUID helpers. Outbound HTTP is disabled.

Member Kind Description
JSONEncode(value: any): string # method Encode JSON; rejects cycles, unsupported values, over 32 levels, or output above 1 MiB.
JSONDecode(json: string): any # method Decode JSON up to 1 MiB and 32 levels. JSON null maps to nil.
GenerateGUID(wrapInCurlyBraces?: boolean): string # method Generate a random GUID; braces default to true.
UrlEncode(value: string): string # method Percent-encode a URL component.
UrlDecode(value: string): string # method Decode a URL component; plus is treated as space.
Lighting Studio playtest · service

Global lighting / atmosphere.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Ambient: Color3 # property Ambient light color.
OutdoorAmbient: Color3 # property Outdoor ambient color.
Brightness: number # property Sun light energy.
ClockTime: number # property Time of day 0-24 (sun elevation).
FogColor: Color3 # property Fog color.
FogStart: number # property Fog near distance.
FogEnd: number # property Fog far distance.
GlobalShadows: boolean # property Toggle directional shadows.
Players Studio playtest · service

Tracks connected players.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
LocalPlayer: Player # property The play character during play; nil otherwise.
GetPlayers(): table # method Array of players (the play character during play).
GetPlayerCount(): number # method Number of players (1 during play, else 0).
PlayerAdded: RBXScriptSignal # event Best-effort: fires when a player joins.
PlayerRemoving: RBXScriptSignal # event Best-effort: fires when a player leaves.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
RemoteFunctions Studio playtest · service

Named RemoteFunction handles shared by hosted games and Studio play sessions.

Member Kind Description
Get(name: string): RemoteFunction # method Get a named RemoteFunction. Uses the same bounded transport as replicated RemoteFunction instances.
ReplicatedStorage Studio playtest · service

Shared container service.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
FindFirstChild(name): Instance # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a direct child exists; returns nil on timeout.
GetChildren(): table # method Array of direct children.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
RunService Studio playtest · service

Per-frame stepping signals.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Heartbeat: RBXScriptSignal # event Fires every frame after physics.
Stepped: RBXScriptSignal # event Fires every frame before physics.
RenderStepped: RBXScriptSignal # event Fires every render frame.
IsClient(): boolean # method Always true.
IsServer(): boolean # method Always false.
IsStudio(): boolean # method Always true (Studio).
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
TweenService Studio playtest · service

Animate Part transforms/color/transparency and GUI Position, Size, AnchorPoint, background color/transparency and text color/size. ScrollingFrame offsets are currently client-only.

Member Kind Description
Create(instance: Instance, info: TweenInfo, goals: table): Tween # method Create a paused tween; Play starts it. Conflicting properties cancel the previous tween.
GetValue(alpha: number, easingStyle?: string, easingDirection?: string): number # method Evaluate an easing curve at alpha between zero and one.
UserInputService Studio playtest · service

Keyboard / mouse input (fires during a play session).

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
InputBegan: RBXScriptSignal # event Fires when an input begins (play only). Handler gets an InputObject.
InputEnded: RBXScriptSignal # event Fires when an input ends (play only). Handler gets an InputObject.
InputChanged: RBXScriptSignal # event Mouse movement and touch dragging. Input includes X, Y, DeltaX, DeltaY and TouchId. Ignore processed input for gameplay.
IsKeyDown(keyCode): boolean # method Whether the given KeyCode is currently held.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
Workspace Studio playtest · service

Holds the 3D world / bricks.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
BrickCount(): number # method Number of bricks loaded.
Gravity: number # property World gravity (studs/s^2).
GetBrick(id): Part # method Fetch a brick by id.
FindFirstChild(name): Part # method Find a direct child by name.
GetBricks(): table # method Array of all bricks.
GetChildren(): table # method Array of direct children.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a direct child exists; returns nil on timeout.
Raycast(origin, direction, params?): RaycastResult # method Nearest finite-segment hit against Workspace oriented brick bounds. Direction includes length; nil on no hit. At most 20,000 bricks.
GetPartBoundsInBox(cframe, size, params?): table # method Workspace bricks whose full-basis oriented boxes overlap this oriented box. Bounds, not exact shape meshes.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
Classes Studio playtest
DataModel Studio playtest · class

Root game object (the `game` global).

Member Kind Description
Workspace: Workspace # property Shortcut for game.Workspace.
Players: Players # property The Players service.
Lighting: Lighting # property The Lighting service.
ReplicatedStorage: ReplicatedStorage # property Shared storage service.
RunService: RunService # property Frame/step events service.
UserInputService: UserInputService # property Input events service.
StarterGui: StarterGui # property The authored UI tree. Studio-only name - prefer PlayerGui, which works here and in the shipped client.
PlayerGui: StarterGui # property The player's live UI. The same object as StarterGui during playtest, and the only one of the two the client serves.
DataStoreService: DataStoreService # property Key/value storage. Studio-local: it persists on this machine only and the shipped client has no DataStore at all.
Task: task # property Task scheduler library.
GetBrick(id): Part # method Fetch a brick by id.
GetService(name): Instance # method Fetch a service by name.
HttpService: HttpService # property Local JSON, URL, and GUID helpers. Outbound HTTP is disabled.
CollectionService: CollectionService # property Runtime instance tags and membership signals. Client tags are session-local.
Debris: Debris # property Schedule instance destruction without yielding. Maximum 1000 queued instances.
TweenService: TweenService # property Animate Part transforms/color/transparency and GUI Position, Size, AnchorPoint, background color/transparency and text color/size. ScrollingFrame offsets are currently client-only.
RemoteFunctions: RemoteFunctions # property Named RemoteFunction handles shared by hosted games and Studio play sessions.
DataStore Studio playtest · class

Server/Studio JSON storage (4 MiB, depth 64, 100,000 values per payload). Hosted operations yield for IO; Studio completes locally. Each successful mutation has an opaque revision; revisions persist until explicitly removed. No Roblox retention/hourly-version policy or user metadata APIs.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
ClassName: string # property DataStore or OrderedDataStore.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta?: number): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetVersionAsync(key: string, version: string): any # method Read a retained version, returning value and DataStoreKeyInfo. Missing version returns nil; tombstones return nil plus IsDeleted info.
ListVersionsAsync(key: string, sortDirection?: Enum.SortDirection, minDate?: number, maxDate?: number, pageSize?: number): DataStoreVersionPages # method List key revisions. Defaults Ascending and pageSize 50; size 1-100. Date bounds are inclusive Unix milliseconds. Pages are live keyset pages, not a snapshot.
RemoveVersionAsync(key: string, version: string): void # method Permanently delete a retained revision. Deleting the current revision removes the current value and never resurrects an older revision.
DataStoreKeyInfo Studio playtest · class

Plain revision information table. Times are Unix milliseconds.

Member Kind Description
Version: string # property Opaque version token; do not parse it.
CreatedTime: number # property Revision creation time in Unix milliseconds.
UpdatedTime: number # property Revision timestamp in Unix milliseconds.
IsDeleted: boolean # property True for a remove tombstone.
DataStorePages Studio playtest · class

Paged ordered-store entries with key and value fields.

Member Kind Description
ClassName: string # property DataStorePages or DataStoreVersionPages.
IsFinished: boolean # property True when no further page is available.
GetCurrentPage(): table # method Return a fresh copy of this page's entries.
AdvanceToNextPageAsync(): void # method Fetch the next page; errors after the final page. Hosted IO yields; Studio completes locally.
DataStoreVersionPages Studio playtest · class

Paged revision info entries with Version, CreatedTime and IsDeleted fields.

Member Kind Description
ClassName: string # property DataStorePages or DataStoreVersionPages.
IsFinished: boolean # property True when no further page is available.
GetCurrentPage(): table # method Return a fresh copy of this page's entries.
AdvanceToNextPageAsync(): void # method Fetch the next page; errors after the final page. Hosted IO yields; Studio completes locally.
Frame Studio playtest · class

Frame GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
ImageButton Studio playtest · class

ImageButton GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Image: string # property Image asset id/url.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
MouseButton1Click: RBXScriptSignal # event Fires on left-click/tap (play only).
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
ImageLabel Studio playtest · class

ImageLabel GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Image: string # property Image asset id/url.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
InputObject Studio playtest · class

Input payload passed to UserInputService events.

Member Kind Description
DeltaX: number # property Horizontal mouse or touch motion in pixels.
DeltaY: number # property Vertical mouse or touch motion in pixels.
TouchId: number # property Finger index for touch events; -1 for other input.
UserInputType: string # property What produced the input - see Enum.UserInputType. "Keyboard" for keys, "MouseButton1"/"MouseButton2"/"MouseButton3" for clicks.
KeyCode: string # property Key name for keyboard input, e.g. "Space". Empty for mouse input.
X: number # property Cursor X for mouse input; 0 otherwise.
Y: number # property Cursor Y for mouse input; 0 otherwise.
Instance Studio playtest · class

Base class for scripted objects.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
OrderedDataStore Studio playtest · class

Server/Studio integer store. Values must be exact integers between -9007199254740991 and 9007199254740991. No version-history APIs. Hosted operations yield; Studio completes locally.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
ClassName: string # property DataStore or OrderedDataStore.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta?: number): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetSortedAsync(ascending: boolean, pageSize?: number, minValue?: number, maxValue?: number): DataStorePages # method List {key,value} entries sorted numerically, with key tie-break. Ascending is required; page size defaults to 50 and must be 1-100. Optional bounds are inclusive safe integers. Live keyset pages may reflect intervening writes.
Part Studio playtest · class

A brick in the Workspace.

Member Kind Description
ID: number # property Unique brick id.
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Touched: RBXScriptSignal # event Fires when the play character touches the brick (play only).
Clicked: RBXScriptSignal # event Fires when the brick is clicked (play only).
OnClick: RBXScriptSignal # event Alias of Clicked (ClickDetector style).
MouseClick: RBXScriptSignal # event Alias of Clicked (ClickDetector style).
Parent # property Hierarchical parent.
Position: Vector3 # property World position (studs).
Scale: Vector3 # property Size on each axis (studs).
Size: Vector3 # property Alias of Scale.
Color: Color3 # property Brick color.
Transparency: number # property 0 opaque … 1 invisible.
Collision: boolean # property Whether the brick is solid.
CanCollide: boolean # property Alias of Collision.
Anchored: boolean # property Saved with the place. True keeps the part fixed. The shared hosted solver supports false for boxes and uniform spheres; the standalone native host currently rejects false. Client scripts cannot control authoritative physics.
Material: string # property Surface material.
Clickable: boolean # property Whether clicks are detected.
Rotation: number # property Yaw rotation in degrees.
CFrame: CFrame # property
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this brick.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
GetTouchingParts(): table # method Other collidable Workspace bricks with overlapping oriented bounds. Detached and storage-only parts are excluded.
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
Player Studio playtest · class

A player in the running session.

Member Kind Description
Name: string # property Display name.
NetID: number # property Network id.
Score: number # property Leaderboard score.
Position: Vector3 # property Character position.
Health: number # property Current health.
MaxHealth: number # property Maximum health.
PlayerGui Studio playtest · class

The player's live screen UI. Works in playtest and in the client.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
RBXScriptConnection Studio playtest · class

Handle returned by Signal:Connect().

Member Kind Description
Connected: boolean # property
Disconnect(): any # method
RBXScriptSignal Studio playtest · class

Event you can Connect / Once / Wait on.

Member Kind Description
Connect(handler: function): RBXScriptConnection # method Run a function every time the event fires.
Once(handler: function): RBXScriptConnection # method Run a function the next time the event fires, then disconnect.
Wait(): any # method Yield the thread until the event fires.
RaycastResult Studio playtest · class

Nearest hit against a Workspace brick's full-basis oriented box. No player, terrain, or exact mesh-surface intersection.

Member Kind Description
Instance: Part # property Hit brick Instance.
Position: Vector3 # property World hit position.
Normal: Vector3 # property Outward unit surface normal.
Distance: number # property Distance from ray origin.
Material: string # property Brick material.
RemoteFunction Studio playtest · class

Yielding requests and responses with bounded JSON values.

Member Kind Description
InvokeClient(player: Player, ...: any): tuple # method Server-only. Yield until the selected connected client responds. Never trust client-returned gameplay decisions.
InvokeServer(...: any): tuple # method Client-only. Yield until the authoritative server callback returns; propagates callback errors, timeout, and disconnect failure.
OnClientInvoke: function # property Client callback invoked by the server. Assign a function or nil. Callback execution may yield.
OnServerInvoke: function # property Server callback receives the authenticated Player followed by arguments. Client assignment is rejected. Studio uses its active local player.
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Parent # property Hierarchical parent.
Changed # property
ChildAdded # property
ChildRemoved # property
DescendantAdded # property
DescendantRemoving # property
AncestryChanged # property
Destroying # property
AttributeChanged # property
OnInvoke # property
Event # property
Invoke # property
Value # property
OnServerEvent # property
OnClientEvent # property
GetChildren(): any # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): any # method Find a direct child by name.
WaitForChild(name: string, timeout?: number): any # method Yield until a direct child exists; returns nil on timeout or parent destruction.
IsA(className: string): boolean # method Class membership test.
Destroy(): any # method Remove this instance.
GetDescendants(): any # method
Clone(): any # method Deep-copy this element and its children.
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
GetFullName(): string # method
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
GetPropertyChangedSignal(name: string): any # method
GetAttributeChangedSignal(name: string): any # method
GetAttribute(name: string): any # method
GetAttributes(): any # method
SetAttribute(name: string, value): any # method
FindFirstChildOfClass(className: string): any # method Find a direct child by class.
Fire(args): any # method
FireServer(args): any # method
FireClient(player, args): any # method
FireAllClients(args): any # method
ScreenGui Studio playtest · class

ScreenGui GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
Enabled: boolean # property Whether this ScreenGui is shown.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
Script Studio playtest · class

The running script object.

Member Kind Description
Parent: Part # property Hierarchical parent.
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
Disabled: boolean # property
Enabled: boolean # property Whether it runs.
StarterGui Studio playtest · class

Root container for the authored UI. Studio-only; the client serves PlayerGui.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
TextBox Studio playtest · class

TextBox GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
Text: string # property Displayed text.
TextSize: number # property Font size in pixels.
TextScaled: boolean # property
TextColor3: Color3 # property Text color.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
FocusLost: RBXScriptSignal # event Text is updated before this event. Enter sets enterPressed=true; ordinary blur sets false. Hosted handlers receive nil inputObject and the authenticated player as the third argument. Hosted input is limited to 4096 UTF-8 bytes and rejected for another player's private tree or hidden/disabled UI.
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
TextButton Studio playtest · class

TextButton GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
Text: string # property Displayed text.
TextSize: number # property Font size in pixels.
TextScaled: boolean # property
TextColor3: Color3 # property Text color.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
MouseButton1Click: RBXScriptSignal # event Fires on left-click/tap (play only).
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
TextLabel Studio playtest · class

TextLabel GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Position: UDim2 # property Scale+offset position within the parent.
Size: UDim2 # property Scale+offset size.
Text: string # property Displayed text.
TextSize: number # property Font size in pixels.
TextScaled: boolean # property
TextColor3: Color3 # property Text color.
BackgroundColor3: Color3 # property Background color.
BackgroundTransparency: number # property 0 opaque … 1 invisible.
Visible: boolean # property Whether the element is shown.
ZIndex: number # property Draw order within siblings.
AnchorPoint: Vector2 # property Origin point (0-1) Position/rotation is relative to.
Enabled: boolean # property Whether it runs.
LayoutOrder # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
MouseEnter: RBXScriptSignal # event Fires when the cursor enters this element (play only).
MouseLeave: RBXScriptSignal # event Fires when the cursor leaves this element (play only).
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
Tween Studio playtest · class

An animation returned by TweenService:Create.

Member Kind Description
Play(): void # method Start or resume. Replay captures the current starting properties.
Pause(): void # method Pause while preserving elapsed time.
Cancel(): void # method Stop without restoring the original properties.
Destroy(): void # method Release this tween and its listeners without firing Completed; future actions fail.
PlaybackState: string # property Begin, Delayed, Playing, Paused, Completed, or Cancelled.
Completed: RBXScriptSignal # event Fires with Completed or Cancelled; supports Connect and Wait.
UIAspectRatioConstraint Studio playtest · class

UIAspectRatioConstraint GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
AspectRatio # property Positive parent width divided by height.
AspectType # property FitWithinMaxSize contains the ratio in the requested size; ScaleWithParentSize derives the other dimension from DominantAxis.
DominantAxis # property Width or Height: the requested dimension preserved for ScaleWithParentSize.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
UIListLayout Studio playtest · class

UIListLayout GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
Padding # property Gap between visible siblings, measured along FillDirection as scale plus pixel offset.
FillDirection # property Horizontal row or Vertical column. Wrapping and flex layout are not supported.
SortOrder # property Name, LayoutOrder, or Custom (insertion order). Equal keys retain insertion order.
HorizontalAlignment # property Left, Center, or Right within the padded content area.
VerticalAlignment # property Top, Center, or Bottom within the padded content area.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
UIPadding Studio playtest · class

UIPadding GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
PaddingLeft # property Inset from this edge of the parent's content area, as scale plus pixel offset.
PaddingRight # property Inset from this edge of the parent's content area, as scale plus pixel offset.
PaddingTop # property Inset from this edge of the parent's content area, as scale plus pixel offset.
PaddingBottom # property Inset from this edge of the parent's content area, as scale plus pixel offset.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
UISizeConstraint Studio playtest · class

UISizeConstraint GUI instance.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
Parent: Instance # property Hierarchical parent.
MinSize # property Minimum parent width and height in pixels.
MaxSize # property Maximum parent width and height in pixels; defaults to 100000 on each axis.
GetChildren(): table # method Array of direct children.
FindFirstChild(name: string, recursive?: boolean): Instance # method Find a child by name.
FindFirstChildOfClass(className: string): Instance # method Find a child by class name.
WaitForChild(name: string, timeout?: number): Instance # method Yield until a child exists.
Clone(): Instance # method Deep-copy this subtree, unparented.
Destroy(): any # method Remove this instance and its descendants.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method Dotted path from the root.
unicode Studio playtest · class

Portable Unicode scalar helpers, distinct from native string indexing. Reject invalid UTF-8/UTF-16; at most 100000 scalars and 1048576 native string units.

Member Kind Description
len(value: string): number # method Count Unicode scalars, not bytes, UTF-16 units or grapheme clusters.
char(...: number): string # method Build text from valid Unicode scalar values; surrogate code points are rejected.
codepoints(value: string): table # method Return an array of Unicode scalar values.
sub(value: string, first: number, last?: number): string # method Slice one-based inclusive scalar positions; negative indices count from the end.
Data types Studio playtest

Value constructors, component properties and operations.

CFrame Studio playtest · datatype

Coordinate frame (position + rotation).

Member Kind Description
X: number # property X position.
Y: number # property Y position.
Z: number # property Z position.
Position: Vector3 # property Position component.
p: Vector3 # property Position (legacy alias).
LookVector: Vector3 # property Forward (-Z) direction.
RightVector: Vector3 # property Right (+X) direction.
UpVector: Vector3 # property Up (+Y) direction.
Rotation: CFrame # property Rotation only, with zero position.
XVector: Vector3 # property Alias of RightVector.
YVector: Vector3 # property Alias of UpVector.
ZVector: Vector3 # property Back (+Z) direction, opposite LookVector.
ToWorldSpace(other: CFrame): CFrame # method Compose with another CFrame.
ToObjectSpace(other: CFrame): CFrame # method Inverse-transform another CFrame.
Inverse(): CFrame # method Return the inverse rigid frame.
PointToWorldSpace(v: Vector3): Vector3 # method Transform a point including translation.
PointToObjectSpace(v: Vector3): Vector3 # method Inverse-transform a world point including translation.
VectorToWorldSpace(v: Vector3): Vector3 # method Rotate a direction without translation.
VectorToObjectSpace(v: Vector3): Vector3 # method Inverse-rotate a direction without translation.
GetComponents(): any # method Return 12 numbers: x, y, z followed by nine row-major rotation entries; not a table.
components(): any # method Legacy alias of GetComponents; returns 12 numbers.
FuzzyEq(other: CFrame, epsilon?: number): boolean # method Compare every position and basis component; epsilon defaults to 0.00001.
ToAxisAngle(): any # method Return axis and angle in radians as two values, not a table.
Lerp(goal: CFrame, alpha: number): CFrame # method Linearly interpolate position and spherically interpolate rotation.
identity: CFrame # property Zero position and identity rotation.
new(): CFrame # constructor Construct identity, from a Vector3, from x/y/z, from position and target Vector3s, from x/y/z plus quaternion x/y/z/w, or from x/y/z plus nine row-major rotation entries.
Angles(rx: number, ry: number, rz: number): CFrame # constructor Construct a rotation from XYZ Euler angles (radians).
fromEulerAnglesXYZ(rx: number, ry: number, rz: number): CFrame # constructor Alias of Angles.
fromOrientation(x: number, y: number, z: number): CFrame # constructor Rotation-only frame in YXZ order; angles are radians.
fromEulerAnglesYXZ(x: number, y: number, z: number): CFrame # constructor Alias of fromOrientation.
fromAxisAngle(axis: Vector3, angle: number): CFrame # constructor Rotation around a finite nonzero Vector3 axis by radians.
fromMatrix(position: Vector3, right: Vector3, up: Vector3, back?: Vector3): CFrame # constructor Construct from position and basis columns. Back defaults to right cross up.
lookAt(at: Vector3, target: Vector3, up?: Vector3): CFrame # constructor Face the target from at; local -Z is forward. Default up is world +Y.
lookAlong(at: Vector3, direction: Vector3, up?: Vector3): CFrame # constructor Face a nonzero direction from at; local -Z is forward.
Color3 Studio playtest · datatype

RGB colour value.

Member Kind Description
R: number # property Red 0-1.
G: number # property Green 0-1.
B: number # property Blue 0-1.
new(r?: number, g?: number, b?: number): Color3 # constructor Construct from 0-1 components.
fromRGB(r: number, g: number, b: number): Color3 # constructor Construct from 0-255 components.
NumberRange Studio playtest · datatype

Immutable numeric interval.

Member Kind Description
Min: number # property Lower endpoint.
Max: number # property Upper endpoint.
new(value?: number, maximum?): NumberRange # constructor Construct [value,maximum]. Defaults to [0,0]; one value uses it for both endpoints.
OverlapParams Studio playtest · datatype

Mutable oriented-box overlap query options. Checks at most 20,000 Workspace bricks.

Member Kind Description
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
CollisionGroup: string # property Only Default is accepted.
MaxParts: number # property Result limit 0-20,000. Zero uses the 20,000 safety cap.
new(): OverlapParams # constructor Create default exclusion-filter options.
Random Studio playtest · datatype

Portable deterministic gameplay pseudorandom stream.

Member Kind Description
NextNumber(minimum?: number, maximum?: number): number # method Random number in the ordered finite range, default 0..1; upper bound excluded except floating-point rounding.
NextInteger(minimum: number, maximum: number): number # method Uniform integer between inclusive signed 32-bit bounds.
Clone(): Random # method Copy the current generator state without advancing it.
NextUnitVector(): Vector3 # method Unit vector sampled uniformly on the sphere; trigonometric rounding may vary across runtimes.
new(seed?): Random # constructor Create a private stream. Finite seed is floored and normalized modulo 2147483646; omitted seed varies.
RaycastParams Studio playtest · datatype

Mutable query options table. Queries use oriented bounds of Workspace bricks, not exact mesh surfaces. Only Default collision group is supported.

Member Kind Description
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
CollisionGroup: string # property Only Default is accepted.
IgnoreWater: boolean # property Compatibility option; these queries do not include terrain or water.
new(): RaycastParams # constructor Create default exclusion-filter options.
TweenInfo Studio playtest · datatype

Timing configuration. Defaults: 1 second, Quad, Out, zero repeats, no reverse or delay.

Member Kind Description
new(time?: number, easingStyle?: string, easingDirection?: string, repeatCount?: number, reverses?: boolean, delayTime?: number): TweenInfo # constructor Construct timing. RepeatCount -1 repeats indefinitely.
UDim Studio playtest · datatype

One axis of a UDim2 (scale + offset).

Member Kind Description
Scale: number # property Fraction of the parent dimension.
Offset: number # property Pixel offset.
new(scale?: number, offset?: number): UDim # constructor Construct one coordinate axis; both components default to zero. LuX retains fractional offsets.
UDim2 Studio playtest · datatype

2D UI scale+offset coordinate.

Member Kind Description
X: UDim # property Horizontal coordinate.
Y: UDim # property Vertical coordinate.
Lerp(goal: UDim2, alpha: number): UDim2 # method Interpolate or extrapolate components; alpha is not clamped.
new(xScale?: number, xOffset?: number, yScale?: number, yOffset?: number): UDim2 # constructor Construct a coordinate pair; components default to zero.
fromScale(xScale?: number, yScale?: number): UDim2 # constructor Construct with zero offsets.
fromOffset(xOffset?: number, yOffset?: number): UDim2 # constructor Construct with zero scale.
Vector2 Studio playtest · datatype

2D vector value.

Member Kind Description
X: number # property X component.
Y: number # property Y component.
Magnitude: number # property Length of the vector.
new(x?: number, y?: number): Vector2 # constructor Construct a 2D vector.
Vector3 Studio playtest · datatype

3D vector value.

Member Kind Description
X: number # property X component.
Y: number # property Y component.
Z: number # property Z component.
Magnitude: number # property Length of the vector.
Unit: Vector3 # property Normalized copy.
Dot(o: Vector3): number # method Dot product.
Cross(o: Vector3): Vector3 # method Cross product.
new(x?: number, y?: number, z?: number): Vector3 # constructor Construct a 3D vector.
Enums Studio playtest
Enum.Shape Studio playtest
NameValue
Enum.Shape.Cube"Cube"
Enum.Shape.Slope"Slope"
Enum.Shape.Wedge"Wedge"
Enum.Shape.Spawnpoint"Spawnpoint"
Enum.Shape.Arch"Arch"
Enum.Shape.Dome"Dome"
Enum.Shape.Bars"Bars"
Enum.Shape.Flag"Flag"
Enum.Shape.Pole"Pole"
Enum.Shape.Cylinder"Cylinder"
Enum.Shape.RoundSlope"RoundSlope"
Enum.Shape.Vent"Vent"
Enum.Shape.Sphere"Sphere"
Enum.Material Studio playtest
NameValue
Enum.Material.Plastic"plastic"
Enum.Material.SmoothPlastic"smoothplastic"
Enum.Material.Neon"neon"
Enum.Material.Wood"wood"
Enum.Material.WoodPlanks"woodplanks"
Enum.Material.Marble"marble"
Enum.Material.Basalt"basalt"
Enum.Material.Slate"slate"
Enum.Material.CrackedLava"crackedlava"
Enum.Material.Concrete"concrete"
Enum.Material.Limestone"limestone"
Enum.Material.Granite"granite"
Enum.Material.Pavement"pavement"
Enum.Material.Brick"brick"
Enum.Material.Pebble"pebble"
Enum.Material.Cobblestone"cobblestone"
Enum.Material.Rock"rock"
Enum.Material.Sandstone"sandstone"
Enum.Material.CorrodedMetal"corrodedmetal"
Enum.Material.DiamondPlate"diamondplate"
Enum.Material.Foil"foil"
Enum.Material.Metal"metal"
Enum.Material.Grass"grass"
Enum.Material.LeafyGrass"leafygrass"
Enum.Material.Sand"sand"
Enum.Material.Fabric"fabric"
Enum.Material.Snow"snow"
Enum.Material.Mud"mud"
Enum.Material.Ground"ground"
Enum.Material.Asphalt"asphalt"
Enum.Material.Salt"salt"
Enum.Material.Ice"ice"
Enum.Material.Glacier"glacier"
Enum.Material.Glass"glass"
Enum.Material.ForceField"forcefield"
Enum.Material.Air"air"
Enum.Material.Water"water"
Enum.Material.Cardboard"cardboard"
Enum.Material.Carpet"carpet"
Enum.Material.CeramicTiles"ceramictiles"
Enum.Material.ClayRoofTiles"clayrooftiles"
Enum.Material.RoofShingles"roofshingles"
Enum.Material.Leather"leather"
Enum.Material.Plaster"plaster"
Enum.Material.Rubber"rubber"
Enum.PartType Studio playtest
NameValue
Enum.PartType.Block"Block"
Enum.PartType.Wedge"Wedge"
Enum.PartType.Cylinder"Cylinder"
Enum.KeyCode Studio playtest
NameValue
Enum.KeyCode.A"A"
Enum.KeyCode.B"B"
Enum.KeyCode.C"C"
Enum.KeyCode.D"D"
Enum.KeyCode.E"E"
Enum.KeyCode.F"F"
Enum.KeyCode.G"G"
Enum.KeyCode.H"H"
Enum.KeyCode.I"I"
Enum.KeyCode.J"J"
Enum.KeyCode.K"K"
Enum.KeyCode.L"L"
Enum.KeyCode.M"M"
Enum.KeyCode.N"N"
Enum.KeyCode.O"O"
Enum.KeyCode.P"P"
Enum.KeyCode.Q"Q"
Enum.KeyCode.R"R"
Enum.KeyCode.S"S"
Enum.KeyCode.T"T"
Enum.KeyCode.U"U"
Enum.KeyCode.V"V"
Enum.KeyCode.W"W"
Enum.KeyCode.X"X"
Enum.KeyCode.Y"Y"
Enum.KeyCode.Z"Z"
Enum.KeyCode.Space"Space"
Enum.KeyCode.Return"Return"
Enum.KeyCode.Escape"Escape"
Enum.KeyCode.LeftShift"LeftShift"
Enum.KeyCode.LeftControl"LeftControl"
Enum.KeyCode.Tab"Tab"
Enum.KeyCode.Up"Up"
Enum.KeyCode.Down"Down"
Enum.KeyCode.Left"Left"
Enum.KeyCode.Right"Right"
Enum.KeyCode.Zero"Zero"
Enum.KeyCode.One"One"
Enum.KeyCode.Two"Two"
Enum.KeyCode.Three"Three"
Enum.KeyCode.Four"Four"
Enum.KeyCode.Five"Five"
Enum.KeyCode.Six"Six"
Enum.KeyCode.Seven"Seven"
Enum.KeyCode.Eight"Eight"
Enum.KeyCode.Nine"Nine"
Enum.UserInputType Studio playtest
NameValue
Enum.UserInputType.MouseButton1"MouseButton1"
Enum.UserInputType.MouseButton2"MouseButton2"
Enum.UserInputType.MouseButton3"MouseButton3"
Enum.UserInputType.MouseMovement"MouseMovement"
Enum.UserInputType.MouseWheel"MouseWheel"
Enum.UserInputType.Keyboard"Keyboard"
Enum.UserInputType.Touch"Touch"
Enum.UserInputState Studio playtest
NameValue
Enum.UserInputState.Begin"Begin"
Enum.UserInputState.End"End"
Enum.UserInputState.Change"Change"
Enum.SortDirection Studio playtest
NameValue
Enum.SortDirection.Ascending"Ascending"
Enum.SortDirection.Descending"Descending"
Enum.RaycastFilterType Studio playtest
NameValue
Enum.RaycastFilterType.Include"Include"
Enum.RaycastFilterType.Exclude"Exclude"
Enum.Font Studio playtest
NameValue
Enum.Font.Legacy"Legacy"
Enum.Font.Arial"Arial"
Enum.Font.ArialBold"ArialBold"
Enum.Font.SourceSans"SourceSans"
Enum.Font.SourceSansBold"SourceSansBold"
Enum.Font.SourceSansLight"SourceSansLight"
Enum.Font.SourceSansItalic"SourceSansItalic"
Enum.EasingStyle Studio playtest
NameValue
Enum.EasingStyle.Linear"Linear"
Enum.EasingStyle.Sine"Sine"
Enum.EasingStyle.Quad"Quad"
Enum.EasingStyle.Cubic"Cubic"
Enum.EasingStyle.Quart"Quart"
Enum.EasingStyle.Quint"Quint"
Enum.EasingStyle.Exponential"Exponential"
Enum.EasingStyle.Circular"Circular"
Enum.EasingStyle.Back"Back"
Enum.EasingStyle.Bounce"Bounce"
Enum.EasingStyle.Elastic"Elastic"
Enum.EasingDirection Studio playtest
NameValue
Enum.EasingDirection.In"In"
Enum.EasingDirection.Out"Out"
Enum.EasingDirection.InOut"InOut"
Enum.PlaybackState Studio playtest
NameValue
Enum.PlaybackState.Begin"Begin"
Enum.PlaybackState.Delayed"Delayed"
Enum.PlaybackState.Playing"Playing"
Enum.PlaybackState.Paused"Paused"
Enum.PlaybackState.Completed"Completed"
Enum.PlaybackState.Cancelled"Cancelled"
Enum.FillDirection Studio playtest
NameValue
Enum.FillDirection.Horizontal"Horizontal"
Enum.FillDirection.Vertical"Vertical"
Enum.SortOrder Studio playtest
NameValue
Enum.SortOrder.Name"Name"
Enum.SortOrder.Custom"Custom"
Enum.SortOrder.LayoutOrder"LayoutOrder"
Enum.HorizontalAlignment Studio playtest
NameValue
Enum.HorizontalAlignment.Center"Center"
Enum.HorizontalAlignment.Left"Left"
Enum.HorizontalAlignment.Right"Right"
Enum.VerticalAlignment Studio playtest
NameValue
Enum.VerticalAlignment.Center"Center"
Enum.VerticalAlignment.Top"Top"
Enum.VerticalAlignment.Bottom"Bottom"
Enum.AspectType Studio playtest
NameValue
Enum.AspectType.FitWithinMaxSize"FitWithinMaxSize"
Enum.AspectType.ScaleWithParentSize"ScaleWithParentSize"
Enum.DominantAxis Studio playtest
NameValue
Enum.DominantAxis.Width"Width"
Enum.DominantAxis.Height"Height"
Globals Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Values available to hosted server scripts. Function calls return their result directly; do not append :await().

Member Kind Description
game: DataModel # value Root value. game:GetService(name) returns a supported service or raises an error. game.Workspace is also available.
workspace: Workspace # value The hosted world with replicated Folder, Model and Part hierarchies.
script: table # value Metadata for this script: id, filename, scriptType and sortOrder. This is not a client Script instance.
Lux: table # value Name, ApiVersion, Context and Language describe the running host. Language is a compatibility identifier.
Bridge: table # value Deprecated compatibility alias for existing hosted scripts. Prefer the supported services and Instance APIs for new code; see the migration guide.
task: table # value Managed scheduling library.
Enum: table # value Hosted easing, playback, layout, query-filter and datastore-sort constants; see Hosted enums.
Vector3: table # value Constructor table for hosted position and size values.
Color3: table # value Constructor table for hosted colour values.
TweenInfo: table # value Constructor table for animation timing.
NumberRange: table # value Constructor table for a numeric interval.
UDim: table # value Constructor table for scale/offset values.
UDim2: table # value Two-dimensional layout values, also used by supported server-authored GUI instances.
typeof(value): string # function Returns a native type name or the registered LuX datatype/instance/signal type. A user table cannot claim a type by setting ClassName.
print(...): nil # function Writes values to this script’s server log.
warn(...): nil # function Writes a warning to this script’s server log.
wait(seconds?): number # function Alias of task.wait. Suspends a managed task.
require(moduleName: string): any # function Loads a published server_storage module. Results are cached per script; cyclic and unknown modules raise errors.
assert(value: any, message: string?): any # function Return value when truthy; otherwise raise an error.
error(message: any, level: number?): void # function Raise a script error.
pcall(callback: function, ...: any): tuple # function Protected call; returns success followed by results or the error.
xpcall(callback: function, handler: function, ...: any): tuple # function Protected call with an error handler.
pairs(value: table): tuple # function Iterator over dictionary entries; order is unspecified.
ipairs(value: table): tuple # function Iterate sequential indices from 1 until the first nil.
next(value: table, key: any?): tuple # function Return the next key/value pair, or nil.
select(index: any, ...: any): tuple # function Select arguments; '#' returns their count.
tonumber(value: any, base: number?): number? # function Parse a number, or return nil when conversion fails.
tostring(value: any): string # function Convert a value to its text representation.
type(value: any): string # function Lua primitive type. Use typeof for engine datatypes.
unpack(values: table, first: number?, last: number?): tuple # function Return an array interval as multiple values.
getmetatable(value: any): any # function Return a metatable, protected metatable value, or nil.
setmetatable(value: table, metatable: table?): table # function Set a table's metatable; protected metatables cannot be replaced.
rawget(value: table, key: any): any # function Read a table key without __index.
rawset(value: table, key: any, item: any): table # function Write a table key without __newindex.
rawequal(left: any, right: any): boolean # function Compare without equality metamethods.
rawlen(value: any): number # function Length without __len.
_G: table # value Shared data proxy across scripts in this runtime session. Plain data is copied on assignment and read; reassign nested edits. Isolated from shared, other sessions and the network. Functions, userdata, metatables and cycles are rejected.
_VERSION: string # value Underlying Lua runtime version string; not the LuX API version.
gcinfo(): number # function Reports the hosted VM’s current memory usage in KiB.
math: table # value Hosted math library; see its reference section.
string: table # value Hosted string library; see its reference section.
table: table # value Hosted table library; see its reference section.
coroutine: table # value Hosted coroutine library; see its reference section.
bit32: table # value Hosted bit32 library; see its reference section.
os: table # value Hosted os library; see its reference section.
utf8: table # value Hosted utf8 library; see its reference section.
shared: table # value Session-local live object graphs preserve nested table identity, aliases and cycles across script VMs. Nested writes are immediately readable by other scripts in the same runtime. Tables assigned into shared are adopted as proxies. Functions, threads and unsupported userdata remain rejected. This is not network replication or persistent storage.
Random: table # value See the Random members and runtime limits.
unicode: table # value See the unicode members and runtime limits.
Instance: table # value See the Instance members and runtime limits.
Vector2: table # value See the Vector2 members and runtime limits.
CFrame: table # value See the CFrame members and runtime limits.
RaycastParams: table # value See the RaycastParams members and runtime limits.
OverlapParams: table # value See the OverlapParams members and runtime limits.
task Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Use these functions from hosted scripts and event callbacks. Spawn and defer queue work for the next scheduler turn. A task handle belongs to the script that created it.

Member Kind Description
task.wait(seconds = 0): number # function Yields the current managed task for a non-negative duration. Other callbacks can run while it sleeps.
task.spawn(callback, ...): thread # function Schedules a new managed task and passes arguments to its callback.
task.defer(callback, ...): thread # function Schedules a callback for a later scheduler turn.
task.delay(seconds, callback, ...): thread # function Schedules a callback after a non-negative delay.
task.cancel(handle): nil # function Cancels an owned suspended task and releases its timer or signal waiter. Running or foreign tasks are rejected; completed or cancelled handles are harmless.
Players Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Get this service with game:GetService("Players"). Servers have no LocalPlayer. Register PlayerAdded and also process GetPlayers() when initializing already connected players.

Member Kind Description
GetPlayers(): {Player} # method Returns fresh snapshots of connected players.
GetPlayerByUserId(userId): Player? # method Returns a fresh player snapshot or nil when absent.
PlayerAdded: Signal # event Callback receives the joining Player.
PlayerRemoving: Signal # event Callback receives the departing Player.
Player Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Player properties are snapshots. Read a new player from Players for current state. Use explicit setters to change authoritative state; assigning a field changes only your local table. Character is a server-backed state view, not a physical rig.

Member Kind Description
Name: string # property Account display name in this server.
UserId: number # property Authenticated user identifier.
ClassName: string # property Player.
Position: table # property Snapshot position with x, y and z components.
Health: number # property Snapshot current health.
MaxHealth: number # property Snapshot maximum health.
Speed: number # property Snapshot movement speed.
Score: number # property Snapshot score.
Alive: boolean # property Snapshot alive state.
Kick(reason = ""): boolean # method Disconnects this player.
SetPosition(position): table # method Teleports the player using a vector value. Returns a plain player-state snapshot.
SetHealth(health): table # method Sets health and returns a plain player-state snapshot.
SetMaxHealth(value: number): table # method Sets server maximum health in 0..100000 and returns a plain player-state snapshot. Native preview maximum health remains fixed at 100.
SetRotation(rotation: Vector3): table # method Sets server-authoritative player rotation and returns a plain player-state snapshot.
SetSpeech(text: string): table # method Sets speech text of at most 160 UTF-8 bytes. Returns a plain player-state snapshot.
GetTeam(): Team? # method Returns this connected player’s current Team view, or nil when unassigned.
SetTeam(team: Team): table # method Assigns a Team returned by the hosted Teams service. Arbitrary tables and unknown teams are rejected.
Chatted: Signal # event Callback receives the chat text sent by this player. Validate commands and game rules on the server.
SetWalkSpeed(speed): table # method Sets server-authoritative movement speed from 0 to 100.
SetJumpPower(power): table # method Sets server-authoritative jump power from 0 to 200.
Damage(amount): table # method Reduces health by a non-negative amount, clamped at zero.
Heal(amount): table # method Restores health by a non-negative amount, capped at MaxHealth.
Kill(): table # method Kills this player through the host lifecycle.
Respawn(): table # method Requests a respawn through the host lifecycle.
LoadCharacter(): table # method Requests a respawn; this does not construct a custom rig.
Teleport(position): table # method Sets the player world position.
SetScore(score): table # method Sets score and returns a plain player-state snapshot.
SetLeaderstat(name, value) # method Sets a named replicated leaderboard value. Maximum eight names per player; names at most 32 characters and values at most 64.
SetOverheadText(text) # method Sets a short overhead label visible to connected players.
GetLeaderstat(name): any # method Returns the current named value or nil.
RemoveLeaderstat(name) # method Removes a named leaderboard value. Leaderstats do not persist automatically.
PlayerGui: PlayerGui # property Private server-authored UI tree, replicated only to this player and destroyed when they disconnect. Hosted access is through the Player, not game:GetService("PlayerGui"); desktop local scripts use game.PlayerGui.
Character: Character # property Character state view with Humanoid and HumanoidRootPart. Call Refresh on it or its children for current values.
CharacterAdded: Signal # event Receives a character view after initial spawn or respawn.
CharacterRemoving: Signal # event Receives the character view when the player dies.
GetChildren(): {Instance} # method Returns Character and, when available, PlayerGui.
FindFirstChild(name: string): Instance? # method Finds PlayerGui or the Character by player name.
WaitForChild(name: string): Instance? # method Returns one of the supported children immediately or nil.
Character Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

A server-backed character state view. It is not a replicated body-part graph or a custom rig. Direct field assignment changes only this script’s snapshot.

Member Kind Description
Name: string # property Player name.
Alive: boolean # property Snapshot alive state.
Scale: Vector3 # property Snapshot character scale.
Humanoid: Humanoid # property Health and movement state view.
HumanoidRootPart: CharacterRoot # property Position and rotation state view.
Refresh(): Character # method Refreshes this view and its children from the connected player.
SetScale(scale: Vector3): nil # method Sets each server-authoritative scale component from 0.25 to 4, then refreshes the view.
GetChildren(): {Instance} # method Returns the Humanoid and HumanoidRootPart state views.
FindFirstChild(name: string): Instance? # method Finds either supported child by exact name.
WaitForChild(name: string): Instance? # method Returns a supported child immediately, or nil; this view does not create children later.
Humanoid Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Server-backed player health and movement values. Call Refresh to read changes made elsewhere; use explicit methods for writes.

Member Kind Description
Health: number # property Snapshot health.
MaxHealth: number # property Snapshot maximum health.
WalkSpeed: number # property Snapshot walk speed.
JumpPower: number # property Snapshot jump power.
Died: Signal # event Fires when this player dies.
Refresh(): Humanoid # method Refreshes player health and movement values.
TakeDamage(amount: number): nil # method Applies non-negative damage through the server.
Heal(amount: number): nil # method Restores non-negative health through the server.
SetHealth(value: number): nil # method Sets health within the server maximum.
SetMaxHealth(value: number): nil # method Sets server maximum health in 0..100000, then refreshes this view. Native preview maximum health remains fixed at 100.
SetWalkSpeed(value: number): nil # method Sets walk speed from 0 to 100.
SetJumpPower(value: number): nil # method Sets jump power from 0 to 200.
CharacterRoot Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Position and rotation view for a connected player; this is not a physics part or constraint attachment.

Member Kind Description
Position: Vector3 # property Snapshot world position.
Rotation: Vector3 # property Snapshot rotation.
Refresh(): CharacterRoot # method Refreshes position and rotation.
SetPosition(position: Vector3): nil # method Teleports through the server and refreshes the view.
SetRotation(rotation: Vector3): nil # method Sets server rotation and refreshes the view.
Workspace Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Stable Instance graph identity, parent-cycle checks, recursive clone/delete, authored folder/model imports and snapshot/delta replication. 20,000 nodes with bounded hierarchy depth. Workspace and ReplicatedStorage replicate. ServerStorage and detached physical parts are excluded from both graph snapshots and legacy map transport; private edits are not broadcast. Moving an already public object into ServerStorage cannot erase information previously sent to clients.

Member Kind Description
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
Raycast(origin: Vector3, direction: Vector3, params: RaycastParams?): RaycastResult? # method Query the nearest oriented part bounding box along a finite direction segment.
GetPartBoundsInBox(cframe: CFrame, size: Vector3, params: OverlapParams?): {BasePart} # method Find oriented bounds overlapping this box. Meshes and wedges use bounds, not their exact surfaces.
Part Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Server-authoritative part in the replicated graph. Parent is writable; nil-parent and ServerStorage parts are not visible in the client world.

Member Kind Description
Name: string # property Display name of the instance.
ClassName: string # property Read-only class name.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Class membership test.
GetFullName(): string # method
IsDescendantOf(other): boolean # method
IsAncestorOf(other): boolean # method
Destroy(): any # method Remove this brick.
Clone(): any # method Deep-copy this element and its children.
AddTag(tag): nil # method Adds a server-local tag.
RemoveTag(tag): nil # method Removes a server-local tag.
HasTag(tag): boolean # method Tests a tag.
GetTags(): {string} # method Returns this part’s tags.
Position: Vector3 # property World position (studs).
Size: Vector3 # property Alias of Scale.
Color: Color3 # property Brick color.
Transparency: number # property 0 opaque … 1 invisible.
Rotation: number # property Yaw rotation in degrees.
CanCollide: boolean # property Alias of Collision.
Anchored: boolean # property Saved with the place. True keeps the part fixed. The shared hosted solver supports false for boxes and uniform spheres; the standalone native host currently rejects false. Client scripts cannot control authoritative physics.
AssemblyMass(...) # method Supported hosted member. See the service contract and limits above.
AssemblyLinearVelocity(...) # method Supported hosted member. See the service contract and limits above.
AssemblyAngularVelocity(...) # method Supported hosted member. See the service contract and limits above.
ApplyImpulse(...) # method Supported hosted member. See the service contract and limits above.
ApplyImpulseAtPosition(...) # method Supported hosted member. See the service contract and limits above.
GetPivot(): CFrame # method
PivotTo(value: CFrame): any # method
CFrame: CFrame # property Part center and complete orientation in Y-up coordinates. Legacy Position uses map-corner coordinates.
GetTouchingParts(): {BasePart} # method Return collidable Workspace parts whose oriented bounds overlap this collidable Workspace part. Does not return Players and does not apply query filter params.
SetOverheadText(...) # method Supported hosted member. See the service contract and limits above.
SetMaterialForPlayer(player, material): boolean # method Changes this public part’s material for one connected player only. Pass nil to restore its authored material. The shared map is unchanged.
Touched(other: Part | Player?) # event Fires when another collidable Workspace part or live player begins overlapping this collidable part. Detection targets 20 Hz; fast movement between polls can be missed.
TouchEnded(other: Part | Player?) # event A detected overlap ended. The argument can be nil when the other instance was destroyed or player disconnected before dispatch.
Clicked(player: Player, secure: boolean) # event Authenticated sender for a published part click. Private/deleted parts are excluded and destruction disconnects listeners. The legacy secure flag is advisory: validate distance, cooldowns and game rules on the server.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this game. Nil detaches; self/descendant cycles are rejected.
RunService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Timing and execution context for the hosted server. Heartbeat targets 60 Hz and reports measured elapsed seconds; missed ticks are coalesced under load.

Member Kind Description
IsServer(): boolean # method Returns true.
IsClient(): boolean # method Returns false.
IsStudio(): boolean # method True for a local Studio-hosted playtest, otherwise false.
Heartbeat: Signal # event Callback receives dt in seconds. Use elapsed time rather than counting frames.
PathfindingService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Computes bounded horizontal routes around static rectangular parts, including yaw-rotated walls. It does not navigate terrain, slopes, meshes or elevation changes.

Member Kind Description
FindPath(start, goal, options = {}): table # method Returns status, waypoints and exploredNodes. Positions use the hosted world x/y plane with z as height. options supports cellSize (0.5–8), agentRadius (0–8) and agentHeight (0.5–16). Routes are limited to 256 world units, 2,048 parts and 4,096 explored nodes. Unsupported heights or geometry fail with a status instead of guessing a route.
FollowPart(part, destination, options = {}): table # method Moves an existing Workspace Part along a computed route on the hosted server. Returns a handle with Status, Waypoints and Stop(). options.speed is 0.5–32 studs per second; each script may have at most 16 active followers. The part itself is excluded from route obstacles. Character rigs, limb animation, moving-obstacle replanning and combat behavior are not supported.
CommerceService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Ownership checks and developer-product receipts scoped to this game. Ownership checks require a connected player. Purchases require the website checkout to be enabled; scripts must persist their own product grants before acknowledging a receipt.

Member Kind Description
UserOwnsItem(player, itemId): boolean # method Checks current catalog-item ownership on the site. Guests return false. Results are cached for 10 seconds; failed lookups raise an error rather than granting access. Fresh requests are capped at 120 per minute per game.
UserOwnsPass(player: Player, passId: number): boolean # method Checks permanent ownership of a pass belonging to this game. Guests and local playtests return false. Results are cached for 10 seconds; lookup failures raise an error. Item and pass lookups share a limit of 120 fresh requests per minute per game.
ProductReceipt: Signal # event Receives a table with ReceiptId, BuyerId, ProductId, PriceBits and PurchasedAt. Receipts include offline buyers and may be delivered repeatedly or to multiple running servers. The host polls at most 100 receipts every 5 seconds. Persist an idempotent grant keyed by ReceiptId before acknowledging; returning from a callback does not acknowledge a purchase.
AcknowledgeProductReceipt(receiptId: string): boolean # method Acknowledges a receipt previously delivered to this game instance, using its verified buyer and product identity. Returns true after the website confirms acknowledgement; unknown receipt IDs or failed requests raise an error. Only acknowledge after the grant is stored durably.
MessagingService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Game-scoped messages between running hosted instances. Delivery is best effort; this is not persistent storage. Topics contain 1–64 letters, digits, underscores, dots, colons or dashes. Payloads are JSON-compatible and limited to 4,096 bytes.

Member Kind Description
PublishAsync(topic: string, payload: any): boolean # method Publishes to this game’s running instances. The game shares a limit of 120 messages per minute. Failed publication raises an error.
SubscribeAsync(topic: string, callback: function): Connection # method Registers a callback receiving the payload for this topic. Call Disconnect on the returned connection to stop receiving. Instances poll approximately once per second; messages expire after two minutes and messages sent before an instance starts are not replayed.
NPCService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Creates server-owned NPCs that do not appear in Players. Each script may own eight NPCs; each game may have 32 animated native characters. Both controllers support basic damage, healing and navigation around static horizontal obstacles.

Member Kind Description
CreateRig(name: string, position: Vector3, options: table?): NPCRig # method Creates a Model of seven block parts with Health and MaxHealth values. Options: color (Color3), maxHealth (1–10,000), speed (0.5–32). The controller has Model, Root, Health, MaxHealth, Speed, Alive and Died. Limbs are not animated.
CreateCharacter(name: string, position: Vector3, options: table?): NPCCharacter # method Creates a server-owned character using the client’s animated body renderer. Options: maxHealth (1–10,000), speed (0.5–32). The controller has Id, Position, Health, MaxHealth, Speed, Alive and Died. This is separate from a player account.
NPCController Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Returned by NPCService:CreateRig or CreateCharacter. Names contain 1–64 visible characters. Advanced combat decisions, custom rigs and dynamic physics navigation are not implemented.

Member Kind Description
MoveTo(position: Vector3, speed: number?): table # method Starts bounded path-following, replacing the previous movement. The returned handle has Status and Stop. Speed defaults to the controller’s Speed and must be 0.5–32.
FollowPlayer(player: Player, speed: number?): table # method Follows a live connected player with periodic static-obstacle replanning. Movement stops when the target is absent or not alive.
Stop(): nil # method Cancels this controller’s current movement.
TakeDamage(amount: number): number # method Applies 0–10,000 damage, clamped at zero. Returns remaining health; at zero, stops movement and fires Died.
Heal(amount: number): number # method Restores 0–10,000 health while alive, capped at MaxHealth. Returns remaining health.
Destroy(): nil # method Stops movement, removes the NPC and releases its script-owned slot.
Died: Signal # event Receives this controller when its health reaches zero.
PhysicsService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Opt-in server-authoritative physics for boxes and uniformly sized spheres. Vectors use Y-up center coordinates. Existing parts remain anchored until configured otherwise. The world supports 64 dynamic bodies and 2,048 static colliders; character pushing, joints and mesh-triangle collision are not supported.

Member Kind Description
Configure(part: BasePart, options: table): nil # method Updates Anchored, Mass (0.01–10,000), Friction, Restitution, LinearDamping and AngularDamping (each 0–1). Unsupported geometry or settings raise an error. Dynamic transforms are published at up to 20 Hz.
GetState(part: BasePart): table # method Returns Anchored, Mass, Friction, Restitution, LinearDamping, AngularDamping, LinearVelocity, AngularVelocity and Sleeping. Velocity fields are Vector3 values.
SetGravity(gravity: Vector3): nil # method Sets the shared physics world’s gravity and wakes its bodies. The vector must be finite with magnitude at most 500.
HttpService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

JSON, identifier and URL utilities. This service does not perform outbound network requests.

Member Kind Description
HttpEnabled: boolean # property Always false.
JSONEncode(value): string # method Encodes JSON-compatible data. Rejects cycles, unsupported values, non-finite numbers and excessive complexity.
JSONDecode(text): any # method Decodes JSON. Maximum 1 MiB, depth 32 and 100,000 values.
GenerateGUID(includeBraces = true): string # method Returns a new identifier; pass false to omit braces.
UrlEncode(text): string # method Encodes a URL component.
UrlDecode(text): string # method Decodes a URL component.
CollectionService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Runtime Folder/Model/Part tags replicate to connected and late-joining clients. ServerStorage logical nodes/tags are excluded from graph snapshots. Changes are session state, not automatically saved in published maps. Maximum 32 tags per graph node.

Member Kind Description
AddTag(part, tag): nil # method Adds a tag to a hosted Workspace part.
RemoveTag(part, tag): nil # method Removes a tag.
HasTag(part, tag): boolean # method Tests membership.
GetTags(part): {string} # method Returns tags for one part.
GetAllTags(): {string} # method Returns tags used in this world.
GetTagged(tag): {Part} # method Returns parts with this tag.
GetInstanceAddedSignal(tag): Signal # method Callback receives a part when it gains this tag.
GetInstanceRemovedSignal(tag): Signal # method Callback receives a part when the tag is removed or the part is destroyed. Do not read properties of a destroyed part.
Debris Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Schedules real world-part deletion. Cleanup continues if the scheduling script finishes and stops with the game.

Member Kind Description
AddItem(part, lifetime = 10): nil # method Deletes a hosted part after this many seconds. Repeated scheduling keeps the earliest deadline. Maximum 1,000 queued parts.
TweenService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Animates hosted Part Position, Size, Color, Transparency and numeric Rotation. Creating a tween does not change the target until Play and a heartbeat.

Member Kind Description
Create(part, tweenInfo, goals): Tween # method Builds a tween for a table of supported target properties. Invalid goals or timing raise errors.
GetValue(alpha, style = "Quad", direction = "Out"): number # method Evaluates the same easing curves used by hosted tweens.
Tween Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Returned by TweenService:Create. Starting a conflicting property tween cancels the older active or paused tween. Maximum 256 retained tweens per script and 4,096 per game; Destroy releases one.

Member Kind Description
Instance: Part # property The animation target.
TweenInfo: TweenInfo # property The timing used by this tween.
PlaybackState: string # property Current Enum.PlaybackState value.
Play(): nil # method Starts or resumes. Replaying a finished or cancelled tween captures fresh starting values.
Pause(): nil # method Freezes elapsed time.
Cancel(): nil # method Stops at the current value and emits Completed with Cancelled.
Destroy(): nil # method Releases the tween and disconnects its completion listeners.
Completed: Signal # event Callback receives Completed or Cancelled playback state.
RemoteEvents Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Server side of named client/server messages. Payloads are JSON-compatible values, limited to 16 KiB, depth 32 and 4,096 values. Validate gameplay permissions, range, round state and cooldowns in the server callback.

Member Kind Description
OnServerEvent(name): Signal # method Callback receives the authenticated Player and payload. Names start with a letter; remaining characters may be letters, digits, underscore, dot, slash, colon or hyphen; maximum 96 characters.
FireClient(player, name, payload): boolean # method Sends a payload to one connected Player.
FireAllClients(name, payload): number # method Sends to all connected players and returns the recipient count.
Teams Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted team lookup and creation. Get this service with game:GetService("Teams"). These members do not imply matching desktop or native-preview support.

Member Kind Description
GetTeams(): {Team} # method Returns the teams currently available in this game.
GetChildren(): {Team} # method Alias of GetTeams.
FindFirstChild(name: string): Team? # method Finds an exact, case-sensitive team name, or nil.
CreateTeam(name: string, color: Color3 | string?): Team # method Creates a team, or returns the existing team with that name without changing its color. Names require 1–64 visible UTF-8 bytes without control characters. Color accepts Color3 or #RRGGBB and defaults to white.
Team Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Read-only hosted team view returned by Teams. Use player:SetTeam(team) to assign a connected player; this is not a freely parentable graph instance.

Member Kind Description
Name: string # property Current team name.
Color: Color3 # property Current team color.
GetPlayers(): {Player} # method Returns fresh Player snapshots currently assigned to this team.
IsA(className: string): boolean # method True for Team or Instance.
ChatService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted player-facing messages and authenticated input signals. Output text is limited to 1024 UTF-8 bytes; disallowed control characters are rejected. Targeted messages accept chat, top, center or bottom channels and a finite duration from 0 to 60 seconds, defaulting to chat and 5 seconds. This service does not provide cross-server delivery; use MessagingService for that.

Member Kind Description
Broadcast(text: string): boolean # method Broadcasts chat text to connected players.
MessagePlayer(player: Player, text: string, channel: string?, seconds: number?): boolean # method Sends text to one connected Player obtained from the hosted Players service.
MessageTeam(team: Team, text: string, channel: string?, seconds: number?): number # method Sends text to the current members of a hosted Team; returns the recipient count.
Chatted: Signal # event Callback receives the authenticated Player and chat text.
CommandReceived(player: Player, command: string, args: string) # event Callback receives the authenticated Player, command string and unsplit argument string for ordinary non-reserved commands. Authorize any game action before applying it.
BadgeService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted account-backed badges configured for this game. User and badge IDs must be positive safe integers. Guests and local playtests do not award account-backed badges or items. Handle backend failures with pcall; these members do not imply native-preview or client support.

Member Kind Description
AwardBadge(userId: number, badgeId: number): table # method Returns structured success, already_owned and item_granted fields. Guest success is a no-op, not proof of a durable award.
UserHasBadge(userId: number, badgeId: number): boolean # method Returns current ownership; guests return false.
GetGameBadges(): {table} # method Lists this game’s configured badges.
DataStoreService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Named/scoped standard and ordered stores, GetAsync/SetAsync/RemoveAsync/IncrementAsync/UpdateAsync, standard GetVersionAsync/ListVersionsAsync/RemoveVersionAsync and ordered GetSortedAsync. Versions retain mutation history and deletion tombstones; pages contain 1–100 rows. Ordered values must be safe integers; live keyset pages are not snapshot-stable during concurrent score changes. Existing SetAsync value return is preserved. Hosted CAS UpdateAsync retries at most 8 times and rejects yielding transforms. 4 MiB/value, depth64, 255-byte keys, 64 pending calls, budget600/minute burst120. Website migration is required. Studio persists locally; local host stores are ephemeral. Player clients cannot access storage directly.

Member Kind Description
GetDataStore(name: string, scope: string?): DataStore # method Open a standard scoped store. Names/keys require 1-255 UTF-8 bytes without control characters. Scope defaults to global.
GetGlobalDataStore(): DataStore # method Equivalent to GetDataStore('global'). Client access is denied.
GetOrderedDataStore(name: string, scope: string?): OrderedDataStore # method Open a game-scoped safe-integer store. Server-only; Studio uses local persistence.
GetLegacyDataStore(): LegacyDataStore # method Opens the existing game-wide raw-key namespace used by Bridge.datastore. Hosted only; no automatic migration.
GetLegacyPlayerDataStore(userId: number): LegacyDataStore # method Opens the existing player raw-key namespace. User ID must be a positive safe integer; guest data remains process-local. Hosted only.
LegacyDataStore Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Explicit hosted adapters for existing raw-key saves. These are not named, atomic or versioned stores, and GetGlobalDataStore does not refer to this namespace. Keys require 1–255 UTF-8 bytes without control characters. Handle failures with pcall; read/write pairs can race.

Member Kind Description
GetAsync(key: string): any # method Reads the existing raw-key value, or nil when absent.
SetAsync(key: string, value: any): boolean # method Writes validated JSON-compatible data of at most 1 MiB. Returns true on success, not a version or the saved value.
RemoveAsync(key: string): boolean # method Deletes the existing raw key and returns true on success, not the previous value.
GetKeys(scope: string?): table # method Global legacy handle only; player handles do not expose this method. Lists raw keys in the given scope, default global. Unpaged compatibility operation; not an atomic or versioned query.
SoundService Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Sends a sound playback request to compatible connected clients. Assets are first-party numeric IDs or HTTPS URLs; the client caps downloads at 16 MiB. Studio Sound authoring remains a separate surface.

Member Kind Description
PlayForClient(player, asset, options = {}): boolean # method Plays for one player. options supports volume (0–10) and pitch (0.05–4), both defaulting to 1.
PlayAll(asset, options = {}): number # method Requests playback for all players and returns the recipient count.
Values Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted values expose immutable component fields. The client datatype reference below is a separate surface; do not assume every client operation exists on the host.

Member Kind Description
Vector3.new(x = 0, y = 0, z = 0): Vector3 # function Constructs a finite vector with x/y/z and X/Y/Z fields.
Color3.new(r = 0, g = 0, b = 0): Color3 # function Constructs a colour from 0–1 components, with r/g/b and R/G/B fields.
Color3.fromRGB(r, g, b): Color3 # function Constructs a colour from 0–255 components.
TweenInfo.new(time = 1, style = "Quad", direction = "Out", repeats = 0, reverses = false, delay = 0): TweenInfo # function Fields are Time, EasingStyle, EasingDirection, RepeatCount, Reverses and DelayTime. RepeatCount is additional cycles; -1 repeats forever. Delay precedes each cycle.
NumberRange.new(minimum = 0, maximum = minimum): NumberRange # function Immutable Min and Max fields. Components must be finite and minimum must not exceed maximum.
UDim.new(scale = 0, offset = 0): UDim # function Immutable Scale and Offset fields. Supports addition, subtraction, negation and value equality.
UDim2.new(xScale = 0, xOffset = 0, yScale = 0, yOffset = 0): UDim2 # function Immutable X and Y UDim fields. Also accepts (xUDim, yUDim). Supports addition, subtraction, negation and value equality.
UDim2.fromScale(x, y): UDim2 # function Constructs with zero pixel offsets.
UDim2.fromOffset(x, y): UDim2 # function Constructs with zero scale components.
UDim2:Lerp(goal, alpha): UDim2 # method Interpolates all four components; alpha is not clamped. Call on a UDim2 value.
Signal Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Signals are event values. Connect callbacks with a colon. Callbacks can yield with task.wait without blocking later events.

Member Kind Description
Connect(callback): Connection # method Subscribes until disconnected.
Once(callback): Connection # method Disconnects on the first captured event before scheduling the callback.
Wait(): ... # method Suspends a managed task until the next event and returns its arguments. Unmanaged manually created coroutines cannot wait.
Connection.Connected: boolean # property Whether the subscription remains active.
Connection:Disconnect(): nil # method Disconnects and prevents callbacks that have not yet started.
Enums Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

These hosted enum tables use strings equal to their member names.

Member Kind Description
Enum.EasingStyle # value Linear, Sine, Quad, Cubic, Quart, Quint, Exponential, Circular, Back, Bounce, Elastic.
Enum.EasingDirection # value In, Out, InOut.
Enum.PlaybackState # value Begin, Delayed, Playing, Paused, Completed, Cancelled.
Enum.FillDirection # value Horizontal, Vertical. Values are strings equal to their member names.
Enum.SortOrder # value Name, Custom, LayoutOrder. Values are strings equal to their member names.
Enum.SortDirection # value Ascending, Descending. Values are strings equal to their member names.
Enum.RaycastFilterType # value Include, Exclude. Values are strings equal to their member names.
Enum.HorizontalAlignment # value Center, Left, Right. Values are strings equal to their member names.
Enum.VerticalAlignment # value Center, Top, Bottom. Values are strings equal to their member names.
Enum.AspectType # value FitWithinMaxSize, ScaleWithParentSize. Values are strings equal to their member names.
Enum.DominantAxis # value Width, Height. Values are strings equal to their member names.
Bridge Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Deprecated compatibility for existing hosted scripts, not the preferred API for new code. Bridge remains available; deprecation does not remove published scripts. It uses plain snapshots with lower-case fields, unlike Player and Part wrappers. Calls return directly. Player snapshots include userId, username, position, health, maxHealth, speed, score and alive; brick snapshots include id, name, position, scale and color.

Member Kind Description
Bridge.meta: table # value version and supportedEvents describe the running bridge.
Bridge.on(eventName, callback): function # function Subscribes to a supported event; returns a disconnect function. See Bridge events.
Bridge.messageAll(message): boolean # function Broadcasts chat text.
Bridge.messagePlayer(userId, message, channel = "chat", seconds = 5): boolean # function Sends a message to a player.
Bridge.messageTeam(team, message, channel = "chat", seconds = 5): number # function Sends a message to a team’s players.
Bridge.getPlayers(): {table} # function Returns connected-player snapshots. Prefer Players:GetPlayers when you need Player methods.
Bridge.setPlayerProperty(userId, property, value): table # function Sets health, maxHealth, scale, speed, jumpPower, position, rotation, score, speech, team or alive. Returns a fresh snapshot.
Bridge.kickPlayer(userId, reason = ""): boolean # function Disconnects a player.
Bridge.teleportPlayer(userId, position): table # function Sets player position.
Bridge.findBricksByName(names): {table} # function Finds exact names supplied as a string or array of strings.
Bridge.createBrick(descriptor): table # function Creates a brick from fields such as name, position, scale, color and clickable. Returns its snapshot including id.
Bridge.updateBrick(brickId, changes): table # function Changes a real brick and returns its snapshot. Uses scale and visibility rather than Part Size and Transparency.
Bridge.removeBrick(brickId): boolean # function Deletes a real brick.
Bridge.createTeam(descriptor): table # function Creates a team from name and color.
Bridge.fireClient(userId, name, payload): boolean # function Sends a named remote to one player.
Bridge.fireAllClients(name, payload): number # function Sends a named remote to every player.
Bridge.playSoundForClient(userId, asset, options = {}): boolean # function Sends a sound request to one player.
Bridge.playSoundForAll(asset, options = {}): number # function Sends a sound request to all players.
Bridge events Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Deprecated compatibility events. Prefer the supported Players, RunService and remote signals for new code. Existing scripts can subscribe with Bridge.on("eventName", callback). Arguments are listed below. playerDied and playerRespawn require lifecycle support from the running game host.

Member Kind Description
playerJoin(player) # event A player joined.
playerLeave(player) # event A player departed.
initialSpawn(player) # event A player initially spawned.
chat(player, message) # event A player sent chat.
command(player, command, args) # event Authenticated ordinary command input. Validate gameplay before applying it.
remoteEvent(player, name, payload) # event Validated named remote input; RemoteEvents offers a name-specific signal.
brickClick(player, brick, secure) # event A clickable brick was clicked. Validate gameplay state and distance.
heartbeat(dt, timestamp) # event Elapsed seconds and host timestamp in milliseconds.
playerDied(player) # event Supported player death notification.
playerRespawn(player) # event Supported player respawn notification.
Bridge datastore Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Deprecated compatibility storage. Prefer DataStoreService for new data, but named stores use separate namespaces: existing Bridge keys are not automatically migrated. Persistent values are scoped to the game. Guest player data is process-local and disappears when the game stops. Read/write pairs are not an atomic increment; handle failures with pcall.

Member Kind Description
Bridge.datastore.get(key): any # function Reads a game-wide value.
Bridge.datastore.set(key, value): boolean # function Writes a game-wide value.
Bridge.datastore.delete(key): boolean # function Deletes a game-wide key.
Bridge.datastore.keys(scope = "global"): table # function Lists keys in a scope.
Bridge.datastore.getPlayer(userId, key): any # function Reads a player-scoped value.
Bridge.datastore.setPlayer(userId, key, value): boolean # function Writes a player-scoped value.
Bridge.datastore.deletePlayer(userId, key): boolean # function Deletes a player-scoped value.
Bridge badges Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Deprecated compatibility badge calls, retained for existing hosted scripts. Uses badges configured for the game. Local playtests and guests do not award account-backed items. Do not infer native-preview support from this compatibility reference.

Member Kind Description
Bridge.badges.award(userId, badgeId): table # function Returns success, already_owned and item_granted information.
Bridge.badges.has(userId, badgeId): boolean # function Tests whether the account owns the badge. Guests return false.
Bridge.badges.list(): table # function Lists the game’s configured badges.
math Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted math library. Call functions with a dot, for example math.abs(...). Hosted strings use byte positions; use utf8 for Unicode code points. Desktop bulk-operation limits do not apply to native hosted functions.

Member Kind Description
abs(x: number): number # function Absolute value.
acos(x: number): number # function Inverse cosine in radians.
asin(x: number): number # function Inverse sine in radians.
atan(x: number): number # function Inverse tangent in radians.
ceil(x: number): number # function Round up.
cos(x: number): number # function Cosine of radians.
cosh(x: number): number # function Hyperbolic cosine.
deg(x: number): number # function Convert radians to degrees.
exp(x: number): number # function Euler's number raised to x.
floor(x: number): number # function Round down.
sin(x: number): number # function Sine of radians.
sinh(x: number): number # function Hyperbolic sine.
sqrt(x: number): number # function Square root.
tan(x: number): number # function Tangent of radians.
tanh(x: number): number # function Hyperbolic tangent.
rad(x: number): number # function Convert degrees to radians.
atan2(y: number, x: number): number # function Inverse tangent with quadrant selection.
fmod(x: number, y: number): number # function Remainder with the sign of x.
frexp(x: number): tuple # function Return mantissa and base-two exponent.
ldexp(mantissa: number, exponent: number): number # function Multiply mantissa by two raised to exponent.
log(x: number, base: number?): number # function Logarithm; natural logarithm when base is omitted.
max(...: number): number # function Largest argument.
min(...: number): number # function Smallest argument.
modf(x: number): tuple # function Return integer and fractional components.
pow(x: number, exponent: number): number # function Raise x to exponent.
random(lower: number?, upper: number?): number # function No arguments: random [0,1). One: integer [1,lower]. Two: integer [lower,upper].
randomseed(seed: number): void # function Seed this sandbox's pseudorandom generator; sequences differ across runtimes.
clamp(x: number, minimum: number, maximum: number): number # function Clamp to inclusive bounds; reversed bounds raise an error.
round(x: number): number # function Nearest integer; exact half values round away from zero.
sign(x: number): number # function Return -1, 0, or 1; NaN returns 0.
lerp(a: number, b: number, alpha: number): number # function Linear interpolation or extrapolation; alpha is not clamped.
map(x: number, inmin: number, inmax: number, outmin: number, outmax: number): number # function Map between numeric ranges without clamping; equal input bounds produce IEEE infinity or NaN.
isfinite(x: number): boolean # function True for finite numbers.
isinf(x: number): boolean # function True for positive or negative infinity.
isnan(x: number): boolean # function True for NaN.
pi: number # property Pi.
huge: number # property Positive infinity.
e: number # property Euler's number.
tau: number # property Two times pi.
sqrt2: number # property Square root of two.
phi: number # property Golden ratio.
nan: number # property Not-a-number; use math.isnan to test.
log10(x): number # function Base-ten logarithm.
noise(x, y = 0, z = 0): number # function Smooth coherent noise for one, two or three input coordinates.
string Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Global table.create/find/clone/clear/move/concat and table.unpack have portable entry/result limits. Global string.rep/split have portable output/input limits. Hosted native string method syntax such as value:rep resolves the readonly native metatable and does not use these wrappers. Other native library operations and operators are not newly bounded.

Member Kind Description
byte(value: string, first: number?, last: number?): tuple # function Returns numeric byte values at the requested one-based positions.
char(...: number): string # function Builds a string from numeric byte values.
find(value: string, pattern: string, init: number?, plain: boolean?): tuple # function Find a pattern or literal; return start/end and captures, or nil.
format(format: string, ...: any): string # function Format values using printf-style conversions.
gmatch(value: string, pattern: string): function # function Iterator over pattern matches.
gsub(value: string, pattern: string, replacement: any, count: number?): tuple # function Replace matches; returns resulting string and replacement count.
len(value: string): number # function Returns the byte length of a string.
lower(value: string): string # function Lowercase text.
upper(value: string): string # function Uppercase text.
match(value: string, pattern: string, init: number?): any # function First match or captures, or nil.
rep(value: string, count: number, separator: string?): string # function Repeat text with an optional separator; count and output are capped at 1048576 native string units.
reverse(value: string): string # function Reverse character units.
sub(value: string, first: number, last: number?): string # function Substring; negative positions count from the end.
split(value: string, separator: string?): table # function Literal separator split; empty separator splits bytes. Global wrapper caps input at 1 MiB and results at 100,000. Native method syntax has different limits.
pack(format, ...): string # function Encodes values into a binary string according to the format.
packsize(format): number # function Returns the byte size of a fixed-size packing format.
unpack(format, value, position = 1): ... # function Decodes a binary string; returns the decoded values followed by the next byte position.
table Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Global table.create/find/clone/clear/move/concat and table.unpack have portable entry/result limits. Global string.rep/split have portable output/input limits. Hosted native string method syntax such as value:rep resolves the readonly native metatable and does not use these wrappers. Other native library operations and operators are not newly bounded.

Member Kind Description
concat(values: table, separator: string?, first: number?, last: number?): string # function Join array values; maximum 100000 entries and 1048576 native string units of output.
insert(values: table, positionOrValue: any, value: any?): void # function Append a value, or insert before a supplied index.
remove(values: table, position: number?): any # function Remove and return an array element; defaults to last.
sort(values: table, compare: function?): void # function Sort the array in place.
pack(...: any): table # function Pack arguments; n stores the argument count including nil values.
unpack(values: table, first: number?, last: number?): tuple # function Return at most 10000 array entries as multiple values.
create(count: number, value: any?): table # function Creates an array of the requested size, optionally filling entries with the supplied value.
find(values: table, value: any, init: number?): number? # function Returns the first matching array index from an optional starting index, or nil.
clone(value: table): table # function Returns a shallow copy of the table.
clear(value: table): void # function Removes all entries while retaining allocated capacity.
move(source: table, first: number, last: number, target: number, destination: table?): table # function Copies an inclusive range into a target table, handling overlaps.
foreach(values, callback): any # function Calls callback(key, value) for table entries, stopping at its first non-nil result.
foreachi(values, callback): any # function Calls callback(index, value) for the array portion, stopping at its first non-nil result.
freeze(values): table # function Freezes this table against mutation and returns it; does not recursively freeze child tables.
isfrozen(values): boolean # function Reports whether a table is frozen.
getn(values): number # function Returns the table’s array length.
maxn(values): number # function Returns the largest positive numeric key, or zero.
coroutine Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted coroutine library. Call functions with a dot, for example coroutine.close(...). Hosted strings use byte positions; use utf8 for Unicode code points. Desktop bulk-operation limits do not apply to native hosted functions.

Member Kind Description
create(callback: function): thread # function Create a suspended coroutine.
resume(thread: thread, ...: any): tuple # function Resume and return success plus yielded/results or error.
running(): thread # function Return the running coroutine.
status(thread: thread): string # function Return suspended, running, normal, or dead.
wrap(callback: function): function # function Create a function that resumes the coroutine and propagates errors.
yield(...: any): tuple # function Suspend to the coroutine's caller.
close(thread): boolean, any? # function Closes a suspended coroutine. Prefer task.cancel for a handle created by task so associated scheduling is also released.
isyieldable(): boolean # function Reports whether the current coroutine can yield.
bit32 Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted bit32 library. Call functions with a dot, for example bit32.arshift(...). Hosted strings use byte positions; use utf8 for Unicode code points. Desktop bulk-operation limits do not apply to native hosted functions.

Member Kind Description
band(...: number): number # function Combine unsigned 32-bit values using AND.
bor(...: number): number # function Combine unsigned 32-bit values using OR.
bxor(...: number): number # function Combine unsigned 32-bit values using XOR.
bnot(value: number): number # function Bitwise complement.
btest(...: number): boolean # function True when bitwise AND is nonzero.
arshift(value: number, displacement: number): number # function Arithmetic right shift.
lshift(value: number, displacement: number): number # function Logical left shift.
rshift(value: number, displacement: number): number # function Logical right shift.
lrotate(value: number, displacement: number): number # function Rotate left.
rrotate(value: number, displacement: number): number # function Rotate right.
extract(value: number, field: number, width: number?): number # function Extract a bit field; default width 1.
replace(value: number, replacement: number, field: number, width: number?): number # function Replace a bit field; default width 1.
byteswap(value): number # function Reverses the byte order of a 32-bit value.
countlz(value): number # function Counts leading zero bits in the 32-bit value.
countrz(value): number # function Counts trailing zero bits in the 32-bit value.
os Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted os library. Call functions with a dot, for example os.clock(...). Hosted strings use byte positions; use utf8 for Unicode code points. Desktop bulk-operation limits do not apply to native hosted functions.

Member Kind Description
clock(): number # function Returns the runtime clock in seconds; useful for measuring elapsed execution time.
date(format: string?, timestamp: number?): any # function Format a date, or return date fields for *t; ! prefix requests UTC.
difftime(later: number, earlier: number): number # function Difference in seconds.
time(date: table?): number # function Unix timestamp now, or for supplied date fields.
utf8 Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted utf8 library. Call functions with a dot, for example utf8.char(...). Hosted strings use byte positions; use utf8 for Unicode code points. Desktop bulk-operation limits do not apply to native hosted functions.

Member Kind Description
char(...): string # function Encodes Unicode code points as a UTF-8 string.
charpattern: string # property Pattern matching one UTF-8 character sequence.
codepoint(value, first = 1, last = first): ... # function Returns code points at the selected byte positions; malformed input raises an error.
codes(value): iterator # function Iterates byte-position and code-point pairs.
len(value, first = 1, last = -1): number?, number? # function Counts code points; malformed input returns nil and the invalid byte position.
offset(value, count, position?): number? # function Finds the byte position of a code point relative to a starting position.
Folder Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Stable Instance graph identity, parent-cycle checks, recursive clone/delete, authored folder/model imports and snapshot/delta replication. 20,000 nodes with bounded hierarchy depth. Workspace and ReplicatedStorage replicate. ServerStorage and detached physical parts are excluded from both graph snapshots and legacy map transport; private edits are not broadcast. Moving an already public object into ServerStorage cannot erase information previously sent to clients.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this game. Nil detaches; self/descendant cycles are rejected.
Model Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted and desktop grouped PivotTo preserve complete CFrame translation, pitch, yaw and roll, including nested model pivots and clones. The client applies the replicated basis to visual and collision geometry. Hosted raycast/overlap/touch queries use oriented boxes. Opt-in part physics supports boxes and uniform spheres separately; grouped pivots do not create joints or constrained assemblies.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPivot(...) # method Supported hosted member. See the service contract and limits above.
PivotTo(...) # method Supported hosted member. See the service contract and limits above.
WorldPivot: CFrame # property Hosted model pivot. Reading is equivalent to GetPivot; assigning moves the model through PivotTo.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this game. Nil detaches; self/descendant cycles are rejected.
RemoteFunctions Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Authenticated RemoteFunction client InvokeServer and server InvokeClient support yielding callbacks, multiple/nil results, 10-second timeout, pending-call bounds and disconnect cleanup. Versioned values carry replicated graph Instance, Player and server GUI element identities inside arrays/string-keyed maps without interpreting ordinary tag-shaped user tables. Unreplicated, deleted, not-yet-resolved and another player's private GUI references become nil. GUI roots and client-only instances are not transferable. Visually hidden objects remain referenceable when their tree is replicated. Functions, cycles and mixed-key maps are rejected. Instance RemoteEvent uses the same typed codec and access checks; the older named RemoteEvents service remains plain JSON.

Member Kind Description
Get(name: string): RemoteFunction # method Get a named RemoteFunction. Uses the same bounded transport as replicated RemoteFunction instances.
RemoteFunction Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Authenticated RemoteFunction client InvokeServer and server InvokeClient support yielding callbacks, multiple/nil results, 10-second timeout, pending-call bounds and disconnect cleanup. Versioned values carry replicated graph Instance, Player and server GUI element identities inside arrays/string-keyed maps without interpreting ordinary tag-shaped user tables. Unreplicated, deleted, not-yet-resolved and another player's private GUI references become nil. GUI roots and client-only instances are not transferable. Visually hidden objects remain referenceable when their tree is replicated. Functions, cycles and mixed-key maps are rejected. Instance RemoteEvent uses the same typed codec and access checks; the older named RemoteEvents service remains plain JSON.

Member Kind Description
ClassName(...) # method Supported hosted member. See the service contract and limits above.
InvokeClient(player: Player, ...: any): ...any # method Invoke the selected client callback and yield for its bounded results, disconnect or 10-second timeout. Server-only.
OnServerInvoke: function? # property Assign the server callback. The first argument is the authenticated Player.
Name(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
RemoteEvent Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Authenticated RemoteFunction client InvokeServer and server InvokeClient support yielding callbacks, multiple/nil results, 10-second timeout, pending-call bounds and disconnect cleanup. Versioned values carry replicated graph Instance, Player and server GUI element identities inside arrays/string-keyed maps without interpreting ordinary tag-shaped user tables. Unreplicated, deleted, not-yet-resolved and another player's private GUI references become nil. GUI roots and client-only instances are not transferable. Visually hidden objects remain referenceable when their tree is replicated. Functions, cycles and mixed-key maps are rejected. Instance RemoteEvent uses the same typed codec and access checks; the older named RemoteEvents service remains plain JSON.

Member Kind Description
OnServerEvent(player: Player, ...: any) # event Authenticated sender followed by typed arguments. Validate game rules, distance and cooldowns in the handler.
FireClient(player: Player, ...: any) # method Send an event to one connected player. Private references they cannot access become nil.
FireAllClients(...: any) # method Send a separate visibility-filtered event to each connected player.
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
BindableEvent Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Event(...: any) # event Connect, Once or Wait for a session-local bindable event.
Fire(...: any) # method Schedule listeners in server script VMs. No network traffic is created.
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
BindableFunction Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Invoke(...: any): ...any # method Call OnInvoke with bounded typed values; hosted yielding callbacks have a 10-second timeout.
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
OnInvoke: function? # property Assign the single callback for this BindableFunction.
DataStore Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Named/scoped standard and ordered stores, GetAsync/SetAsync/RemoveAsync/IncrementAsync/UpdateAsync, standard GetVersionAsync/ListVersionsAsync/RemoveVersionAsync and ordered GetSortedAsync. Versions retain mutation history and deletion tombstones; pages contain 1–100 rows. Ordered values must be safe integers; live keyset pages are not snapshot-stable during concurrent score changes. Existing SetAsync value return is preserved. Hosted CAS UpdateAsync retries at most 8 times and rejects yielding transforms. 4 MiB/value, depth64, 255-byte keys, 64 pending calls, budget600/minute burst120. Website migration is required. Studio persists locally; local host stores are ephemeral. Player clients cannot access storage directly.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta: number?): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetVersionAsync(key: string, version: string): (any, DataStoreKeyInfo) # method Read a retained standard-store version, including deletion tombstones.
ListVersionsAsync(key: string, sortDirection: Enum.SortDirection?, minDate: number?, maxDate: number?, pageSize: number?): DataStoreVersionPages # method Page retained versions by timestamp. Bounds are Unix milliseconds.
RemoveVersionAsync(key: string, version: string) # method Permanently delete a retained revision. If it is the current revision, the current value is also removed; older revisions are not restored.
OrderedDataStore Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Named/scoped standard and ordered stores, GetAsync/SetAsync/RemoveAsync/IncrementAsync/UpdateAsync, standard GetVersionAsync/ListVersionsAsync/RemoveVersionAsync and ordered GetSortedAsync. Versions retain mutation history and deletion tombstones; pages contain 1–100 rows. Ordered values must be safe integers; live keyset pages are not snapshot-stable during concurrent score changes. Existing SetAsync value return is preserved. Hosted CAS UpdateAsync retries at most 8 times and rejects yielding transforms. 4 MiB/value, depth64, 255-byte keys, 64 pending calls, budget600/minute burst120. Website migration is required. Studio persists locally; local host stores are ephemeral. Player clients cannot access storage directly.

Member Kind Description
Name: string # property Store name.
Scope: string # property Store scope; defaults to global.
GetAsync(key: string): any # method Read the value, or nil if absent/deleted. Standard stores also return DataStoreKeyInfo as a second result.
SetAsync(key: string, value: any): any # method Write and return the stored value (LuX compatibility; not a version token). Nil is rejected; use RemoveAsync.
RemoveAsync(key: string): any # method Remove the current value and return its previous value. Standard stores preserve a tombstone revision.
IncrementAsync(key: string, delta: number?): number # method Add delta (default 1); absent values start at zero. Ordered stores require safe integer values and results.
UpdateAsync(key: string, transform: function): any # method Atomically transform a value. Callback cannot yield; nil cancels. Conflicts retry up to 8 times, so avoid callback side effects.
GetSortedAsync(ascending: boolean, pageSize: number?, minValue: number?, maxValue: number?): DataStorePages # method Read 1–100 rows per page sorted by value with deterministic key ties. Concurrent score edits can affect later pages.
StarterGui Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
BoolValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: boolean # property Typed value; Changed receives the new value. Invalid assignments are rejected.
IntValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: number # property Typed value; Changed receives the new value. Invalid assignments are rejected.
NumberValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: number # property Typed value; Changed receives the new value. Invalid assignments are rejected.
StringValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: string # property Typed value; Changed receives the new value. Invalid assignments are rejected.
ObjectValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: Instance? # property A graph Instance or nil, not a Player or GUI object. Clone retargets references to cloned descendants. Unreplicated targets are hidden from client-facing records.
Vector3Value Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: Vector3 # property Typed value; Changed receives the new value. Invalid assignments are rejected.
Color3Value Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: Color3 # property Typed value; Changed receives the new value. Invalid assignments are rejected.
CFrameValue Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.

Member Kind Description
Name(...) # method Supported hosted member. See the service contract and limits above.
ClassName(...) # method Supported hosted member. See the service contract and limits above.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(...) # method Supported hosted member. See the service contract and limits above.
GetFullName(...) # method Supported hosted member. See the service contract and limits above.
IsDescendantOf(...) # method Supported hosted member. See the service contract and limits above.
IsAncestorOf(...) # method Supported hosted member. See the service contract and limits above.
Destroy(...) # method Supported hosted member. See the service contract and limits above.
Clone(...) # method Supported hosted member. See the service contract and limits above.
AddTag(...) # method Supported hosted member. See the service contract and limits above.
RemoveTag(...) # method Supported hosted member. See the service contract and limits above.
HasTag(...) # method Supported hosted member. See the service contract and limits above.
GetTags(...) # method Supported hosted member. See the service contract and limits above.
GetPropertyChangedSignal(property: string): Signal # method Connect to changes of one property; read the current property in the callback.
GetAttributeChangedSignal(name: string): Signal # method Connect to changes or removal of one attribute.
SetAttribute(name: string, value: any?) # method Store a supported scalar or datatype attribute. Nil removes it.
GetAttribute(name: string): any? # method Read an attribute, or nil when absent.
GetAttributes(): table # method Return the current attribute values keyed by name.
FindFirstChildOfClass(className: string): Instance? # method Find the first immediate child with this exact class name.
Changed(propertyOrValue: any) # event ValueBase instances emit the new value; other instances emit the property name.
AncestryChanged(child: Instance, parent: Instance?) # event Fires when this instance or an ancestor is reparented.
ChildAdded(child: Instance) # event An immediate child was added.
ChildRemoved(child: Instance) # event An immediate child was removed.
DescendantAdded(descendant: Instance) # event A descendant entered the subtree.
DescendantRemoving(descendant: Instance) # event A descendant left the subtree; hosted callbacks are deferred.
Destroying() # event Runs when destroyed. Hosted queued callbacks can read a bounded readonly tombstone.
AttributeChanged(name: string) # event An attribute changed or was removed.
Parent: Instance? # property Reparent within this session; nil detaches. Private trees are not replicated.
Value: CFrame # property Typed value; Changed receives the new value. Invalid assignments are rejected.
DataStorePages Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Bounded pages from a server datastore query.

Member Kind Description
IsFinished: boolean # property True when no later page remains.
GetCurrentPage(): {table} # method Return the current rows without advancing.
AdvanceToNextPageAsync() # method Fetch the next page; hosted calls yield.
DataStoreVersionPages Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Bounded pages from a server datastore query.

Member Kind Description
IsFinished: boolean # property True when no later page remains.
GetCurrentPage(): {table} # method Return the current rows without advancing.
AdvanceToNextPageAsync() # method Fetch the next page; hosted calls yield.
ScreenGui Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
Enabled: bool # property Whether this screen draws. The same flag as Visible.
ZIndex: number # property Draw order among siblings, -4096..4096.
Frame Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
BackgroundColor3: Color3 # property Background colour.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
TextLabel Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
BackgroundColor3: Color3 # property Background colour.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Text content, limited to 4096 UTF-8 bytes. Accepted TextBox input updates this before FocusLost callbacks.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextColor3: Color3 # property Text colour.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
TextButton Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
BackgroundColor3: Color3 # property Background colour.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Text content, limited to 4096 UTF-8 bytes. Accepted TextBox input updates this before FocusLost callbacks.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextColor3: Color3 # property Text colour.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
Activated(player: Player) # event Button activation from an authenticated player with access to the visible tree. Use Connect; the returned connection has Disconnect.
MouseButton1Click(player: Player) # event Alias of Activated for hosted buttons. The callback receives the authenticated player.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
ImageLabel Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
Image: string # property Empty string or an HTTPS asset URL, at most 512 UTF-8 bytes. Numeric asset IDs are not accepted by this hosted property.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
ImageButton Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
Image: string # property Empty string or an HTTPS asset URL, at most 512 UTF-8 bytes. Numeric asset IDs are not accepted by this hosted property.
Activated(player: Player) # event Button activation from an authenticated player with access to the visible tree. Use Connect; the returned connection has Disconnect.
MouseButton1Click(player: Player) # event Alias of Activated for hosted buttons. The callback receives the authenticated player.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
TextBox Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
BackgroundColor3: Color3 # property Background colour.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
Text: string # property Text content, limited to 4096 UTF-8 bytes. Accepted TextBox input updates this before FocusLost callbacks.
TextSize: number # property Font size in pixels, clamped 1-100. Ignored while TextScaled is on.
TextColor3: Color3 # property Text colour.
TextScaled: bool # property Shrink the font to fit the element's box. Recomputed on every relayout.
FocusLost(enterPressed: boolean, inputObject: nil, player: Player) # event TextBox Text is updated first. Enter sets true; ordinary blur sets false. The sender must own the private tree or be viewing shared StarterGui. Only Connect/Disconnect are exposed on hosted GUI signals.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
ScrollingFrame Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
BackgroundColor3: Color3 # property Background colour.
BackgroundTransparency: number # property 0 opaque .. 1 invisible.
CanvasSize: UDim2 # property Authored scrollable canvas size.
ScrollingEnabled: bool # property Whether wheel/touch scrolling is enabled.
Position: UDim2 # property Position within the parent: scale of the parent's size plus a pixel offset, per axis.
Size: UDim2 # property Size: scale of the parent's size plus a pixel offset, per axis.
AnchorPoint: Vector2 # property Point (0-1 on each axis) that Position places. Default 0,0 - the top-left corner.
Visible: bool # property Whether the element draws.
ZIndex: number # property Draw order among siblings, -4096..4096.
LayoutOrder: number # property Sibling order when UIListLayout.SortOrder is LayoutOrder.
UIListLayout Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
Padding: UDim # property Space between siblings.
FillDirection: string # property Horizontal or Vertical.
SortOrder: string # property Name, Custom insertion order, or LayoutOrder.
HorizontalAlignment: string # property Left, Center, or Right.
VerticalAlignment: string # property Top, Center, or Bottom.
UIPadding Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
PaddingLeft: UDim # property Left inset.
PaddingRight: UDim # property Right inset.
PaddingTop: UDim # property Top inset.
PaddingBottom: UDim # property Bottom inset.
UISizeConstraint Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
MinSize: Vector2 # property Minimum dimensions.
MaxSize: Vector2 # property Maximum dimensions.
UIAspectRatioConstraint Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Readable/writable name, at most 512 UTF-8 bytes.
ClassName: string # property Read-only GUI class name.
Parent: Instance? # property ScreenGui parents to StarterGui or a player.PlayerGui root; other GUI nodes parent below a ScreenGui. Nil detaches. Cycles and excessive depth are rejected.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
IsA(className: string): boolean # method Exact class membership or Instance. GuiObject excludes ScreenGui, roots and layout components.
Clone(): Instance # method Deep-copy this GUI subtree into a detached tree. Event connections are not copied.
Destroy() # method Remove this GUI subtree and its hosted input callbacks.
AspectRatio: number # property Positive width divided by height.
AspectType: string # property FitWithinMaxSize or ScaleWithParentSize.
DominantAxis: string # property Width or Height.
PlayerGui Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.

Member Kind Description
Name: string # property Instance name.
ClassName: string # property Read-only class name.
GetChildren(): {Instance} # method Return direct children, preserving tree insertion order.
GetDescendants(): {Instance} # method Return all descendants in the current tree.
FindFirstChild(name: string, recursive: boolean?): Instance? # method Find an exact, case-sensitive name; recursive defaults to false.
WaitForChild(name: string, timeout: number?): Instance? # method Yield until a direct child exists. An optional timeout in seconds returns nil when elapsed.
Random Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Deterministic gameplay pseudorandom generator. Explicit seeds match across desktop and hosted LuX; not for secrets.

Member Kind Description
new(seed: number?): Random # constructor Create a private stream. Finite seed is floored and normalized modulo 2147483646; omitted seed varies.
NextInteger(minimum: number, maximum: number): number # method Uniform integer between inclusive signed 32-bit bounds.
NextNumber(minimum: number?, maximum: number?): number # method Random number in the ordered finite range, default 0..1; upper bound excluded except floating-point rounding.
Clone(): Random # method Copy the current generator state without advancing it.
NextUnitVector(): Vector3 # method Unit vector sampled uniformly on the sphere; trigonometric rounding may vary across runtimes.
unicode Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Portable Unicode scalar helpers, distinct from native string indexing. Reject invalid UTF-8/UTF-16; at most 100000 scalars and 1048576 native string units.

Member Kind Description
len(value: string): number # function Count Unicode scalars, not bytes, UTF-16 units or grapheme clusters.
char(...: number): string # function Build text from valid Unicode scalar values; surrogate code points are rejected.
codepoints(value: string): table # function Return an array of Unicode scalar values.
sub(value: string, first: number, last: number?): string # function Slice one-based inclusive scalar positions; negative indices count from the end.
CFrame Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Hosted and desktop grouped PivotTo preserve complete CFrame translation, pitch, yaw and roll, including nested model pivots and clones. The client applies the replicated basis to visual and collision geometry. Hosted raycast/overlap/touch queries use oriented boxes. Opt-in part physics supports boxes and uniform spheres separately; grouped pivots do not create joints or constrained assemblies.

Member Kind Description
new(...: any?): CFrame # constructor Construct identity, from a Vector3, from x/y/z, from position and target Vector3s, from x/y/z plus quaternion x/y/z/w, or from x/y/z plus nine row-major rotation entries.
identity: CFrame # property Zero position and identity rotation on the CFrame constructor table.
Angles(rx: number, ry: number, rz: number): CFrame # constructor Creates a rotation-only CFrame from XYZ Euler angles in radians.
fromEulerAnglesXYZ(rx: number, ry: number, rz: number): CFrame # constructor Alias of Angles.
fromOrientation(rx: number, ry: number, rz: number): CFrame # constructor Rotation-only frame in YXZ order; angles are radians.
fromEulerAnglesYXZ(rx: number, ry: number, rz: number): CFrame # constructor Alias of fromOrientation.
fromAxisAngle(axis: Vector3, angle: number): CFrame # constructor Rotation around a finite nonzero axis by radians.
fromMatrix(position: Vector3, right: Vector3, up: Vector3, back: Vector3?): CFrame # constructor Construct from position and basis columns. Back defaults to right cross up.
lookAt(at: Vector3, target: Vector3, up: Vector3?): CFrame # constructor Face the target from at; local -Z is forward. Default up is world +Y.
lookAlong(at: Vector3, direction: Vector3, up: Vector3?): CFrame # constructor Face a nonzero direction from at; local -Z is forward.
X: number # property X position.
Y: number # property Y position.
Z: number # property Z position.
Position: Vector3 # property Position component.
p: Vector3 # property Position component (legacy alias).
LookVector: Vector3 # property Forward direction (-Z) of the rotation.
RightVector: Vector3 # property Right direction (+X) of the rotation.
UpVector: Vector3 # property Up direction (+Y) of the rotation.
XVector: Vector3 # property Alias of RightVector.
YVector: Vector3 # property Alias of UpVector.
ZVector: Vector3 # property Back (+Z) direction, opposite LookVector.
Rotation: CFrame # property Rotation only, with zero position.
Inverse(): CFrame # method Returns the inverse CFrame.
ToWorldSpace(other: CFrame): CFrame # method Composes this CFrame with another: this * other.
ToObjectSpace(other: CFrame): CFrame # method Expresses another CFrame relative to this one.
PointToWorldSpace(point: Vector3): Vector3 # method Transform a point including translation.
PointToObjectSpace(point: Vector3): Vector3 # method Inverse-transform a world point including translation.
VectorToWorldSpace(vector: Vector3): Vector3 # method Rotate a direction without translation.
VectorToObjectSpace(vector: Vector3): Vector3 # method Inverse-rotate a direction without translation.
GetComponents(): (number, number, number, number, number, number, number, number, number, number, number, number) # method Return 12 numbers: x, y, z followed by nine row-major rotation entries; not a table.
components(): (number, number, number, number, number, number, number, number, number, number, number, number) # method Legacy alias of GetComponents; returns 12 numbers.
ToAxisAngle(): (Vector3, number) # method Return axis and angle in radians as two values, not a table.
FuzzyEq(other: CFrame, epsilon: number?): bool # method Compare every position and basis component; epsilon defaults to 0.00001.
Lerp(goal: CFrame, alpha: number): CFrame # method Linearly interpolate position and spherically interpolate rotation.
Vector2 Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Immutable Vector2/Vector3 values provide arithmetic, Dot, Lerp, Magnitude and Unit; Vector3 also provides Cross and componentwise multiply/divide. Hosted Part Position/Size retain legacy Bridge axis conventions; CFrame uses the desktop center-space convention.

Member Kind Description
new(x: number?, y: number?): Vector2 # constructor Creates a Vector2.
zero: Vector2 # property Zero vector on the constructor table.
one: Vector2 # property All-one vector on the constructor table.
X: number # property X component.
Y: number # property Y component.
Magnitude: number # property Length of the vector.
Unit: Vector2 # property Normalized vector; zero remains zero.
Dot(other: Vector2): number # method Dot product.
Lerp(other: Vector2, alpha: number): Vector2 # method Linear interpolation; alpha is not clamped.
Vector3 Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Immutable Vector2/Vector3 values provide arithmetic, Dot, Lerp, Magnitude and Unit; Vector3 also provides Cross and componentwise multiply/divide. Hosted Part Position/Size retain legacy Bridge axis conventions; CFrame uses the desktop center-space convention.

Member Kind Description
new(x: number?, y: number?, z: number?): Vector3 # constructor Creates a Vector3.
zero: Vector3 # property Zero vector on the constructor table.
one: Vector3 # property All-one vector on the constructor table.
xAxis: Vector3 # property Unit axis vector on the constructor table.
yAxis: Vector3 # property Unit axis vector on the constructor table.
zAxis: Vector3 # property Unit axis vector on the constructor table.
X: number # property X component.
Y: number # property Y component.
Z: number # property Z component.
Magnitude: number # property Length of the vector.
Unit: Vector3 # property Normalized vector; zero remains zero.
Dot(other: Vector3): number # method Dot product.
Cross(other: Vector3): Vector3 # method Cross product.
Lerp(other: Vector3, alpha: number): Vector3 # method Linear interpolation; alpha is not clamped.
RaycastParams Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Workspace Raycast/GetPartBoundsInBox query published Workspace part oriented bounds in Y-up coordinates, with Include/Exclude descendant filters and optional RespectCanCollide. GetTouchingParts returns only collidable overlapping Workspace parts and requires the source to be collidable; Touched/TouchEnded additionally report live players. TouchEnded may pass nil if the other instance was destroyed or player disconnected. MaxParts 0 uses the 20,000 graph cap; filter lists <=256, watched parts <=256, touch polling targets 20 Hz without substeps. Only Default collision group; IgnoreWater has no effect because there is no water geometry. Invisible replicated parts remain queryable. Meshes/wedges use bounds, not triangle-accurate geometry. Fast motion between polls can be missed.

Member Kind Description
new(): RaycastParams # constructor Create default exclusion-filter options.
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
IgnoreWater: boolean # property Compatibility option; these queries do not include terrain or water.
CollisionGroup: string # property Only Default is accepted.
OverlapParams Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Workspace Raycast/GetPartBoundsInBox query published Workspace part oriented bounds in Y-up coordinates, with Include/Exclude descendant filters and optional RespectCanCollide. GetTouchingParts returns only collidable overlapping Workspace parts and requires the source to be collidable; Touched/TouchEnded additionally report live players. TouchEnded may pass nil if the other instance was destroyed or player disconnected. MaxParts 0 uses the 20,000 graph cap; filter lists <=256, watched parts <=256, touch polling targets 20 Hz without substeps. Only Default collision group; IgnoreWater has no effect because there is no water geometry. Invisible replicated parts remain queryable. Meshes/wedges use bounds, not triangle-accurate geometry. Fast motion between polls can be missed.

Member Kind Description
new(): OverlapParams # constructor Create default exclusion-filter options.
FilterDescendantsInstances: table # property Up to 256 live Instances; filtering includes descendants.
FilterType: Enum.RaycastFilterType # property Include or Exclude (default Exclude).
RespectCanCollide: boolean # property When true, skip noncollidable bricks. Default false.
CollisionGroup: string # property Only Default is accepted.
MaxParts: number # property Result limit 0-20,000. Zero uses the 20,000 safety cap.
RaycastResult Hosted server@if (!empty($entry['deprecated'])) · Deprecated compatibility@endif

Workspace Raycast/GetPartBoundsInBox query published Workspace part oriented bounds in Y-up coordinates, with Include/Exclude descendant filters and optional RespectCanCollide. GetTouchingParts returns only collidable overlapping Workspace parts and requires the source to be collidable; Touched/TouchEnded additionally report live players. TouchEnded may pass nil if the other instance was destroyed or player disconnected. MaxParts 0 uses the 20,000 graph cap; filter lists <=256, watched parts <=256, touch polling targets 20 Hz without substeps. Only Default collision group; IgnoreWater has no effect because there is no water geometry. Invisible replicated parts remain queryable. Meshes/wedges use bounds, not triangle-accurate geometry. Fast motion between polls can be missed.

Member Kind Description
Instance: Part # property Hit brick Instance.
Position: Vector3 # property World hit position.
Normal: Vector3 # property Outward unit surface normal.
Distance: number # property Distance from ray origin.
Material: string # property Brick material.
Hosted limits Hosted server

These limits come from the release capabilities. Handle rejected operations and check optional results before using them.

serviceBindings
Standard hosted services do not depend on the public Bridge global. Bridge remains a deprecated compatibility API for existing server scripts. The native C++ preview and desktop runtimes have separate capability limits; this hosted catalog does not claim native or desktop parity.
chat
Server-only ChatService broadcasts and sends to connected Players or game Teams using chat/top/center/bottom channels. Text is at most 1024 UTF-8 bytes, with control characters other than tab/newline rejected. Display duration is 0..60 seconds. Chatted and CommandReceived carry the authenticated sender; reserved engine commands are not delivered. This does not add filtering or a moderation system.
teams
Session-local hosted Teams exposes listing, exact-name lookup, creation, membership queries and Player:GetTeam/SetTeam. Names are 1..64 visible UTF-8 bytes; colors accept Color3 or #RRGGBB. A game has at most 255 teams. Creation returns an existing same-name team without changing its color. Team views are readonly; deletion, neutral teams and TeamAdded/Removed signals are not implemented.
badges
Hosted BadgeService uses the game's authenticated badge endpoints. AwardBadge returns success/already_owned/item_granted; UserHasBadge returns a boolean; GetGameBadges returns the game's badge rows. User and badge IDs must be positive integers. Guests produce a no-op award and own no badges. Scripts cannot create badges or grant another game's badges.
legacyStorage
GetLegacyDataStore and GetLegacyPlayerDataStore explicitly open the existing raw global/player-key save namespaces, not the hashed named-store namespace. GetAsync/SetAsync/RemoveAsync preserve those keys; SetAsync validates JSON up to 1 MiB. Only the global handle has GetKeys(scope), which is the old unpaged key list. These adapters have no UpdateAsync, version history, atomic increments or pagination. New games should use named standard stores.
partClicks
Hosted Part.Clicked(player, secure) maps the existing published-part click event to an authenticated Player. Private/deleted parts are excluded. Disconnect releases the script subscription. The secure flag is legacy advisory information, not authorization: validate distance, cooldowns and game rules yourself.
partPhysics
Opt-in authoritative boxes/uniform spheres in the shared hosted and Studio playtest host; existing parts stay anchored. PhysicsService Configure/GetState/SetGravity, Part Anchored/AssemblyMass/AssemblyLinearVelocity/AssemblyAngularVelocity/ApplyImpulse/ApplyImpulseAtPosition. Y-up centre-space vectors. Up to 64 dynamic parts, 2048 static colliders plus finite baseplate; 120 Hz bounded integration and up to 20 Hz transform publication. Mass .01..10000, friction/restitution/damping 0..1. Sleeping, private/destroyed cleanup and late-join transforms supported. Authored partPhysics metadata works without scripts. No character pushing, constraints, mesh-triangle collision, continuous collision detection, moving-platform carry or standalone native-host solver.
npc
NPCService.CreateCharacter creates a server-owned native bot rendered through the animated character path. CreateRig creates a seven-part block Model with Health and MaxHealth values. Both controllers support damage, healing, MoveTo, FollowPlayer, Stop, Destroy and a Died signal. Each script is limited to eight NPCs and each game to 32 native bots. Movement replans against static horizontal obstacles; advanced combat decisions and dynamic physics are not implemented.
messaging
MessagingService carries game-scoped JSON between live hosted instances. Topics use 1–64 letters, digits, underscores, dots, colons or dashes; payloads are at most 4096 bytes. A game may publish 120 messages per minute. Instances poll approximately once per second; messages expire after two minutes. Delivery is best effort and messages published before an instance starts are not replayed. This is not a durable queue.
commerce
UserOwnsItem and UserOwnsPass check a connected account's item or game-pass ownership; guests return false. Ownership results cache for 10 seconds and share a 120-check/minute budget. Lookup failure raises an error. ProductReceipt delivers up to 100 pending game-scoped receipts per 5-second poll, including offline buyers, and retries unacknowledged receipts. Persist a grant idempotently using ReceiptId before AcknowledgeProductReceipt. Multiple instances may receive the same receipt. No automatic grant or acknowledgement occurs. Scripts cannot prompt purchases or charge currency. Website pass checkout and developer-product checkout have separate default-off settings. These APIs are for the hosted LuX runtime, not the native C++ preview.
navigation
FindPath plans a horizontal route through at most 2048 static rectangular parts within 256 studs, with a 4096-node search limit. Yaw-rotated rectangles are supported; slopes, vertical routes, moving-obstacle replanning and full-basis collision are not. FollowPart moves an existing Workspace part on the server at 10 updates/second, speed 0.5–32, with at most 16 active followers per script. NPCService creates a separate block rig and supports basic path-following; limb animation and combat behavior are not supported.
instanceEvents
Supported graph classes expose lifecycle, property and attribute signals; server GUI objects have their separate, narrower event surface. ValueBase Changed receives the new value; other Changed signals receive the property name. Hosted events run on the deferred script scheduler. Attributes are capped at 128 entries with finite scalar/string/Vector3/Color3/CFrame values. Up to 2048 destroyed graph instances retain readonly tombstones for queued callbacks, not mutable access. Bindable events/functions cross server script VMs using bounded plain data and Instance references; functions cannot be passed as arguments. Hosted BindableFunction has a 10-second timeout.
leaderstats
Server-authoritative named values, maximum 8 per player; names 32 characters, values 64 characters. Replicated and replayed on join; not persisted automatically. Uses explicit Player methods, not Instance Folder/Value objects.
heartbeatTargetHz
60
commandInput
ChatService.CommandReceived receives an existing client COMMAND packet as authenticated Player, command, args. Reserved engine commands are suppressed. Game scripts must still validate round state, distance, and cooldowns. Bridge.on('command') remains a legacy snapshot compatibility alias.
remoteEvents
RemoteEvents.OnServerEvent(name), FireClient and FireAllClients use authenticated player identity, event-name validation, and a 16 KiB JSON payload limit. Server scripts must validate ability state, distance and cooldowns.
soundAssets
SoundService accepts a first-party numeric asset ID or HTTPS URL. The client resolves numeric IDs through the BrickBit asset endpoint and enforces a 16 MiB download cap.
heartbeatScheduling
Measured elapsed dt; missed ticks skipped and queued ticks coalesced under load
collectionScope
Runtime Folder/Model/Part tags replicate to connected and late-joining clients. ServerStorage logical nodes/tags are excluded from graph snapshots. Changes are session state, not automatically saved in published maps. Maximum 32 tags per graph node.
hierarchy
Stable Instance graph identity, parent-cycle checks, recursive clone/delete, authored folder/model imports and snapshot/delta replication. 20,000 nodes with bounded hierarchy depth. Workspace and ReplicatedStorage replicate. ServerStorage and detached physical parts are excluded from both graph snapshots and legacy map transport; private edits are not broadcast. Moving an already public object into ServerStorage cannot erase information previously sent to clients.
vectors
Immutable Vector2/Vector3 values provide arithmetic, Dot, Lerp, Magnitude and Unit; Vector3 also provides Cross and componentwise multiply/divide. Hosted Part Position/Size retain legacy Bridge axis conventions; CFrame uses the desktop center-space convention.
colors
Color3.new/fromRGB return immutable r/g/b and R/G/B values. Part Color also accepts #RRGGBB strings.
debris
Workspace parts only. AddItem default lifetime is 10 seconds; repeated scheduling keeps the earliest deadline. Maximum 1000 pending parts. Deletion survives the scheduling script ending but stops with the game.
tweens
Workspace parts only: Position, Size, Color, Transparency and numeric yaw Rotation. Play/Pause/Cancel/Destroy, PlaybackState and Completed(state) are supported with delay, repeat and reverse. Maximum 256 retained tweens per script and 4096 per game; Destroy releases unused tweens. Conflicting properties cancel the older tween.
httpEnabled
false
jsonMaxBytes
1048576
jsonMaxDepth
32
timersPerScript
1024
listenersPerScript
1024
pendingEvents
1024
serverScriptsPerGame
128
scriptMaxBytes
1048576
moduleSourceMaxBytes
4194304
modelPivot
Hosted and desktop grouped PivotTo preserve complete CFrame translation, pitch, yaw and roll, including nested model pivots and clones. The client applies the replicated basis to visual and collision geometry. Hosted raycast/overlap/touch queries use oriented boxes. Opt-in part physics supports boxes and uniform spheres separately; grouped pivots do not create joints or constrained assemblies.
remoteFunctions
Authenticated RemoteFunction client InvokeServer and server InvokeClient support yielding callbacks, multiple/nil results, 10-second timeout, pending-call bounds and disconnect cleanup. Versioned values carry replicated graph Instance, Player and server GUI element identities inside arrays/string-keyed maps without interpreting ordinary tag-shaped user tables. Unreplicated, deleted, not-yet-resolved and another player's private GUI references become nil. GUI roots and client-only instances are not transferable. Visually hidden objects remain referenceable when their tree is replicated. Functions, cycles and mixed-key maps are rejected. Instance RemoteEvent uses the same typed codec and access checks; the older named RemoteEvents service remains plain JSON.
dataStores
Named/scoped standard and ordered stores, GetAsync/SetAsync/RemoveAsync/IncrementAsync/UpdateAsync, standard GetVersionAsync/ListVersionsAsync/RemoveVersionAsync and ordered GetSortedAsync. Versions retain mutation history and deletion tombstones; pages contain 1–100 rows. Ordered values must be safe integers; live keyset pages are not snapshot-stable during concurrent score changes. Existing SetAsync value return is preserved. Hosted CAS UpdateAsync retries at most 8 times and rejects yielding transforms. 4 MiB/value, depth64, 255-byte keys, 64 pending calls, budget600/minute burst120. Website migration is required. Studio persists locally; local host stores are ephemeral. Player clients cannot access storage directly.
serverGui
ScreenGui/Frame/TextLabel/TextButton/ImageLabel/ImageButton/TextBox/ScrollingFrame plus UIListLayout/UIPadding/UISizeConstraint/UIAspectRatioConstraint. Hosted player.PlayerGui is a private tree; StarterGui remains a live all-player UI source. Desktop local scripts use game.PlayerGui. FocusLost(enterPressed, nil, player) updates Text before invoking handlers with the authenticated private-tree owner or shared-tree viewer. Buttons and text inputs validate visibility and ancestry, but game rules still require server validation. Private trees are destroyed on player disconnect. Late-join snapshots, edits, reparenting and removal are supported below core menus. The 512-node cap is shared across the entire game, not per player; depth 64 and 4096 UTF-8 bytes per Text value. Only button activation and TextBox FocusLost are uplinked; hosted GUI signals expose Connect/Disconnect, not Once/Wait or graph lifecycle/attribute signals. Images require HTTPS URLs. Advanced flex/grid/wrapping, GUI tweens and automatic StarterGui template cloning remain separate features.
spatialQueries
Workspace Raycast/GetPartBoundsInBox query published Workspace part oriented bounds in Y-up coordinates, with Include/Exclude descendant filters and optional RespectCanCollide. GetTouchingParts returns only collidable overlapping Workspace parts and requires the source to be collidable; Touched/TouchEnded additionally report live players. TouchEnded may pass nil if the other instance was destroyed or player disconnected. MaxParts 0 uses the 20,000 graph cap; filter lists <=256, watched parts <=256, touch polling targets 20 Hz without substeps. Only Default collision group; IgnoreWater has no effect because there is no water geometry. Invisible replicated parts remain queryable. Meshes/wedges use bounds, not triangle-accurate geometry. Fast motion between polls can be missed.

Not yet shared across contexts

  • Classes not listed in the versioned capability contract and their inherited APIs/events
  • Standalone native-host rigid-body physics, joints/constraints, character pushing and mesh-triangle collision
  • Advanced GUI flex/grid/wrapping and automatic StarterGui template cloning
  • Platform-managed datastore retention, metadata and snapshot-stable ordered pagination
  • Unified autocomplete context schema for every runtime-only member