@rbxts/types

Variables

• Axes
• BrickColor
• CatalogSearchParams
• CFrame
• Color3
• ColorSequence
• ColorSequenceKeypoint
• DateTime
• DockWidgetPluginGuiInfo
• Faces
• FloatCurveKey
• Font
• game
• Instance
• NumberRange
• NumberSequence
• NumberSequenceKeypoint
• OverlapParams
• PathWaypoint
• PhysicalProperties
• Random
• Ray
• RaycastParams
• Rect
• Region3
• Region3int16
• RotationCurveKey
• script
• shared
• SharedTable
• SharedTableNominal
• TweenInfo
• UDim
• UDim2
• Vector2
• Vector2int16
• Vector3
• Vector3int16

Functions

• delay()
• elapsedTime()
• gcinfo()
• require()
• spawn()
• tick()
• time()
• type()
• UserSettings()
• version()
• wait()
• warn()

Namespaces

• math

  • clamp()
  • noise()
• task

  • cancel()
  • defer()
  • delay()
  • desynchronize()
  • spawn()
  • synchronize()
  • wait()
• utf8

  • char()
  • charpattern
  • codepoint()
  • codes()
  • graphemes()
  • len()
  • nfcnormalize()
  • nfdnormalize()
  • offset()

variable Axes

const Axes: AxesConstructor;

variable BrickColor

const BrickColor: BrickColorConstructor;

variable CatalogSearchParams

const CatalogSearchParams: CatalogSearchParamsConstructor;

variable CFrame

const CFrame: CFrameConstructor;

variable Color3

const Color3: Color3Constructor;

variable ColorSequence

const ColorSequence: ColorSequenceConstructor;

variable ColorSequenceKeypoint

const ColorSequenceKeypoint: ColorSequenceKeypointConstructor;

variable DateTime

const DateTime: DateTimeConstructor;

variable DockWidgetPluginGuiInfo

const DockWidgetPluginGuiInfo: DockWidgetPluginGuiInfoConstructor;

variable Faces

const Faces: FacesConstructor;

variable FloatCurveKey

const FloatCurveKey: FloatCurveKeyConstructor;

variable Font

const Font: FontConstructor;

variable game

const game: DataModel;

variable Instance

const Instance: InstanceConstructor;

variable NumberRange

const NumberRange: NumberRangeConstructor;

variable NumberSequence

const NumberSequence: NumberSequenceConstructor;

variable NumberSequenceKeypoint

const NumberSequenceKeypoint: NumberSequenceKeypointConstructor;

variable OverlapParams

const OverlapParams: OverlapParamsConstructor;

variable PathWaypoint

const PathWaypoint: PathWaypointConstructor;

variable PhysicalProperties

const PhysicalProperties: PhysicalPropertiesConstructor;

variable Random

const Random: RandomConstructor;

variable Ray

const Ray: RayConstructor;

variable RaycastParams

const RaycastParams: RaycastParamsConstructor;

variable Rect

const Rect: RectConstructor;

variable Region3

const Region3: Region3Constructor;

variable Region3int16

const Region3int16: Region3int16Constructor;

variable RotationCurveKey

const RotationCurveKey: RotationCurveKeyConstructor;

variable script

const script: LuaSourceContainer;

variable shared

const shared: {};

variable SharedTable

const SharedTable: SharedTableConstructor;

variable SharedTableNominal

const SharedTableNominal: {};

variable TweenInfo

const TweenInfo: TweenInfoConstructor;

variable UDim

const UDim: UDimConstructor;

variable UDim2

const UDim2: UDim2Constructor;

variable Vector2

const Vector2: Vector2Constructor;

variable Vector2int16

const Vector2int16: Vector2int16Constructor;

variable Vector3

const Vector3: Vector3Constructor;

variable Vector3int16

const Vector3int16: Vector3int16Constructor;

function delay

delay: (delayTime: number, callback: DelayedCallback) => void;

• Schedules a function to be executed after delayTime seconds have passed, without yielding the current thread. This function allows multiple Lua threads to be executed in parallel from the same stack. The delay will have a minimum duration of 29 milliseconds, but this minimum may be higher depending on the target framerate and various throttling conditions. If the delayTime parameter is not specified, the minimum duration will be used.

function elapsedTime

elapsedTime: () => number;

• Returns how much time has elapsed since the current instance of Roblox was started. In Roblox Studio, this begins counting up from the moment Roblox Studio starts running, not just when opening a place.

  Deprecated

  use os.clock() instead.

function gcinfo

gcinfo: () => number;

• Returns the total memory heap size in kilobytes. The number reflects the current heap consumption from the operating system perspective, which fluctuates over time as garbage collector frees objects.

function require

require: (moduleScript: ModuleScript | number) => unknown;

• Runs the supplied ModuleScript if it has not been run already, and returns what the ModuleScript returned (in both cases).

  If the ModuleScript the user wants to use has been uploaded to Roblox (with the instance’s name being ‘MainModule’), it can be loaded by using the require function on the asset ID of the ModuleScript, though only on the server.

function spawn

spawn: (callback: DelayedCallback) => void;

• Runs the specified callback function in a separate thread, without yielding the current thread. The function will be executed the next time Roblox’s Task Scheduler runs an update cycle. This delay will take at least 29 milliseconds but can arbitrarily take longer, depending on the target framerate and various throttling conditions.

function tick

tick: () => number;

function time

time: () => number;

• Time since the game started running. Will be 0 in Studio when not running the game.

function type

type: (value: unknown) => keyof CheckablePrimitives;

• Returns the type of its only argument, coded as a string. Roblox datatypes will return "userdata" when passed to this function. You should use Roblox's typeOf() function if you want to differentiate between Roblox datatypes.

function UserSettings

UserSettings: () => UserSettings;

function version

version: () => string;

• Returns the current version of Roblox as a string. The integers in the version string are separated by periods, and each integers represent the following, in order:

  Generation - The current generation of the application shell that is hosting the client. Version - The current release version of Roblox. Patch - The current patch number for this version of Roblox. Commit - The ID of the last internal commit that was accepted into this version of the client.

function wait

wait: (seconds?: number) => LuaTuple<[number, number]>;

• Yields the current thread until the specified amount of seconds have elapsed. The delay will have a minimum duration of 29 milliseconds, but this minimum may be higher depending on the target framerate and various throttling conditions. If the seconds parameter is not specified, the minimum duration will be used. This function returns:

  Actual time yielded (in seconds) Total time since the software was initialized (in seconds)

function warn

warn: (...params: Array<unknown>) => void;

• Behaves identically to Lua’s print function, except the output is styled as a warning, with yellow text and a timestamp. This function accepts any number of arguments, and will attempt to convert them into strings which will then be joined together with spaces between them.