Roblox provides several unique built-in functions and variables in its
embedding of Luau. These are only found on Roblox and are not packaged by
default with Luau or Lua.


Schedules a function to be executed after `delayTime` seconds have passed,
without yielding the current thread. This function allows multiple Luau
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.


delay

delayTime

The amount of time that this function will be queued before being
executed.


callback

The function that will be executed once `delayTime` seconds have
passed.


Schedules a function to be called on the next Heartbeat after the given
duration (in seconds) has passed, with throttling.


Returns the legacy `DebuggerManager` class which acts as an interface for
Roblox's Luau debugger feature.

This function is not recognized by Luau's analysis tool and will raise an
undefined global warning.


DebuggerManager

Refers to the legacy `DebuggerManager` class which acts as an interface
for the Luau debugger feature.


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.


elapsedTime

Returns the amount of time in seconds that the current instance of Roblox
has been running for.


Returns the `Class.PluginManager` which is a deprecated singleton that was
previously required to create plugins. It still has applicable uses, such
as if you need to create a Plugin object from Roblox Studio's command bar.


PluginManager

Refers to the PluginManager, a deprecated singleton that was previously
required to create plugins.


Prints `Current identity is [ID]` to the output, where [ID] corresponds to
the current thread's security context level.


printidentity

prefix

Prints "Current identity is X", where X corresponds to the current
thread's security context level.


Returns the `Class.GlobalSettings` object, which can be used to access the
settings objects that are used in Roblox Studio's settings menu.


settings

Returns the `Class.GlobalSettings` object, which can be used to access
settings objects that configure Roblox Studio's behavior.


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.

The callback function is invoked with two arguments:

1. The first being the amount of time which elapsed from when spawn was
   called to when the function was invoked.
2. The second being equivalent to elapsedTime() or roughly how long the
   engine has been running.

```lua
spawn(print) -- 0.0079617658390703 451.55683163643
```


spawn

Calls a function immediately through the engine scheduler, with
throttling.


Returns the `Class.Stats` service. It is preferred that developers use
`Class.ServiceProvider:GetService()` to retrieve it instead.


stats

Returns how much time has elapsed, in seconds, since the Unix epoch, on
the current local session's computer. The Unix epoch is represented by
00:00:00 on 1 January 1970.

`tick()` isn't officially deprecated, but has a variety of issues. It can
be off by up to one second and returns inconsistent results across time
zones and operating systems. Use `Library.os.time()`,
`Library.os.clock()`, or `Global.RobloxGlobals.time()` instead. Also
consider `Datatype.DateTime.UnixTimestamp` and
`Datatype.DateTime.UnixTimestampMillis`.


tick

Returns the amount of time in seconds since the Unix epoch according to
this device's time.


Returns the amount of time, in seconds, that has elapsed since the current
game instance started running. If the current game instance is not
running, this will be `0`.


time

Returns the amount of time in seconds that has elapsed since the current
game instance started running.


Returns the type of the object specified, as a string. This function is
more accurate than Luau's native `type` function, as it does not denote
Roblox-specific types as `userdata`.


typeof

object

The Luau type that will have its type checked.


Returns the type of the given object as a string, also supporting
Roblox-specific types (e.g. Vector3).


Returns the `Class.UserSettings` object, which is used to read information
from the current user's game menu settings.


UserSettings

Returns the UserSettings object, which is used to read information from
the current user's game menu settings.


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.


version

Returns the current version of Roblox as a string, which includes the
generation, version, patch and commit.


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


wait

seconds

Specifies how long the thread should yield for.


Yields the current thread until the specified amount of time in seconds
have elapsed, with throttling.


Behaves identically to Luau'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.


warn

params

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.


Behaves similarly to print, except with more distinct formatting (yellow);
intended for messages which describe potential problems.


Legacy function to work around an old task scheduling limitation of
`Global.LuaGlobals.pcall()`; should not be used for new work (use
`Global.LuaGlobals.pcall()` instead).


ypcall

The function to be called in protected mode.


args

Legacy function to work around an old task scheduling limitation of
`Global.LuaGlobals.pcall()`.


Roblox globals

A reference to the Enums data type, which stores all of the available
enums that can be used on Roblox.


Enum

A reference to the `Class.DataModel`, which is the root Instance of
Roblox's parent/child hierarchy.


game

Refers to the DataModel singleton, the root instance of a place's
hierarchy.


A reference to the `Class.Plugin` object that represents the plugin being
run from this `Class.Script`. This reference exists only in the context
where a script is executed as a plugin and is not passed to
`Class.ModuleScript|ModuleScripts` within the plugin. To use this
reference in a `Class.ModuleScript`, you must explicitly pass it.

```lua
assert(plugin, "This script must be run as a plugin!")
-- Code beyond this point will execute only if the script is run as a plugin
```


plugin

Refers to a Plugin singleton when the code is run in the context of a
Studio plugin.


A table that is shared across all scripts that share the same execution
context level. This serves the exact same purpose as `_G`.


shared

A table shared between all code running at the same execution context
level.


A reference to the script object that is executing the code you are
writing. It can be either a `Class.Script`, a `Class.LocalScript`, or a
`Class.ModuleScript`. This variable is not available when executing code
from Roblox Studio's command bar.


script

A reference to the LuaSourceContainer object (Script, LocalScript, or
ModuleScript) that is executing this code.


A reference to the `Class.Workspace` service, which contains all of the
physical components of a Roblox world.


workspace

A reference to the Workspace service, which contains all of the physical
components of a place.


Built-in functions and constants unique to Roblox.


/reference/engine/globals/RobloxGlobals.yaml

Luau

Array

The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Class.Workspace` and `Class.Lighting`, that act as the fundamental components of a Roblox game.

Class

DataModel

A root access point of all `Datatype.Enum|Enums`.

Data Type

Enums

Collection of menu settings for Roblox Studio.

GlobalSettings

The base class for all objects which contain Luau code.

LuaSourceContainer

**Plugin** is the main object responsible for creating basic Studio widgets, plugin toolbars, plugin buttons, and more. It is a custom add-on to Studio which adds new behavior and features that are not normally included. The **Plugin** object can be accessed through the `Global.RobloxGlobals.plugin` global reference in a `Class.Script` that is executed as a plugin.

Plugin

A singleton class used to create `Class.Plugin|Plugins`. This has been superseded by the [Plugins](/studio/plugins) but it can be used to create plugins with the command bar.  The PluginManager object can be retrieved using the deprecated `Class.PluginManager|PluginManager()` function.

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Stats

Tuple

A singleton object that houses basic user settings, which persist across all games on Roblox.

Variant

**Workspace** houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.

Workspace

Data type having a value of either true or false.

boolean

Functions are blocks of code that can execute multiple times on command.

function

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

Overview

Experiences

Avatar

Assets

Open Cloud

Create

Discovery

Localization

Analytics

Design

Scale

Monetize

Education

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

{nameStart}name{nameEnd} is no longer supported or maintained by Roblox.

This math operation is no longer supported or maintained by Roblox.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This member is accessible from OpenCloud Luau execution tasks.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible through the command bar and plugins. Attempting to access this member from scripts causes an error.

This member is read only. Attempting to write to this member causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Roblox globals

Summary

Functions

Properties

Functions

elapsedTime

Returns

PluginManager

Returns

settings

Returns

tick

Returns

time

Returns

typeof

Parameters

Returns

UserSettings

Returns

version

Returns

warn

Parameters

Returns

Properties

Enum

game

plugin

shared

script

workspace

On this page