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.


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 `Class.DebuggerManager` class, which acts as an interface for
Roblox's Lua debugger feature.


DebuggerManager

Refers to the DebuggerManager, which acts as an interface for the Lua
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 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.


gcinfo

Returns the total memory heap size in kilobytes.


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.


Runs the supplied `Class.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.


require

module

The ModuleScript that will be executed to retrieve the return value it
provides.


Returns the value that was returned by the given ModuleScript, running it
if it has not been run yet.


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 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 the
date January 1st, 1970.


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 Lua's native `type` function, as it does not denote
Roblox-specific types as `userdata`.


typeof

object

The Lua 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 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.


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.


Roblox Globals

Enum

game

plugin

shared

script

workspace

/reference/engine/globals/RobloxGlobals.yaml

Built-in functions and constants unique to Roblox.


The DataModel (commonly known as **game** after the global variable used to
access it) is the root of Roblox's parent-child hierarchy. Its direct children
are services (such as the `Class.Workspace` and `Class.Lighting`) that act as
the fundamental components of a Roblox game.


A root access point of all `Datatype.Enum`s.


Collection of menu settings for Roblox Studio.


The base class for all objects which contain Lua code. `Class.Script`,
`Class.LocalScript`, `Class.ModuleScript` and `Class.CoreScript` all inherit
from LuaSourceContainer.


A type of script object that runs once when `require` is called with it.
Returns exactly one value, usually a table of functions, to used by other
scripts. Useful for compartmentalizing code.


Plugin is the main object responsible for creating basic studio widgets. It is
a custom add-on to Studio which adds new behavior and features that are not
normally included.


A singleton class used to create `Class.Plugin|Plugins`. This has been
superseded by the [Plugins](../../../studio/plugins.md) 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.


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


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


Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Cloud

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

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

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

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 allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

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

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

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.

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

Default Value: {defaultValueStart}{defaultValueEnd}

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

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 object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts 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 read only. Attempting to write to this member 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.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.


{pageTitle} | {SiteName}

title

Unable to add to inventory

The code sample {title} has been added to your Inventory.

Version {versionNumber} includes general performance improvements and bug fixes. Check our other release notes for status on specific improvements and bugs.

Please don't include private or personal information. Maximum {maxDescriptionLength} words.

Minimum {minDescriptionLength} words required in the description.

Release Notes for Roblox Studio Version {versionNumber}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.