[][src]Crate rbx_types

Structs

Axes

Represents a set of zero or more 3D axes.

BinaryString

Container for untyped binary data.

CFrame

Represents a position and orientation in 3D space.

Color3

Represents any color, including HDR colors.

Color3uint8

Represents non-HDR colors, i.e. those whose individual color channels do not exceed 1. This type is used for serializing properties like BasePart.Color, but is not exposed as a distinct type to Lua code.

ColorSequence

A series of colors that can be tweened through.

ColorSequenceKeypoint

A single color and point in time of a ColorSequence

Content

A reference to a Roblox asset.

CustomPhysicalProperties

Custom physics properties that can be given to parts.

EnumValue

Represents any Roblox enum value.

Faces

Represents a set of zero or more faces of a cube.

Matrix3

Used to represent the orientation field of CFrame and not a standalone type in Roblox.

NumberRange

A range between two numbers.

NumberSequence

A sequence of numbers on a timeline. Each point contains a timestamp, a value, and a range that allows for randomized values.

NumberSequenceKeypoint

A single value, envelope, and point in time of a NumberSequence

Ray

Represents a ray in 3D space. Direction does not have to be a unit vector, and is used by APIs like Workspace:FindPartOnRay to set a max distance.

Rect

Represents a bounding rectangle in 2D space.

Ref

A reference to a Roblox instance.

Region3

Represents a bounding box in 3D space.

Region3int16

A version of Region3 that uses signed 16-bit integers instead of floats. Region3int16 is generally used in Terrain APIs.

SharedString

A version of BinaryString used for data that's commonly repeated. rbx_types automatically deduplicates data as it's loaded into SharedString values.

UDim

Standard unit for measuring UI given as scale, a fraction of the container's size and offset, display-indepdendent pixels.

UDim2

Standard 2D unit for measuring UI given as scale, a fraction of the container's size and offset, display-indepdendent pixels.

Vector2

The standard 2D vector type used in Roblox.

Vector3

The standard 3D vector type used in Roblox.

Vector2int16

A version of Vector2 whose coordinates are signed 16-bit integers.

Vector3int16

A version of Vector3 whose coordinates are signed 16-bit integers. Vector3int16 is often used when working with Terrain.

Enums

BrickColor

BrickColor values were the old, palette-based system of defining colors in Roblox. As of the time of writing, they're still used for some old systems like SpawnLocation and Team objects.

PhysicalProperties

Represents the physical properties that parts can have.

Variant

Represents any Roblox type. Useful for operating generically on Roblox instances.

VariantType

Represents any type that can be held in a Variant.