Skip to content

LuaError

Description

A LuaError represents an error that happened in Lua.

Info

Most functions in this addon return either a LuaError or null.

Tip

You may return a LuaError object from a GDScript function, called from Lua, in order to cause an error in Lua.

Enumerations

ErrorType

Name Value Description
ERR_TYPE 1 Invalid type error. For example, passing a string when an int was expected.
ERR_RUNTIME 2 Lua runtime error.
ERR_SYNTAX 3 Lua syntax error.
ERR_MEMORY 4 Lua ran out of memory.
ERR_ERR 5 Error while handling another error.
ERR_FILE 6 Error while opening or reading a file.

Properties

message String

A string containing the error message.

type ErrorType

An enum representing the type of the error.

Methods

new_error LuaError

Static function that acts as a constructor for new instances of the LuaError class.

Parameters

Parameters Description
message: String The error message.
type: ErrorType An enum representing the type of this error.

Returns

LuaError

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
func test(n: int):
    if n != 5:
        ## This will raise an error in the Lua state.
        return LuaError.new_error("N is not 5 but is %s" % n, LuaError.ERR_RUNTIME)
    return n+5

func _ready():
    lua = LuaAPI.new()
    lua.push_variant("test", test)
    ## Most methods return a LuaError.
    ## Calling "test" with a type that is not a int would also raise a error.
    var err = lua.do_string("test(6)")
    ## If an error does not occur, err will be null.
    if err is LuaError:
        print("ERROR %d: " % err.type + err.message)
Output
ERROR 2: [LUA_ERRRUN - runtime error ]
N is not 5 but is 6
stack traceback:
    [string "test(6)"]:1: in main chunk