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 an operation on the Lua garbage collector based on the specified
option.

Roblox's Lua sandbox only allows the "count" option to be used, so none of
the other standard options are available.

The "count" option returns the total memory in use by Lua (in kilobytes).


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


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 Lua code from a string and returns it as a function.

Unlike standard Lua 5.1, Roblox's Lua cannot load the binary version of
Lua using `loadstring()`.

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


loadstring

chunkname

An optional chunk name for error messages and debug information. If
unspecified, Lua 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.


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

Returns the total number of arguments that were passed after the `cmd`
argument, which must be `"#"` to use `select` in this fashion.

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

If `cmd` is a number, the function will return all values after that
index.

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


select

The index of the argument to return all arguments after in `args`. or
must be "#".


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.


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",
and "userdata".


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


xpcall

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


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


Lua Globals

_VERSION

/reference/engine/globals/LuaGlobals.yaml

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


Luau

Array

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.

bool

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

void

Vue d'ensemble

Guides

Tutoriels

Référence

Ressources

Conception

Moteur

Avatar

Cloud

Ce champ peut être défini lors de la création d'une ressource, mais ne peut pas être modifié par des requêtes ultérieures.

Ce champ peut être fourni dans les demandes, mais ne sera jamais inclus dans les réponses.

Par clé API : {maxInPeriod} demande toutes les {periodInSeconds} secondes par adresse IP

Ce champ peut être défini sur les réponses, mais sera ignoré dans les demandes.

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus
d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] ({apiKeyReferenceDocLink}).

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Cette chaîne est formatée comme un [FieldMask](/cloud/reference/types#fieldmask).

Une valeur JSON peut être `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révisions des applis]({oauth2ReferenceDocLink}).

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

Ce string est formatée en tant que [Timestamp](/cloud/reference/types#timestamp).

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. ({oauth2ReferenceDocLink}).

Cela permet de consulter des informations sur vos contenus.

Il permet de télécharger et de mettre à jour des actifs sur Roblox.

Cela vous permet d'afficher des informations sur vos produits de la Boutique du créateur.

Cela permet d'afficher des informations sur vos groupes.

Cela vous permet de gérer les demandes d'adhésion de groupe pour votre compte.

Cela permet de publier des messages au nom des utilisateurs.

Cela permet d'envoyer des notifications de votre expérience aux utilisateurs

Cela permet d'énumérer les secrets liés à ton expérience.

Cela permet de créer et de mettre à jour des secrets liés à ton expérience.

Donne la capacité de lire les informations sur les lieux.

Donne la possibilité d'éditer les informations du lieu.

Cette opération donne accès à la publication de nouvelles versions d'expériences à Roblox.

Donne la possibilité de lire des informations sur l'expérience.

Donne la possibilité de modifier les informations d'expérience.

Permet de voir les restrictions de l'utilisateur dans l'expérience.

Vous permet de modifier les restrictions d'utilisateur dans l'expérience.

Donne la possibilité de lire le statut premium et vérifié de l'utilisateur.

Cela vous permet de voir les comptes sociaux d'un utilisateur.

Cela active la fonctionnalité Single Sign-On

Cela vous donne accès à la lecture des informations de votre profil

Valeur par défaut : {defaultValueStart}{defaultValueEnd}

Un tableau est une liste ordonnée de valeurs. Les tableaux sont utiles pour stocker des collections de données.

Un ensemble de paires clé-valeur, où les clés peuvent être n'importe quel nombre, chaîne ou objet.

Cette fonction revient immédiatement si possible, mais peut céder le thread qui l'a appelée jusqu'à ce qu'elle puisse retourner une valeur.

{nameStart}nom{nameEnd} n'est plus supporté ou maintenu par Roblox.

Cette opération mathématique n'est plus prise en charge ou maintenue par Roblox.

Ce membre n'apparaît pas dans le navigateur d'objet et n'est pas destiné à une utilisation généralisée.

Ce membre n'est accessible que via la barre de commande. Tenter d'accéder à ce membre à partir de scripts provoque une erreur.

Cette fonction ne peut pas mettre en pause le thread Lua qui l’appelle.

Tenter d'accéder à ce membre dans les scripts provoque une erreur. Tu peux accéder à ce membre à partir de la fenêtre de propriété de Roblox Studios.

Ce membre n’apparaît pas dans le navigateur Objet de Roblox Studio.

Tu ne peux pas créer une instance de cette classe avec le constructeur Instance.new .

Roblox ne réplique pas ce membre à travers sa limite client serveur.

Le code Lua ne peut pas accéder à ce membre. Tu pourrais être en mesure de changer sa valeur depuis la fenêtre de la propriété dans Roblox Studio.

Le comportement de réplication de cet objet dépend du joueur qui le possède.

Ce membre n'est accessible que par le biais de la barre de commandes et des plugins uniquement. Tenter d'accéder à ce membre à partir de scripts provoque une erreur.

Cette propriété est en lecture seule et peut être lue en toute sécurité dans les threads non synchronisés. Toute tentative d'écriture dans cette propriété entraîne une erreur.

Ce membre est en lecture seule. Tenter d'écrire à ce membre provoque une erreur.

Ce membre n'est accessible que dans CoreScripts.

Seul Roblox CoreScripts peut accéder à ce membre, et il n’est pas utilisable par les joueurs.

Tu peux lire et écrire cette propriété en toute sécurité à partir de plusieurs threads.

Cette classe est un singleton de premier niveau. Récupére une instance de cette classe avec la fonction GetService.

Plusieurs threads peuvent potentiellement écrire dans cette propriété, donc il n'est pas sûr de lire à partir de threads non synchronisés.

Vous pouvez lire et écrire sur cette propriété en toute sécurité à partir de plusieurs threads.

Cette fonction met en pause le thread Lua qui l'a appelée jusqu'à ce qu'elle renvoie un résultat. Cela n'interrompt pas les autres scripts.

Lua Globals

Résumé

Fonctions

Propriétés

Fonctions

assert

Paramètres

Retours

collectgarbage

Paramètres

Retours

error

Paramètres

Retours

getmetatable

Paramètres

Retours

ipairs

Paramètres

Retours

loadstring

Paramètres

Retours

newproxy

Paramètres

Retours

next

Paramètres

Retours

pairs

Paramètres

Retours

pcall

Paramètres

Retours

print

Paramètres

Retours

rawequal

Paramètres

Retours

rawget

Paramètres

Retours

rawlen

Paramètres

Retours

rawset

Paramètres

Retours

select

Paramètres

Retours

setmetatable

Paramètres

Retours

tonumber

Paramètres

Retours

tostring

Paramètres

Retours

type

Paramètres

Retours

unpack

Paramètres

Retours

xpcall

Paramètres

Retours

Propriétés

_G

_VERSION