Throws an error if the provided `value` is `false` or `nil`. If the
assertion passes, it returns all values passed to it.

```lua
local product = 90 * 4
assert(product == 360, "Oh dear, multiplication is broken")
-- The line above does nothing, because 90 times 4 is 360
```


assert

value

The value that will be asserted against.


errorMessage

The text that will be shown in the error if the assertion fails.


Throws an error if the provided `value` resolves to `false` or `nil`.


Performs the specified operation of the garbage collector. Note that
Roblox's Luau sandbox only allows the `count` option to be used (the total
memory in use by Luau, in kilobytes), as other options can interfere with
existing processes. Effectively, this makes `Global.LuaGlobals.gcinfo()` a
superior alternative that should be used instead.


collectgarbage

operation

The name of the operation that should be performed by the garbage
collector.


Performs the specified operation of the garbage collector.


Terminates the last protected function called and outputs `message` as an
error message. If the function containing the error is not called in a
protected function such as `pcall()`, then the script which called the
function will terminate. The error function itself never returns and acts
like a script error.

The `level` argument specifies how to get the error position. With level
`1` (the default), the error position is where the error function was
called. Level 2 points the error to where the function that called error
was called; and so on. Passing a level `0` avoids the addition of error
position information to the message.


error

message

level

The level of information that should be printed. Defaults to 1.


Halts thread execution and throws an error.


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 current environment in use by the caller, as a dictionary.

- If provided with a function, the environment of the function will be
  returned.
- If provided with an integer, `Global.LuaGlobals.getfenv()` will provide
  the environment of the function at the provided stack level: Level 1 is
  the function calling `Global.LuaGlobals.getfenv()`. If `stack` is `0`,
  `Global.LuaGlobals.getfenv()` returns the global environment of the
  current script. When using `Global.LuaGlobals.getfenv()` to get the
  current environment of a script, it will return the same table every
  time within the specific thread.

**WARNING:** This function allows uncontrolled change of the
global/function environment and disables script optimizations. Changes to
the environment are not tracked by the script analysis tooling and may
result in missing or incorrect warnings. As a replacement, consider using
`Library.debug.info()` instead.


getfenv

stack

The stack level (int) of the environment to be returned; or the
function whose environment will be returned.


Returns the current environment in use by the caller, as a dictionary.


Returns the metatable of the given table `t` if it has one, otherwise
returns `nil`. If `t` does have a metatable, and the `__metatable`
metamethod is set, it returns that value instead.

```lua
-- Demonstrate getmetatable:
local meta = {}
local t = setmetatable({}, meta)
print(getmetatable(t) == meta) --> true
-- Make the original metatable unrecoverable by setting the __metatable metamethod:
meta.__metatable = "protected"
print(getmetatable(t)) --> protected
```


getmetatable

Returns the metatable of the given table.


Returns three values: an iterator function, the table `t` and the number
`0`. Each time the iterator function is called, it returns the next
numerical index-value pair in the table. When used in a generic for-loop,
the return values can be used to iterate over each numerical index in the
table:

```lua
local fruits = {"apples", "oranges", "kiwi"}
for index, fruit in ipairs(fruits) do
   print(index, fruit) --> 1 apples, 2 oranges, 3 kiwi, etc...
end
```


ipairs

A table whose elements are to be iterated over.


Returns an iterator function and the table for use in a for loop.


Loads Luau code from a string and returns it as a function.

Unlike standard Lua 5.1, Roblox's Luau cannot load the compiled bytecode
using `loadstring()`.

`loadstring()` is disabled by default. For guidance around enabling it,
see `Class.ServerScriptService`.

**WARNING:** This method disables certain Luau optimizations on the
returned function. Extreme caution should be taken when using
`Global.LuaGlobals.loadstring()`; if your intention is to allow users to
run code in your experience, make sure to protect the returned function's
environment by using `Global.LuaGlobals.getfenv()` and
`Global.LuaGlobals.setfenv()`.


loadstring

chunkname

An optional chunk name for error messages and debug information. If
unspecified, Luau uses the `contents` string.


Returns the provided code as a function that can be executed.


Creates a blank `userdata`, with the option for it to have a metatable.


newproxy

addMetatable

Returns the first key/value pair in the array. If a `lastKey` argument was
specified then returns the next element in the array based on the key that
provided. The order in which the indices are enumerated is not specified,
even for numeric indices. To traverse a table in numeric order, use a
numerical for loop or `ipairs`.

The behavior of next is undefined if, during the traversal, you assign any
value to a non-existent field in the table. You may, however, modify
existing fields. In particular, you may clear existing fields.


lastKey

The last key that was previously retrieved from a call to next.


An iterator function for use in for loops.


Returns an iterator function, the passed table `t`, and `nil`, so that the
construction will iterate over all key/value pairs of that table when used
in a generic `for` loop:

```lua
local scores = {
    ["John"] = 5,
    ["Sally"] = 10
}

for name, score in pairs(scores) do
    print(name .. " has score: " .. score)
end
```


pairs

An array or dictionary table to iterate over.


Returns an iterator function and the provided table for use in a `for`
loop.


Calls the function `func` with the given arguments in protected mode. This
means that any error inside `func` is not propagated; instead, `pcall()`
catches the error and returns a status code. Its first result is the
status code (a boolean), which is true if the call succeeds without
errors. In such case, `pcall()` also returns all results from the call,
after this first result. In case of any error, `pcall()` returns false
plus the error message.


pcall

func

The function to be called in protected mode.


args

The arguments to send to `func` when executing.


Runs the provided function and catches any error it throws, returning the
function's success and its results.


Receives any number of arguments, and prints their values to the output.
`print` is not intended for formatted output, but only as a quick way to
show a value, typically for debugging. For a formatted output, use
`Library.string.format()`. On Roblox, `print` does not call `tostring`,
but the `__tostring` metamethod still fires if the table has one.


print

params

Any number of arguments to be outputted.


Prints all provided values to the output.


Checks whether `v1` is equal to `v2`, without invoking any metamethods.


rawequal

Returns whether `v1` is equal to `v2`, bypassing their metamethods.


Gets the real value of `table[index]`, without invoking any metamethods.


rawget

index

Gets the real value of `table[index]`, bypassing any metamethods.


Returns the length of the string or table, without invoking any
metamethods.


rawlen

Returns the length of the string or table, bypassing any metamethods.


Sets the real value of `table[index]` to a given `value`, without invoking
any metamethod.


rawset

The index to set in `t` to a specified `value`. Must be different from
`nil`.


The value to be set to a specified `index` in table `t`.


Sets the real value of `table[index]`, bypassing any metamethods.


Runs the supplied `Class.ModuleScript` and returns what the
`Class.ModuleScript` returned (usually a table or a function). If the
`Class.ModuleScript` has not been run yet, it will be executed.

If a string path is provided instead, it is first resolved to a
`Class.ModuleScript` relative to the script that called
`Global.LuaGlobals.require()`, mimicking the Unix-like semantics of Luau's
`require()` expression. For example, each pair of
`Global.LuaGlobals.require()` expressions in the example below contains
two functionally equivalent calls.

```lua
-- "./" is equivalent to script.Parent
require(script.Parent.ModuleScript)
require("./ModuleScript")

-- "../" is equivalent to script.Parent.Parent
require(script.Parent.Parent.ModuleScript)
require("../ModuleScript")
```

Specifically, require-by-string's resolution semantics are as follows:

- String paths must begin with either `./` or `../`, where `./` is
  equivalent to `script.Parent` and `../` is equivalent to
  `script.Parent.Parent`.
- If the resolved path points to an `Class.Instance` that is not a
  `Class.ModuleScript`, `Global.LuaGlobals.require()` will attempt to find
  a `Class.ModuleScript` named `Init` or `init` parented to that
  `Class.Instance` and use it instead, if it exists.
- If the desired `Class.ModuleScript` is not present at the time that
  `Global.LuaGlobals.require()` is called, the call will fail and throw an
  error. In other words, require-by-string is non-blocking: it does not
  implicitly wait for a `Class.ModuleScript` to be created.

Once the return object is created by an **initial**
`Global.LuaGlobals.require()` call of a `Class.ModuleScript`, future
`Global.LuaGlobals.require()` calls for the same `Class.ModuleScript` (on
the same side of the client-server boundary) will not run the code again.
Instead, a reference to the **same** return object created by the initial
`Global.LuaGlobals.require()` call will be supplied. This behavior allows
for the sharing of values across different scripts, as multiple
`Global.LuaGlobals.require()` calls from different scripts will reference
the same returned object. If the returned object is a table, any values
stored within the table are shared and accessible by any script requiring
that `Class.ModuleScript`.

As noted above, the "object sharing" behavior does not cross the
client-server boundary. This means that if a `Class.ModuleScript` is
accessible to both the client **and** server (such as by being placed in
`Class.ReplicatedStorage`) and `Global.LuaGlobals.require()` is called
from both a `Class.LocalScript` as well as a `Class.Script`, the code in
the `Class.ModuleScript` will be run twice, and the `Class.LocalScript`
will receive a distinct return object from the one received by the
`Class.Script`.

Also note that if the `Class.ModuleScript` the user wants to run has been
uploaded to Roblox (with the instance's name being `MainModule`), it can
be loaded by using the `Global.LuaGlobals.require()` function on the asset
ID of the `Class.ModuleScript`, though only on the server.


require

module

The `Class.ModuleScript` that will be executed to retrieve the return
value it provides, or a reference to one (a string path or asset ID).


What the `Class.ModuleScript` returned (usually a table or a
function).


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


Returns all arguments after argument number `index`. If negative, it will
return from the end of the argument list.

```lua
print(select(2, "A", "B", "C")) --> B C
print(select(-1, "A", "B", "C")) --> C
```

If the `index` argument is set to `"#"`, the number of arguments that were
passed after it is returned.

```lua
print(select("#", "A", "B", "C")) --> 3
```


select

The index of the argument to return all arguments after in `args`. If
it's set to `"#"`, the number of arguments that were passed after it
is returned.


Returns all arguments after the given index.


Sets the environment to be used by the given function. `f` can be a
function or a number that specifies the function at that stack level:
Level 1 is the function calling `setfenv()`. `setfenv()` returns the given
function.

If `f` is `0`, then `setfenv()` changes the environment of the running
thread and returns no values.

**WARNING:** This function allows uncontrolled change of the
global/function environment and disables script optimizations. Changes to
the environment are not tracked by the script analysis tooling and may
result in missing or incorrect warnings.


setfenv

Either a function or a number that specifies the function at that
stack level.


fenv

The function environment table to set for the specified function.


Sets the metatable for the given table `t` to `newMeta`. If `newMeta` is
`nil`, the metatable of `t` is removed. Finally, this function returns the
table `t` which was passed to it. If `t` already has a metatable whose
`__metatable` metamethod is set, calling this on `t` raises an error.

```lua
local meta = {__metatable = "protected"}
local t = {}
setmetatable(t, meta) -- This sets the metatable of t
-- We now have a table, t, with a metatable. If we try to change it...
setmetatable(t, {}) --> Error: cannot change a protected metatable
```


setmetatable

newMeta

If `nil`, the metatable of the given table `t` is removed. Otherwise,
the metatable to set for the given table `t`.


Attempts to convert the arg into a number with a specified base to
interpret the value in. If it cannot be converted, this function returns
`nil`.

The base may be any integer between 2 and 36, inclusive. In bases above
10, the letter 'A' (in either upper or lower case) represents 10, 'B'
represents 11, and so forth, with 'Z' representing 35. In base 10 (the
default), the number may have a decimal part, as well as an optional
exponent part. In other bases, only unsigned integers are accepted.

If a string begins with `0x` and a base is not provided, the `0x` is
trimmed and the base is assumed to be 16, or hexadecimal.

```lua
print(tonumber("1337")) --> 1337 (assumes base 10, decimal)
print(tonumber("1.25")) --> 1.25 (base 10 may have decimal portions)
print(tonumber("3e2")) --> 300 (base 10 may have exponent portion, 3 &times; 10 ^ 2)
print(tonumber("25", 8)) --> 21 (base 8, octal)
print(tonumber("0x100")) --> 256 (assumes base 16, hexadecimal)
print(tonumber("roblox")) --> nil (does not raise an error)
-- Tip: use with assert if you would like unconvertable numbers to raise an error
print(assert(tonumber("roblox"))) --> Error: assertion failed
```


tonumber

The object to be converted into a number.


base

The numerical base to convert `arg` into.


Returns the provided value converted to a number, or `nil` if impossible.


Receives an argument of any type and converts it to a string in a
reasonable format. For complete control of how numbers are converted, use
string.format. If the metatable of `e` has a `__tostring` metamethod, then
it will be called with `e` as the only argument and will return the
result.

```lua
local isRobloxCool = true
-- Convert the boolean to a string then concatenate:
print("Roblox is cool: " .. tostring(isRobloxCool)) --> Roblox is cool: true
```


tostring

The object to be converted into a string.


Returns the provided value converted to a string, or `nil` if impossible.


Returns the type of its only argument, coded as a string. The possible
results of this function are `"nil"` (a string, not the value nil),
`"number"`, `"string"`, `"boolean"`, `"table"`, `"vector"`, `"function"`,
`"thread"`, `"userdata"`, and `"buffer"`. The `buffer` and `vector`
primitives are additions from Luau, not from Lua.


type

Returns the basic type of the provided object.


Returns the elements from the given table. By default, `i` is 1 and `j` is
the length of `list`, as defined by the length operator.


unpack

list

The index of the first element to unpack.


The index of the last element to unpack.


Returns all elements from the given list as a tuple.


This function is similar to `Global.LuaGlobals.pcall()`, except that you
can set a new error handler.

`xpcall()` calls function `f` in protected mode, using `err` as the error
handler, and passes a list of arguments. Any error inside `f` is not
propagated; instead, `xpcall()` catches the error, calls the `err`
function with the original error object, and returns a status code. Its
first result is the status code (a boolean), which is true if the call
succeeds without errors. In this case, `xpcall()` also returns all results
from the call, after this first result. In case of any error, `xpcall()`
returns false plus the result from `err`.

Unlike `Global.LuaGlobals.pcall()`, the `err` function preserves the stack
trace of function `f`, which can be inspected using `Library.debug.info()`
or `Library.debug.traceback()`.


xpcall

The function to be used as an error handle if xpcall catches an error.


Similar to `Global.LuaGlobals.pcall()` except it uses a custom error
handler.


Luau globals

_VERSION

/reference/engine/globals/LuaGlobals.yaml

A list of functions and variables that are native to Luau.


Luau

Array

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

Class

ModuleScript

An object that runs connected functions upon a specific occurrence.

Data Type

RBXScriptSignal

Tuple

Variant

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

Data type which can store multiple values of any non-nil type, including booleans, numbers, strings, functions, and other tables.

table

Arbitrary C/C++ data that exists in Luau.

userdata

Overview

Experiences

Avatar

Assets

Open Cloud

Create

Discovery

Localization

Analytics

Design

Scale

Affiliates

Monetize

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.

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

Luau globals

Summary

Functions

Properties

Functions

assert

Parameters

Returns

error

Parameters

Returns

gcinfo

Returns

getmetatable

Parameters

Returns

ipairs

Parameters

Returns

loadstring

Parameters

Returns

newproxy

Parameters

Returns

next

Parameters

Returns

pairs

Parameters

Returns

pcall

Parameters

Returns

print

Parameters

Returns

rawequal

Parameters

Returns

rawget

Parameters

Returns

rawlen

Parameters

Returns

rawset

Parameters

Returns

require

Parameters

Returns

select

Parameters

Returns

setmetatable

Parameters

Returns

tonumber

Parameters

Returns

tostring

Parameters

Returns

type

Parameters

Returns

unpack

Parameters

Returns

xpcall

Parameters

Returns

Properties

_G

_VERSION