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 some applicable uses,
such as if you need to create a `Class.Plugin` object from Studio's
[Command Bar](/studio/ui-overview#command-bar).


PluginManager

Refers to the `Class.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`.

If `Class.Workspace.AuthorityMode` is `Enum.AuthorityMode.Server`, this
value is synchronized between client and server.


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

{any}

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 custom Studio widgets, plugin toolbars, plugin buttons, and more. The `Plugin` object can be accessed through the `Global.RobloxGlobals.plugin` global reference in a `Class.Script` that is executed as a plugin.

Plugin

`PluginManager` is a deprecated singleton that was previously required to create plugins. It still has some applicable uses, such as if you need to create a `Class.Plugin` object from Studio's [Command Bar](/studio/ui-overview#command-bar).

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

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

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.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

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.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

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

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

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

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

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

For more information on generating 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}).

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.

The following scopes are required to call this endpoint.

Resource Paths

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

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

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

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

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

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 you to view information about your Creator Store saves.

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

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

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.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

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.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

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

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

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

This allows you to view the authorized user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.