Skip to content

LuaCallableExtra

Description

A wrapper for Callables used to create functions that accept either any amount of arguments from Lua as a single LuaTuple parameter or that accept a reference to the LuaAPI object from which the method was invoked, or both.

Properties

argc number

An integer representing the number of expected arguments.

tuple bool

Wether or not the last parameter should be of the type LuaTuple.

wants_ref bool

Wether or not the method expects a reference to the LuaAPI object that invoked it.

Methods

with_ref LuaCallableExtra

Static method that creates a LuaCallableExtra. A reference to the LuaAPI object that invoked the method will be passed as an argument to the callable.

Parameters

Parameters Description
callable: Callable The associated callable.

Returns

LuaCallableExtra

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
extends Node2D

var lua: LuaAPI

func _ready():
    lua = LuaAPI.new()
    lua.push_variant("myFunction", LuaCallableExtra.with_ref(my_function))
    lua.do_string("myFunction()")

func my_function(lua_object: LuaAPI):
    print("I was invoked by ", lua_object)
Example Output
I was invoked by <LuaAPI#-9223372010447437397>

with_tuple LuaCallableExtra

Static method that creates a LuaCallableExtra. A reference to the LuaAPI object that invoked the method will be passed as an argument to the callable. By specifying the number of expected arguments in this function, the module will be able to add all, if any, extra arguments to a LuaTuple, which will always be the last parameter.

Parameters

Parameters Description
callable: Callable The associated callable.
arg count: number The number of expected arguments excluding the tuple one.

Returns

LuaCallableExtra

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
extends Node2D

var lua: LuaAPI

func _ready():
    lua = LuaAPI.new()
    lua.push_variant(
        "somator",
        LuaCallableExtra.with_tuple(my_somator_function, 1)
    )
    lua.do_string("somator(1, 2, 3, 4)")

func my_somator_function(args: LuaTuple):
    var sum := 0
    for index in range(0, args.size()):
        sum += args.get_value(index)
    print(sum)
    return sum
Output
10

with_ref_and_tuple LuaCallableExtra

Static method that creates a LuaCallableExtra. By specifying the number of expected arguments in this function, the module will be able to add all, if any, extra arguments to a LuaTuple, which will always be the last parameter.

Note

This method is similar to with_ref and with_tuple combined.

Parameters

Parameters Description
callable: Callable The associated callable.
arg count: number The number of expected arguments excluding the tuple one.

Returns

LuaCallableExtra

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
extends Node2D

var lua: LuaAPI

func _ready():
    lua = LuaAPI.new()

    # This will replace the built-in print function with ours.
    lua.push_variant("print", LuaCallableExtra.with_ref_and_tuple(custom_print_function, 0))

    lua.do_string("""
        print('Hello!', ' How are you?', ' I havent seen you in ', 10, ' days.')
    """)

func custom_print_function(lua_object: LuaAPI, args: LuaTuple):
    print(args.to_array(), " -- ", lua_object)

set_info void

Alternative way to configure a LuaCallableExtra. This method is particularly useful for methods that expect both a LuaTuple and a reference to the LuaAPI object.

Parameters

Parameters Description
callable: Callable The associated callable.
arg count: number The number of expected arguments excluding the tuple one.
isTuple: bool Wether or not the last parameter should be of the type LuaTuple.
wantsRef: bool Wether or not to pass a reference to the LuaAPI object.

Returns

void

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
extends Node2D

var lua: LuaAPI

func _ready():
    lua = LuaAPI.new()

    # Wrap custom_print_function with a LuaCallableExtra.
    var luaCallableExtra = LuaCallableExtra.new()
    luaCallableExtra.set_info(custom_print_function, 0, true, true)

    # This will replace the built-in print function with ours.
    lua.push_variant("print", luaCallableExtra)

    lua.do_string("""
        print('Hello!', ' How are you?', ' I havent seen you in ', 10, ' days.')
    """)

func custom_print_function(lua_object: LuaAPI, args: LuaTuple):
    print(args.to_array(), " -- ", lua_object)