LuaState

Experimental: This class may be changed or removed in future versions.

Inherits: RefCounted < Object

Embedded Luau virtual machine for sandboxed scripting.

Description

LuaState wraps a sandboxed Luau VM for embedded scripting from GDScript or C#.

When passing C# callbacks into Luau, wrap them in a Callable before pushing them into the VM.

Tutorials

Luau Module Developer Examples

Methods

int	abs_index(index: int)
void	arg_error(index: int, message: String)
Callable	bind_callable(callable: Callable) static
void	break_execution()
bool	call_meta(index: int, field: StringName)
bool	check_stack(size: int)
void	clear_table(index: int)
void	clone_function(index: int)
void	clone_table(index: int)
void	close()
CoStatus	co_status(co: LuaState)
void	concat(count: int)
Status	cpcall(callable: Callable)
void	create_table(narr: int = 0, nrec: int = 0)
String	debug_trace()
Status	do_string(code: String, chunk_name: String = "", env: int = 0, nargs: int = 0, nresults: int = -1, errfunc: int = 0)
void	enforce_any(index: int)
PackedByteArray	enforce_buffer(index: int)
Object	enforce_full_userdata(index: int, tname: StringName)
int	enforce_integer(index: int)
float	enforce_number(index: int)
int	enforce_option(index: int, options: PackedStringArray, default: String = "")
void	enforce_stack(size: int, message: String)
String	enforce_string_inplace(index: int)
StringName	enforce_string_name(index: int)
void	enforce_type(index: int, type: ValueType)
Vector3	enforce_vector3(index: int)
bool	equal(index1: int, index2: int)
void	error()
int	full_userdata_tag(index: int)
int	gc(what: GCOp, data: int)
bool	get_argument(level: int, narg: int)
void	get_coverage(funcindex: int, callback: Callable)
void	get_fenv(index: int)
ValueType	get_field(index: int, key: StringName)
void	get_full_userdata_metatable(tag: int)
ValueType	get_global(key: StringName)
LuaDebug	get_info(level: int, what: String)
StringName	get_light_userdata_name(tag: int)
StringName	get_local(level: int, nlocal: int)
LuaState	get_main_thread()
bool	get_meta_field(index: int, field: StringName)
bool	get_metatable(index: int)
ValueType	get_metatable_named(tname: StringName)
StringName	get_namecall()
bool	get_read_only(index: int)
void	get_ref(ref: int)
int	get_stack_depth()
ValueType	get_table(index: int)
int	get_top()
int	get_total_bytes(category: int)
StringName	get_upvalue(funcindex: int, nupvalue: int)
void	insert(index: int)
bool	is_array(index: int)
bool	is_boolean(index: int)
bool	is_buffer(index: int)
bool	is_c_function(index: int)
bool	is_full_userdata(index: int)
bool	is_function(index: int)
bool	is_light_userdata(index: int)
bool	is_lua_function(index: int)
bool	is_main_thread() const
bool	is_nil(index: int)
bool	is_none(index: int)
bool	is_none_or_nil(index: int)
bool	is_number(index: int)
bool	is_object(index: int, tag: int = -1)
bool	is_string(index: int)
bool	is_table(index: int)
bool	is_thread(index: int)
bool	is_thread_reset()
bool	is_userdata(index: int)
bool	is_valid() const
bool	is_vector(index: int)
bool	is_yieldable()
bool	less_than(index1: int, index2: int)
int	light_userdata_tag(index: int)
bool	load_bytecode(bytecode: PackedByteArray, chunk_name: String, env: int = 0)
bool	load_string(code: String, chunk_name: String, env: int = 0)
bool	new_metatable_named(tname: StringName)
LuaState	new_thread()
bool	next(index: int)
int	obj_len(index: int)
void	open_libs(libs: BitField[LibraryFlags] = 4095)
int	opt_integer(index: int, default: int)
float	opt_number(index: int, default: float)
String	opt_string_inplace(index: int, default: String)
StringName	opt_string_name(index: int, default: StringName)
Vector3	opt_vector3(index: int, default: Vector3)
Status	pcall(nargs: int, nresults: int, errfunc: int = 0)
void	pop(count: int)
void	print_where(level: int)
void	push_array(value: Array)
String	push_as_string(index: int)
void	push_boolean(b: bool)
void	push_callable(value: Callable)
void	push_default_object_metatable()
void	push_dictionary(value: Dictionary)
void	push_full_userdata(obj: Object, tag: int = -1)
void	push_integer(num: int)
void	push_light_userdata(obj: Object, tag: int = -1)
void	push_nil()
void	push_number(num: float)
void	push_object(obj: Object, tag: int = -1)
void	push_string(str: String)
void	push_string_name(string_name: StringName)
bool	push_thread()
void	push_value(index: int)
void	push_variant(value: Variant)
void	push_vector3(vec: Vector3)
void	raw_check_stack(size: int)
bool	raw_equal(index1: int, index2: int)
ValueType	raw_get(index: int)
ValueType	raw_get_field(index: int, key: StringName)
ValueType	raw_geti(index: int, n: int)
int	raw_iter(index: int, iter: int)
void	raw_set(index: int)
void	raw_set_field(index: int, key: StringName)
void	raw_seti(index: int, n: int)
int	ref(index: int)
void	register_library(lib_name: StringName, functions: Dictionary)
void	remove(index: int)
void	replace(index: int)
void	reset_thread()
Status	resume(narg: int = 0, from: LuaState = null)
Status	resume_error(from: LuaState = null)
void	sandbox()
void	sandbox_thread()
int	set_breakpoint(funcindex: int, nline: int, enabled: bool)
void	set_call_metamethod(metatable_index: int, callable: Callable)
bool	set_fenv(index: int)
void	set_field(index: int, key: StringName)
void	set_full_userdata_metatable(tag: int)
void	set_full_userdata_tag(index: int, tag: int)
void	set_global(key: StringName)
void	set_index_metamethod(metatable_index: int, callable: Callable)
void	set_interrupts(enabled: bool)
void	set_light_userdata_name(tag: int, name: StringName)
StringName	set_local(level: int, nlocal: int)
void	set_memory_category(category: int)
void	set_metatable(index: int)
void	set_newindex_metamethod(metatable_index: int, callable: Callable)
void	set_read_only(index: int, enabled: bool)
void	set_safe_env(index: int, enabled: bool)
void	set_single_step(enabled: bool)
void	set_table(index: int)
void	set_top(index: int)
StringName	set_upvalue(funcindex: int, nupvalue: int)
String	stack_to_string(index: int)
Status	status()
Array	to_array(index: int)
bool	to_boolean(index: int)
PackedByteArray	to_buffer(index: int)
Callable	to_callable(index: int)
Dictionary	to_dictionary(index: int)
Object	to_full_userdata(index: int, tag: int = -1)
int	to_integer(index: int)
Object	to_light_userdata(index: int, tag: int = -1)
float	to_number(index: int)
Object	to_object(index: int, tag: int = -1)
int	to_pointer(index: int)
String	to_string_inplace(index: int)
StringName	to_string_name(index: int)
LuaState	to_thread(index: int)
Variant	to_variant(index: int)
Vector3	to_vector3(index: int)
ValueType	type(index: int)
void	type_error(index: int, expected: StringName)
StringName	type_name(type_id: ValueType)
StringName	type_name_for_value(index: int)
void	unref(ref: int)
void	xmove(to_state: LuaState, count: int)
void	xpush(to_state: LuaState, index: int)
void	yield(nresults: int)

Signals

debugbreak(state: LuaState, debug_info: LuaDebug) 🔗

There is currently no description for this signal. Please help us by contributing one!

debugstep(state: LuaState) 🔗

There is currently no description for this signal. Please help us by contributing one!

interrupt(state: LuaState, gc_state: int) 🔗

There is currently no description for this signal. Please help us by contributing one!

Enumerations

flags LibraryFlags: 🔗

LibraryFlags LIB_BASE = 1

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_COROUTINE = 2

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_TABLE = 4

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_OS = 8

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_STRING = 16

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_BIT32 = 32

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_BUFFER = 64

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_UTF8 = 128

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_MATH = 256

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_DEBUG = 512

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_VECTOR = 1024

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_BLAZIUM = 2048

There is currently no description for this enum. Please help us by contributing one!

LibraryFlags LIB_ALL = 4095

There is currently no description for this enum. Please help us by contributing one!

enum ValueType: 🔗

ValueType VALUE_NONE = -1

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_NIL = 0

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_BOOLEAN = 1

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_LIGHTUSERDATA = 2

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_NUMBER = 3

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_VECTOR = 4

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_STRING = 5

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_TABLE = 6

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_FUNCTION = 7

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_USERDATA = 8

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_THREAD = 9

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_BUFFER = 10

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_PROTO = 11

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_UPVAL = 12

There is currently no description for this enum. Please help us by contributing one!

ValueType VALUE_DEADKEY = 13

There is currently no description for this enum. Please help us by contributing one!

enum Status: 🔗

Status STATUS_OK = 0

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_YIELD = 1

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_ERRRUN = 2

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_ERRSYNTAX = 3

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_ERRMEM = 4

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_ERRERR = 5

There is currently no description for this enum. Please help us by contributing one!

Status STATUS_BREAK = 6

There is currently no description for this enum. Please help us by contributing one!

enum CoStatus: 🔗

CoStatus CO_RUN = 0

There is currently no description for this enum. Please help us by contributing one!

CoStatus CO_SUSPENDED = 1

There is currently no description for this enum. Please help us by contributing one!

CoStatus CO_NORMAL = 2

There is currently no description for this enum. Please help us by contributing one!

CoStatus CO_FINISHED = 3

There is currently no description for this enum. Please help us by contributing one!

CoStatus CO_ERROR = 4

There is currently no description for this enum. Please help us by contributing one!

enum GCOp: 🔗

GCOp GC_STOP = 0

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_RESTART = 1

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_COLLECT = 2

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_COUNT = 3

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_COUNTB = 4

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_ISRUNNING = 5

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_STEP = 6

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_SETGOAL = 7

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_SETSTEPMUL = 8

There is currently no description for this enum. Please help us by contributing one!

GCOp GC_SETSTEPSIZE = 9

There is currently no description for this enum. Please help us by contributing one!