From 2a018cfa49e0a85d2984f6daf6ee3c3372bdafda Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Tue, 21 Jan 2014 22:59:08 +0100
Subject: Implemented cPluginManager:CallPlugin() API.

This function supersedes cPlugin:Call(), is safer to use in regards to multithreading and once again removes the need for the cPlugin class being exported at all.
---
 MCServer/Plugins/APIDump/APIDesc.lua     |  3 ++-
 MCServer/Plugins/Debuggers/Debuggers.lua | 35 +++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 2 deletions(-)

(limited to 'MCServer/Plugins')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 347299a50..07345d51e 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1667,7 +1667,7 @@ a_Player:OpenWindow(Window);
 ]],
 			Functions =
 			{
-				Call = { Params = "Function name, [All the parameters divided with commas]", Notes = "This function allows you to call a function from another plugin. It can only use pass: integers, booleans, strings and usertypes (cPlayer, cEntity, cCuboid, etc.)." },
+				Call = { Params = "Function name, [All the parameters divided with commas]", Notes = "(<b>OBSOLETE</b>) This function allows you to call a function from another plugin. It can only use pass: integers, booleans, strings and usertypes (cPlayer, cEntity, cCuboid, etc.).<br /><br /><b>This function is obsolete and unsafe, use {{cPluginManager}}:CallPlugin() instead!</b>" },
 				GetDirectory = { Return = "string", Notes = "Returns the name of the folder where the plugin's files are. (APIDump)" },
 				GetLocalDirectory = { Notes = "OBSOLETE use GetLocalFolder instead." },
 				GetLocalFolder = { Return = "string", Notes = "Returns the path where the plugin's files are. (Plugins/APIDump)" },
@@ -1719,6 +1719,7 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
 					{ Params = "Command, Callback, HelpString", Return = "", Notes = "(STATIC) Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command." },
 					{ Params = "Command, Callback, HelpString", Return = "", Notes = "Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command." },
 				},
+				CallPlugin = { Params = "PluginName, FunctionName, [FunctionArgs...]", Return = "[FunctionRets]", Notes = "(STATIC) Calls the specified function in the specified plugin, passing all the given arguments to it. If it succeeds, it returns all the values returned by that function. If it fails, returns no value at all. Note that only strings, numbers, bools, nils and classes can be used for parameters and return values; tables and functions cannot be copied across plugins." },
 				DisablePlugin = { Params = "PluginName", Return = "bool", Notes = "Disables a plugin specified by its name. Returns true if the plugin was disabled, false if it wasn't found or wasn't active." },
 				ExecuteCommand = { Params = "{{cPlayer|Player}}, CommandStr", Return = "bool", Notes = "Executes the command as if given by the specified Player. Checks permissions. Returns true if executed." },
 				FindPlugins = { Params = "", Return = "", Notes = "Refreshes the list of plugins to include all folders inside the Plugins folder (potentially new disabled plugins)" },
diff --git a/MCServer/Plugins/Debuggers/Debuggers.lua b/MCServer/Plugins/Debuggers/Debuggers.lua
index 2d2d2736d..624261cbf 100644
--- a/MCServer/Plugins/Debuggers/Debuggers.lua
+++ b/MCServer/Plugins/Debuggers/Debuggers.lua
@@ -64,7 +64,8 @@ function Initialize(Plugin)
 	-- TestBlockAreas();
 	-- TestSQLiteBindings();
 	-- TestExpatBindings();
-
+	TestPluginCalls();
+	
 	return true
 end;
 
@@ -72,6 +73,38 @@ end;
 
 
 
+function TestPluginCalls()
+	-- In order to test the inter-plugin communication, we're going to call Core's ReturnColorFromChar() function
+	-- It is a rather simple function that doesn't need any tables as its params and returns a value, too
+	-- Note the signature: function ReturnColorFromChar( Split, char ) ... return cChatColog.Gray ... end
+	-- The Split parameter should be a table, but it is not used in that function anyway,
+	-- so we can get away with passing nil to it.
+	
+	-- Use the old, deprecated and unsafe method:
+	local Core = cPluginManager:Get():GetPlugin("Core")
+	if (Core ~= nil) then
+		LOGINFO("Calling Core::ReturnColorFromChar() the old-fashioned way...")
+		local Gray = Core:Call("ReturnColorFromChar", nil, "8")
+		if (Gray ~= cChatColor.Gray) then
+			LOGWARNING("Call failed, exp " .. cChatColor.Gray .. ", got " .. (Gray or "<nil>"))
+		else
+			LOGINFO("Call succeeded")
+		end
+	end
+	
+	-- Use the new method:
+	LOGINFO("Calling Core::ReturnColorFromChar() the recommended way...")
+	local Gray = cPluginManager:CallPlugin("Core", "ReturnColorFromChar", nil, "8")
+	if (Gray ~= cChatColor.Gray) then
+		LOGWARNING("Call failed, exp " .. cChatColor.Gray .. ", got " .. (Gray or "<nil>"))
+	else
+		LOGINFO("Call succeeded")
+	end
+end
+
+
+
+
 
 function TestBlockAreas()
 	LOG("Testing block areas...");
-- 
cgit v1.2.3