Workaround for lack of CallableCustom & permissive defaulted to true (#131)

Author: Trey2k

.github/workflows/windows.yml

@@ -145,12 +145,12 @@ jobs:
 
           mv scripts/godot/bin/godot.windows.template_release.x86_64.luaAPI.exe scripts/godot/templates/windows_release_x86_64.exe || true
           mv scripts/godot/bin/godot.windows.template_debug.x86_64.luaAPI.exe scripts/godot/templates/windows_debug_x86_64.exe || true
-          mv scripts/godot/bin/godot.windows.template_release.x86_32.luaAPI.exe scripts/godot/templates/windows_release_x32_64.exe || true
+          mv scripts/godot/bin/godot.windows.template_release.x86_32.luaAPI.exe scripts/godot/templates/windows_release_x86_32.exe || true
           mv scripts/godot/bin/godot.windows.template_debug.x86_32.luaAPI.exe scripts/godot/templates/windows_debug_x86_32.exe || true
           
           mv scripts/godot/bin/godot.windows.template_release.x86_64.luaAPI.console.exe scripts/godot/templates/windows_release_x86_64_console.exe || true
           mv scripts/godot/bin/godot.windows.template_debug.x86_64.luaAPI.console.exe scripts/godot/templates/windows_debug_x86_64_console.exe || true
-          mv scripts/godot/bin/godot.windows.template_release.x86_32.luaAPI.console.exe scripts/godot/templates/windows_release_x32_64_console.exe || true
+          mv scripts/godot/bin/godot.windows.template_release.x86_32.luaAPI.console.exe scripts/godot/templates/windows_release_x86_32_console.exe || true
           mv scripts/godot/bin/godot.windows.template_debug.x86_32.luaAPI.console.exe scripts/godot/templates/windows_debug_x86_32_console.exe || true
 
           

README.md

@@ -14,8 +14,6 @@ About
 ![Logo](.github/LuaAPI.png)
 Art created by [Alex](https://www.instagram.com/redheadalex1)
 
-***WARNING!!!*** this is a **beta** version of the addon made for Godot v4.0-stable. Which means frequent recompiles may be required and compatibility is not guaranteed between updates.
-
 This is a Godot addon that adds Lua API support via GDScript, C# or GDExtension. Importantly this is **NOT** meant to be a replacement for or alternative to GDScript. This addon provides no functionality to program your game out of the box. This addon allows you to create custom Modding API's in a sandboxed environment. You have control of what people can and can not do within that sandbox.
 
 To use you can either [Compile from source](#compiling) or you can download one of the [release builds](#release-builds).
@@ -39,10 +37,9 @@ Features
 - Push any Variant as a global.
 - Call Lua functions from GDScript.
 - Choose which libraries you want Lua to have access to.
-- Custom LuaCallable type which allows you to get a Lua function as a Callable. See [wiki](https://luaapi.weaselgames.info/v2.0-beta/examples/lua_callable/).
 - LuaError type which is used to report any errors this addon or Lua run into.
 - LuaCoroutine type which creates a Lua thread. This is not a OS thread but a coroutine.
-- Object passed as userdata. See [wiki](https://luaapi.weaselgames.info/v2.0-beta/examples/objects/).
+- Object passed as userdata. See [wiki](https://luaapi.weaselgames.info/latest/examples/objects/).
 - Objects can override most of the Lua metamethods. I.E. __index by defining a function with the same name.
 - Callables passed as userdata, which allows you to push a Callable as a Lua function.
 - Basic types are passed as userdata (currently: Vector2, Vector3, Color, Rect2, Plane) with a useful metatable. This means you can do things like:
@@ -72,9 +69,7 @@ Release Builds
 
 TODO
 -----
-- Finish v2 documentation
 - Workaround for lack of CallableCustoms in GDExtension
-- More up to date todo list on the v2 [project](https://github.com/WeaselGames/godot_luaAPI/projects/1)
 
 Compiling
 ------------
@@ -97,7 +92,7 @@ var lua: LuaAPI = LuaAPI.new()
 func _lua_print(message: String) -> void:
 	print(message)
 
-func _ready():
+func _ready() -> void:
 	lua.push_variant("print", _lua_print)
 	lua.push_variant("message", "Hello lua!")
 
@@ -122,7 +117,7 @@ func _ready():
 		print("ERROR %d: %s" % [err.type, err.message])
 		return
 
-	var message = val.call()
+	var message = val.call([])
 	print(message)
 ```
 Contributing And Feature Requests

doc_classes/LuaAPI.xml

@@ -64,6 +64,15 @@
 				Calls a function inside current Lua state. This can be either a exposed function or a function defined with with Lua. You may want to check if the function actually exists with [code]function_exists(LuaFunctionName)[/code]. This function supports 1 return value from lua. It will be returned as a variant and if Lua returns no value it will be null. If an error occurs while calling this function, a LuaError object will be returned.
 			</description>
 		</method>
+		<method name="call_function_ref">
+			<return type="Variant" />
+			<param index="0" name="Args" type="Array" />
+			<param index="1" name="LuaFunctionRef" type="int" />
+			<description>
+				This method is used to create a Callable when pulling a lua function from the stack. It is not intended to be called directly.
+				When returning a Callable, the function ref is bound to the Callable. You must only supply the arguments.
+			</description>
+		</method>
 		<method name="pull_variant">
 			<return type="Variant" />
 			<param index="0" name="Name" type="String" />
@@ -97,8 +106,8 @@
 			</description>
 	</methods>
 	<members>
-		<member name="permissive" type="bool" setter="set_permissive" getter="get_permissive" default="false">
-			Set weather an objects lua_fields method should be treated as a blacklist instead of a whitelist.
+		<member name="permissive" type="bool" setter="set_permissive" getter="get_permissive" default="true">
+			When set to true all methods will be allowed on Objects be default and lua_fields is treated as a blacklist. When set to false, lua_fields is treated as a whitelist.
 		</member>
 	</members>
 	<constants>

doc_classes/LuaCoroutine.xml

@@ -20,7 +20,7 @@
 			<return type="LuaError" />
 			<param index="0" name="args" type="Array" />
 			<description>
-				Must be called from a lua hook. Will yield the lua state and pass arguments to `reumse()`. Can be destructive.
+				Must be called from a lua hook. Will yield the lua state and pass arguments to `resume()`. Can be destructive.
 			</description>
 		</method>
 		<method name="bind">

project/testing/tests/LuaAPI.call_function.gd

@@ -48,17 +48,14 @@ func _process(delta):
 
 	var testCallable = lua.pull_variant("test")
 	if testCallable is LuaError:
-		if testCallable.type == LuaError.ERR_RUNTIME:
-			done = true # This is because GDExtension does not support luaCallables
-			return
 		errors.append(testCallable)
 		return fail()
 
 	if not testCallable is Callable:
 		errors.append(LuaError.new_error("testCallable is not Callable but is '%d'" % typeof(testCallable), LuaError.ERR_TYPE))
 		return fail()
 
-	var cret = testCallable.call(5)
+	var cret = testCallable.call([5])
 	if cret is LuaError:
 		errors.append(cret)
 		return fail()

register_types.cpp

@@ -1,6 +1,5 @@
 #include "register_types.h"
 #include "src/classes/luaAPI.h"
-#include "src/classes/luaCallable.h"
 #include "src/classes/luaCallableExtra.h"
 #include "src/classes/luaCoroutine.h"
 #include "src/classes/luaError.h"

src/classes/luaAPI.cpp

@@ -2,6 +2,8 @@
 
 #include "luaCoroutine.h"
 
+#include <luaState.h>
+
 #ifdef LAPI_GDEXTENSION
 #include <godot_cpp/classes/file_access.hpp>
 #endif
@@ -28,6 +30,7 @@ void LuaAPI::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("pull_variant", "Name"), &LuaAPI::pullVariant);
 	ClassDB::bind_method(D_METHOD("expose_constructor", "LuaConstructorName", "Object"), &LuaAPI::exposeObjectConstructor);
 	ClassDB::bind_method(D_METHOD("call_function", "LuaFunctionName", "Args"), &LuaAPI::callFunction);
+	ClassDB::bind_method(D_METHOD("call_function_ref", "Args", "LuaFunctionRef"), &LuaAPI::callFunctionRef);
 	ClassDB::bind_method(D_METHOD("function_exists", "LuaFunctionName"), &LuaAPI::luaFunctionExists);
 
 	ClassDB::bind_method(D_METHOD("new_coroutine"), &LuaAPI::newCoroutine);
@@ -77,6 +80,31 @@ Variant LuaAPI::callFunction(String functionName, Array args) {
 	return state.callFunction(functionName, args);
 }
 
+// Invokes the passed lua reference
+Variant LuaAPI::callFunctionRef(Array args, int funcRef) {
+	lua_pushcfunction(lState, LuaState::luaErrorHandler);
+
+	// Getting the lua function via the reference stored in funcRef
+	lua_rawgeti(lState, LUA_REGISTRYINDEX, funcRef);
+
+	// Push all the argument on to the stack
+	for (int i = 0; i < args.size(); i++) {
+		LuaState::pushVariant(lState, args[i]);
+	}
+
+	Variant toReturn;
+	// execute the function using a protected call.
+	int ret = lua_pcall(lState, args.size(), 1, -2 - args.size());
+	if (ret != LUA_OK) {
+		toReturn = LuaState::handleError(lState, ret);
+	} else {
+		toReturn = LuaState::getVariant(lState, -1, this);
+	}
+
+	lua_pop(lState, 1);
+	return toReturn;
+}
+
 // Calls LuaState::pushGlobalVariant()
 LuaError *LuaAPI::pushGlobalVariant(String name, Variant var) {
 	return state.pushGlobalVariant(name, var);

src/classes/luaAPI.h

@@ -48,6 +48,7 @@ class LuaAPI : public RefCounted {
 
 	Variant pullVariant(String name);
 	Variant callFunction(String functionName, Array args);
+	Variant callFunctionRef(Array args, int funcRef);
 
 	LuaError *doFile(String fileName);
 	LuaError *doString(String code);
@@ -82,7 +83,7 @@ class LuaAPI : public RefCounted {
 	LuaState state;
 	lua_State *lState = nullptr;
 
-	bool permissive = false;
+	bool permissive = true;
 
 	LuaError *execute(int handlerIndex);
 };