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 Lua sandbox only allows the `count` option to be used (the total
memory in use by Lua, 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 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`.

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


Runs the supplied `Class.ModuleScript` and returns what the
`Class.ModuleScript` returned (usually a table or a function). 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.


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


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.


Lua Globals

_VERSION

/reference/engine/globals/LuaGlobals.yaml

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


Luau

Array

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.

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.

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

Tổng Quan

Hướng Dẫn

Tham Khảo

Tài Nguyên

Nghệ Thuật

Thiết Kế

Động Cơ

Avatar

Đám Mây

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] ({longRunningOperationsLink}) về các hoạt động kéo dài để biết thêm thông tin.
            
Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Các đầu cuối beta đã sẵn sàng cho việc sử dụng công khai. Có thể xuất hiện những thay đổi bất ngờ, nhưng trường hợp này rất hiếm.

Trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Trường này có thể được cung cấp trong các yêu cầu, nhưng sẽ không bao giờ được đưa vào các phản hồi.

Mỗi Khóa API: {maxInPeriod} yêu cầu mỗi {periodInSeconds} giây cho mỗi Địa Chỉ IP

Trường này có thể được đặt thành các phản hồi, nhưng sẽ bị bỏ qua trong các yêu cầu.

Cần có các quyền khóa API sau đây để gọi điểm cuối này. Để biết thêm
thông tin về cách tạo các khóa thích hợp, xem [Quản lý Khóa API] ({apiKeyReferenceDocLink}).

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Chuỗi này được định dạng là [Mặt nạ trường](/cloud/reference/types#timestamp).

Giá trị JSON có thể là `null`, `boolean`, `string`, `number`, `array` hoặc `object`.

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng Ký và Đánh Giá Ứng Dụng]({oauth2ReferenceDocLink}).

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

Chuỗi này được định dạng là [Dấu thời gian](/cloud/reference/types#timestamp).

Không có mô tả nào được cung cấp.

Điều này cho phép bạn xem thông tin về tài sản của mình.

Điều này cho phép bạn tải lên và cập nhật tài sản vào Roblox.

Cấp khả năng cập nhật huy hiệu mà người dùng sở hữu.

Điều này cho phép bạn xem thông tin về vật phẩm thương mại của mình.

Điều này cho phép bạn chỉnh sửa các kết nối người bán thương mại.

Điều này cho phép bạn xem thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn sửa đổi thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn xem thông tin về nhóm của mình.

Điều này cho phép bạn quản lý các yêu cầu tham gia nhóm cho tài khoản của bạn.

Điều này cho phép bạn xem thông tin về kho của mình.

Cấp quyền truy cập để quản lý huy hiệu của bạn.

Cấp quyền để quản lý huy hiệu của bạn và chi tiêu robux.

Cấp quyền quản lý các sản phẩm phát triển của bạn.

Cấp quyền đọc thông tin về các trải nghiệm mà bạn đang theo dõi.

Cấp quyền thay mặt bạn theo dõi và bỏ theo dõi các trải nghiệm.

Cấp quyền truy cập để quản lý vé của bạn.

Cấp quyền truy cập để quản lý các nhóm của bạn.

Cấp quyền để đọc thông tin nhóm.

Cấp quyền để đọc và ghi các bảng bản địa hóa của bạn

Cấp quyền truy cập để quản lý hoạt động cộng tác đội cho tất cả các trải nghiệm của bạn.

Cấp quyền truy cập để quản lý các trải nghiệm của bạn và một số thông tin cụ thể gắn liền với các trải nghiệm đó (ví dụ: thông tin bản địa hóa).

Cấp quyền để đọc thông tin bản địa hóa của các trải nghiệm của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa trải nghiệm của bạn.

Cấp quyền truy cập để quản lý tài khoản người dùng của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa của người dùng.

Điều này cho phép bạn đăng tải tin nhắn thay mặt cho người dùng.

Điều này cho phép gửi các thông báo từ trải nghiệm của bạn đến người dùng.

Điều này cho phép bạn liệt kê mã liên quan đến trải nghiệm của bạn.

Điều này cho phép bạn tạo và cập nhật mã liên quan đến trải nghiệm của bạn.

Cấp quyền để đọc về các trang bị đặc quyền của bạn.

Cấp khả năng đọc thông tin địa điểm.

Cấp khả năng chỉnh sửa thông tin địa điểm.

Thao tác này cấp quyền đăng tải các phiên bản mới của trải nghiệm cho Roblox.

Cấp khả năng đọc thông tin trải nghiệm.

Cấp khả năng chỉnh sửa thông tin trải nghiệm.

Cho phép bạn xem các hạn chế của người dùng trong trải nghiệm.

Cho phép bạn chỉnh sửa các hạn chế người dùng trong trải nghiệm.

Cấp khả năng đọc trạng thái premium và trạng thái đã xác thực của người dùng.

Điều này cho phép bạn xem các tài khoản mạng xã hội của người dùng.

Điều này cho phép kích hoạt chức năng Đăng Nhập Một Lần.

Điều này cho phép người dùng đọc thông tin hồ sơ của bạn.

Lua Globals

Tóm Tắt

Chức Năng

Thuộc Tính

Chức Năng

assert

Tham Số

Lợi Nhuận

error

Tham Số

Lợi Nhuận

gcinfo

Lợi Nhuận

getmetatable

Tham Số

Lợi Nhuận

ipairs

Tham Số

Lợi Nhuận

loadstring

Tham Số

Lợi Nhuận

newproxy

Tham Số

Lợi Nhuận

next

Tham Số

Lợi Nhuận

pairs

Tham Số

Lợi Nhuận

pcall

Tham Số

Lợi Nhuận

print

Tham Số

Lợi Nhuận

rawequal

Tham Số

Lợi Nhuận

rawget

Tham Số

Lợi Nhuận

rawlen

Tham Số

Lợi Nhuận

rawset

Tham Số

Lợi Nhuận

require

Tham Số

Lợi Nhuận

select

Tham Số

Lợi Nhuận

setmetatable

Tham Số

Lợi Nhuận

tonumber

Tham Số

Lợi Nhuận

tostring

Tham Số

Lợi Nhuận

type

Tham Số

Lợi Nhuận

unpack

Tham Số

Lợi Nhuận

xpcall

Tham Số

Lợi Nhuận

Thuộc Tính

_G

_VERSION