Accepts a function or a thread (as returned by coroutine.create) and
calls/resumes it immediately through the engine's scheduler. Arguments
after the first are sent to the function/thread.

This function is based on the fastSpawn pattern rather than being a
replacement for the deprecated global `spawn` function. It is recommended
that this function be used in place of fastSpawn.

If the calling script is currently running in a serial execution phase,
then the spawned function or thread is resumed in the current serial
execution phase. If the calling script is currently running in a parallel
execution phase, then the spawned function or thread is resumed in the
current parallel execution phase. For more information, see
[Parallel Luau](/scripting/multithreading).


task.spawn

functionOrThread

A function or a thread returned by coroutine.create.


Arguments to send to the function or thread.


Calls/resumes a function/coroutine immediately through the engine
scheduler.


Accepts a function or a thread (as returned by coroutine.create) and
defers it until the end of the current resumption cycle, at which point it
is resumed with the engine's scheduler like with `Library.task.spawn()`.
Arguments after the first are sent to the function/thread.

This function should be used when a similar behavior to
`Library.task.spawn()` is desirable, but the thread does not need to run
immediately.

If the calling script is currently running in a serial execution phase,
then the deferred function or thread is resumed in a serial execution
phase. If the calling script is currently running in a parallel execution
phase, then the deferred function or thread is resumed in a parallel
execution phase. For more information, see
[Parallel Luau](/scripting/multithreading).


task.defer

Calls/resumes a function/coroutine at the end of the current resumption
cycle.


Accepts a function or a thread (as returned by coroutine.create) and
schedules it to be called/resumed on the next
`Class.RunService.Heartbeat|Heartbeat` after the given amount of time in
seconds has elapsed. Arguments after the second are sent to the
function/thread.

This function differs from the deprecated global `delay` function in that
**no throttling occurs**: on the very same Heartbeat step in which enough
time has passed, the function is guaranteed to be called/resumed.
Providing a duration of zero (0) will guarantee that the function is
called on the very next Heartbeat.

You can calculate the actual time passed by calling `Library.os.clock()`
upon scheduling and in the scheduled function.

If the calling script is currently running in a serial execution phase,
then the delayed function or thread is resumed in a serial execution
phase. If the calling script is currently running in a parallel execution
phase, then the delayed function or thread is resumed in a parallel
execution phase. For more information, see
[Parallel Luau](/scripting/multithreading).


task.delay

duration

The minimum number of seconds that must pass before the
function/thread is called/resumed.


Arguments to be passed to the function/thread when it is due to be
called/resumed.


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


If the calling script is currently running in a serial execution phase,
`desynchronize` suspends the script and the script will be resumed in the
next parallel execution phase. If the calling script is currently running
in a parallel execution phase, `desynchronize` returns immediately and has
no effect.

Only scripts which are descendants of an Actor may call this method. If a
script outside of an Actor calls this method, an error will be raised.
ModuleScript's may also call `desynchronize` as long as the instantiation
of the module calling it was required by a script that is a descendant of
an Actor.

For more information, see
[Parallel Luau](/scripting/multithreading).


task.desynchronize

Causes the following code to be run in parallel.


If the calling script is currently running in a parallel execution phase,
`synchronize` suspends the script and the script will be resumed in the
next serial execution phase. If the calling script is currently running in
a serial execution phase, `synchronize` returns immediately and has no
effect.

Only scripts which are descendants of an Actor may call this method. If a
script outside of an Actor calls this method, an error will be raised.
ModuleScript's may also call `synchronize` as long as the instantiation of
the module calling it was required by a script that is a descendant of an
Actor.

For more information, see
[Parallel Luau](/scripting/multithreading).


task.synchronize

Causes the following code to be run in serial.


Yields the current thread until the given duration (in seconds) has
elapsed, then resumes the thread on the next
`Class.RunService.Heartbeat|Heartbeat` step. The actual amount of time
elapsed is returned.

If no duration is given, it will default to zero (0). This means the
thread resumes on the very next step, which is equivalent in behavior to
`RunService.Heartbeat:Wait()`

Unlike the deprecated global `wait`, this function **does not throttle**
and guarantees the resumption of the thread on the first Heartbeat that
occurs when it is due. This function also only returns the elapsed time
and nothing else.

If the calling script is currently running in a serial execution phase,
then the script is resumed in a serial execution phase. If the calling
script is currently running in a parallel execution phase, then the script
is resumed in a parallel execution phase. For more information, see
[Parallel Luau](/scripting/multithreading).


task.wait

The amount of time in seconds that should elapse before the current
thread is resumed.


Yields the current thread until the next Heartbeat in which the given
duration (in seconds) has passed, without throttling.


Cancels a thread and closes it, preventing it from being resumed manually
or by the task scheduler.

This function can be used with other members of the task library that
return a thread to cancel them before they are resumed. For example:

```lua
local thread = task.delay(5, function()
	print("Hello world!")
end)

task.cancel(thread)
```

Note: Threads may be in a state where it is impossible to cancel them. For
example, the currently executing thread and threads that have resumed
another coroutine may not be cancelled. If this is the case, a lua error
will be generated.

However, code should not rely on specific thread states or conditions
causing `Library.task.cancel()` to fail. It is possible that future
updates will eliminate these constraints and allow threads in these states
to be successfully cancelled.


task.cancel

thread

Cancels a thread, preventing it from being resumed.


task

Allows for functions and threads to be coordinated with the Task Scheduler.


An object that runs connected functions upon a specific occurrence.

Data Type

RBXScriptSignal

Variant

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

Luau

function

A double-precision floating-point number.

number

A function that executes alongside the main thread.

Library

coroutine

void

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Legacy

Cloud

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.

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.

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.

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

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

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

Grants access to follow and unfollow 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.

Default Value: {defaultValueStart}{defaultValueEnd}

An array is an ordered list of values. Arrays are useful for storing collections of data.

A set of key-value pairs, where the keys can be any number, string, or object.

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.

Manage and analyze all your experiences in one convenient place.

Learn with documentation and resources for all creators.

Learn how to create Roblox experiences with guides, tutorials, and code samples.

Build your experiences in Studio, our all-in-one IDE, and deploy to a wide variety of devices.

Dependable ways to offer value over time to your audience

Learn how to create successful ads that drive traffic to your creations

Chart your experience's growth and discover opportunities to improve

Learn how to apply movement to your characters and environments

Learn how to upload or use assets from Store in your creations

Create Avatar items and publish it to Marketplace

Sorted by highest revenue over the last 7 days

Learn about what you can make and sell on the marketplace

The avatar represents every Roblox user as a customizable character

See this thread of cool creations being built by the community

Learn basic modeling techniques in blender

Find models, scripts, and plugins made by other creators

Learn how to configure characters to ensure all avatar features work properly

Learn how to create objects that interact with the world or other users

Make and sell your first basic clothing item on Roblox

Use Studio's collaboration tools to work with your team at the same time

Check out what’s trending on the Creator Marketplace

Check out what's trending on the Creator Store

Participate in community events held by other Creators

Find tutorials written by the Creator community

Keep players engaged and monetized with content updates

Captivate your audience with an enjoyable gameplay cycle

Drive engagement and progress with fun, repetitive gameplay

Learn how to create a sliding door without writing any code

Alex shares first-hand experience behind creating the hit experience, JailBreak

Blake found a passion in making realistic, quirky carnival games

The Clemens are the family-owned studio behind hits like The Survival Game

Jasmine is the artist behind some of the most popular avatar items on Marketplace

Jessica is the designer behind imaginative environments like in Alo Yoga

Jenni is the UGC creator and artist behind many popular collaborations

Morphist’s unique style combines cutesy and emo aesthetics

The Riotfall creators travel to find inspiration for their immersive environments

Stephen shares their love of programming tools

Sam shares how they got started designing fashion items that they wish existed

All objects that make up a 3D world, such as parts and lighting

Learn about the range of debugging tools available in Studio

See your progress towards your next cash out!

Use the developer console to debug your experience when testing

Adding subscriptions to your experience helps build long term relationships with your user base. Enable subscriptions before December 15, 2023, and enjoy 3 months of lower rates.

Look at the top Experiences out to get inspiration

Get started with Studio, Roblox’s creation engine

Add a few lines of code to unlock new dashboards to understand your onboarding and other funnels and track your in-game economy.

Build live, cross-server events and cutscenes on a structured sequence

Learn how to create timed events for your experiences

Create time-based events for increased discoverability across Roblox. Announce your latest update, highlight an activity, or celebrate a milestone with your players!

Learn about how to target the age group right for your Creation through Experienced Guidelines

Gain knowledge and expertise directly from Roblox

Learn how to implement a friend invite reward system

Understand the basics of how to create a game

Learn how you can control how your data is used to train AI. {linkStart}Read More{linkEnd}

Easily create custom textures using our AI tools

Use our all-in-one creation engine to build anything you can imagine

PolarCub shares all the tips tricks to make UGC items

Leverage Guilded to build a community for your Creation

Join our incredible cast of creators for a Halloween game jam

Use the head part to create facial animations or trigger emotes

Using metrics to understand where you can improve your gameplay

Figure out how to keep them coming back to your game

User input allow users to interact with your experience environment

Guide players through their first time playing your experience

Create clothing that stretchs and fit over any avatar body

At Roblox, we believe you learn best by doing. Choose one of our guides to explore more of what the platform offers.

Get help writing code and answers to your creation questions

The Lighting and SoundService let you control environmental effects

Learn how to adapt your content to different languages and cultural norms

This walkthrough covers attachments, beams, and some basic scripting concepts that shows you how to set player health to 0 if they touch something

Cultivating an active player base is an instrumental part of developing a successful and enduring game.

Get started with the performance optimization and troubleshooting tool

Microprofiler provides timing information for the task scheduler

Dive deep into frame colors, flame graphs, and more

Understand how to use metrics to be more successful

Improve the performance of computationally intensive Luau scripts

View your daily benchmarks, insights, and real-time metrics to take {boldStart}{experienceName}{boldEnd} to the next level.

Learn how to use NPCs (non-player characters) in your experiences

@minty creates an obby live from scratch using suggestions from chat

Our platform provides you with unparalleled opportunities to create. Get started by exploring the Creator Hub, Roblox Studio, and our vibrant Creator community.

Our platform provides you with unparalleled opportunities to create.

Our community of award-winning studios and self-taught creators all started here, just like you. 

A principal environment artist at Roblox covers how and why to use packages

Staff stream about gravity, material properties, and constraints

Learn about what happens when a user joins an experience

Plugins add additional features or functionality to your creations

Let's tour PolarCub's UGC Homestore! Also, Temprist shows up.

Learn how to drive traffic and awareness to your creations

Catch up on all the highlights from this year's RDC

Learn about what’s possible with our creation engine

Learn hwo to rig an R15 humanoid character model

Make and sell your first basic rigid accessory on Roblox

Get a preview of some of the new features and capabilities coming soon to Roblox

Studio is the tool that lets you create experiences on Roblox

Learn how to use the script editor in Studio to create custom scripts

Scripting lets you add immersive interactions for your users

Learn Studio shortcuts and key commands that make building quicker

Learn how to integrate features that allow players to play with friends

Create a Sponsored Ad to get your Creation in front of more Creators

Studio is an all-in-one tool for building on Roblox. Try making something today!

Learn how to offer players recurring benefits for a monthly fee

Grow your experience with the help of other Creators

Use the terrain editor to generate and alter terrain in Studio

Experiences like {boldStart}{experienceName}{boldEnd} saw an average +8.5% lift in qualified play through rate with personalization.

Translations can help your Creation reach tons of different audiences

Tour the new UGC Homestore template with Minty and SCHLEEMPH

Learn about how to build for Roblox's unique audience

What are they and how you can use them to build

Watch a quick introduction to creating on Roblox, then jump into Studio

Read the latest announcements from Roblox Staff

Manage and grow your creations all in one convenient place

Workspace holds objects that you want the engine to render in your project

Staff stream covering parts, meshes, terrain, and lighting

task

Summary

Functions

Functions

spawn

Parameters

Returns

defer

Parameters

Returns

delay

Parameters

Returns

desynchronize

Returns

synchronize

Returns

wait

Parameters

Returns

cancel

Parameters

Returns