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

개요

가이드

튜토리얼

참조

리소스

아트

디자인

엔진

Avatar

클라우드

이 필드는 리소스를 생성할 때 설정될 수 있지만 후속 요청에 의해 수정될 수는 없습니다.

이 필드는 요청에 제공될 수 있지만 응답에는 포함되지 않습니다.

각 API 키별: IP 주소당 {periodInSeconds}초마다 {maxInPeriod} 요청

이 필드는 요청에서 무시됩니다.

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한
자세한 내용은 [API 키 관리]({apiKeyReferenceDocLink})에서 확인하세요.

다음 끝점은 기준 URL과 관련된 경로에서 사용할 수 있습니다.

이 문자열은 [FieldMask](/cloud/reference/types#fieldmask) 형식으로 지정됩니다.

JSON 값은 `null`, `boolean`, `string`, `number`, `array`, `object`일 수 있습니다.

OAuth 2.0 애플리케이션에서 이 엔드포인트를 사용하려면 다음 범위가 필요합니다. OAuth 2.0 애플리케이션 등록 방법에 대한 자세한 내용은 [앱 등록 및 심사]({oauth2ReferenceDocLink})에서 확인하세요.

다음 개체는 수락되거나 반환되는 페이로드를 설명합니다. 이러한 개체가 사용되는 시기에 대한 자세한 정보는 각 개별 끝점을 참고하세요.

이 문자열은 [Timestamp](/cloud/reference/types#timestamp) 형식으로 지정됩니다.

이를 통해 애셋에 대한 정보를 볼 수 있습니다.

이를 통해 애셋을 Roblox에 업로드하고 업데이트할 수 있습니다.

이를 통해 크리에이터 상점 상품에 대한 정보를 볼 수 있습니다.

이를 통해 크리에이터 상점 상품에 대한 정보를 수정할 수 있습니다.

이를 통해 그룹에 대한 정보를 볼 수 있습니다.

이제 계정에 대한 그룹 가입 요청을 관리할 수 있습니다.

이를 통해 인벤토리에 대한 정보를 볼 수 있습니다.

사용자를 대신해 메시지를 게시할 수 있는 권한이 부여됩니다.

이를 통해 체험에서 사용자에게 알림을 보낼 수 있습니다

이를 통해 체험과 관련된 시크릿을 나열할 수 있습니다.

이를 통해 체험과 관련된 시크릿을 생성하고 업데이트할 수 있습니다.

플레이스 정보를 읽을 수 있는 권한을 부여합니다.

플레이스 정보를 편집할 수 있는 권한을 부여합니다.

이 작업은 새로운 버전의 체험을 Roblox에 게시할 수 있는 권한을 부여합니다.

체험 정보를 읽을 수 있는 권한을 부여합니다.

체험 정보를 편집할 수 있는 권한을 부여합니다.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

사용자의 Premium 및 인증 상태를 읽을 수 있는 권한을 부여합니다.

이를 통해 사용자의 소셜 계정을 볼 수 있습니다.

이 작업은 싱글 사인온 기능을 활성화합니다

프로필 정보를 읽을 수 있는 액세스 권한을 부여합니다

기본값: {defaultValueStart}{defaultValueEnd}

배열은 순서가 지정된 값 목록입니다. 배열은 데이터 컬렉션을 저장하는 데 유용합니다.

키-값 쌍 집합으로, 이때 키는 숫자, 문자열 또는 개체일 수 있습니다.

{tuples}(와)과 마찬가지로, 값의 목록입니다.

이 함수는 가능한 경우 즉시 반환하지만, 값을 반환할 수 있을 때까지 호출한 스레드를 일시 중단할 수 있습니다.

{nameStart}이름{nameEnd}(은)는 더 이상 Roblox에서 지원하거나 유지 관리하지 않습니다.

이 수학 연산은 더 이상 Roblox에서 지원하거나 유지 관리하지 않습니다.

이 멤버는 개체 브라우저에 표시되지 않으며 널리 사용하기 위한 것이 아닙니다.

이 멤버는 명령 모음을 통해서만 액세스할 수 있습니다. 스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다.

이 함수는 호출한 Lua 스레드를 일시 중지할 수 없습니다.

스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다. Roblox Studio의 속성 창에서 이 멤버에 액세스가 가능할 수 있습니다.

이 멤버는 Roblox Studio의 개체 브라우저에 표시되지 않습니다.

Instance.new 생성자로 이 클래스의 인스턴스를 만들 수 없습니다.

Roblox는 서버-클라이언트 경계를 넘어 이 멤버를 복제하지 않습니다.

Lua 코드는 이 멤버에 액세스할 수 없습니다. Roblox Studio의 속성 창에서 값의 변경이 가능할 수 있습니다.

이 개체의 복제 동작은 개체를 소유한 플레이어에 따라 다릅니다.

이 멤버는 명령 모음 및 플러그인을 통해서만 액세스할 수 있습니다. 스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다.

이 속성은 읽기 전용이며 동기화되지 않은 스레드에서 안전하게 읽을 수 있습니다. 쓰기를 시도하면 오류가 발생합니다.

이 멤버는 읽기 전용입니다. 이 멤버에 쓰려고 하면 오류가 발생합니다.

이 멤버는 CoreScript에서만 액세스할 수 있습니다.

Roblox CoreScript만 이 멤버에 액세스할 수 있으며, Players는 이를 사용할 수 없습니다.

여러 스레드에서 이 속성에 안전하게 읽고 쓸 수 있습니다.

이 클래스는 최상위 Singleton입니다. GetService 함수를 사용해 이 클래스의 인스턴스를 가져옵니다.

여러 스레드가 이 속성에 쓸 수 있으므로, 동기화되지 않은 스레드에서 읽는 것은 안전하지 않습니다.

이 함수는 결과를 반환할 때까지 호출한 Lua 스레드를 일시 중지합니다. 다른 스크립트를 방해하지 않습니다.

Lua Globals

요약

함수

속성

함수

assert

매개 변수

반환

collectgarbage

매개 변수

반환

error

매개 변수

반환

getmetatable

매개 변수

반환

ipairs

매개 변수

반환

loadstring

매개 변수

반환

newproxy

매개 변수

반환

next

매개 변수

반환

pairs

매개 변수

반환

pcall

매개 변수

반환

print

매개 변수

반환

rawequal

매개 변수

반환

rawget

매개 변수

반환

rawlen

매개 변수

반환

rawset

매개 변수

반환

select

매개 변수

반환

setmetatable

매개 변수

반환

tonumber

매개 변수

반환

tostring

매개 변수

반환

type

매개 변수

반환

unpack

매개 변수

반환

xpcall

매개 변수

반환

속성

_G

_VERSION