summaryrefslogtreecommitdiffstats
path: root/MCServer
diff options
context:
space:
mode:
authorSTRWarrior <niels.breuker@hotmail.nl>2014-07-04 14:29:19 +0200
committerSTRWarrior <niels.breuker@hotmail.nl>2014-07-04 14:29:19 +0200
commitaa81a3ff3e2d9c66e699e244cab0b624167a9127 (patch)
treea898ca3903d9c4bb3d5f44c2ac99521837ab0fe0 /MCServer
parentFixed doxycomments (diff)
downloadcuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar.gz
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar.bz2
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar.lz
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar.xz
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.tar.zst
cuberite-aa81a3ff3e2d9c66e699e244cab0b624167a9127.zip
Diffstat (limited to 'MCServer')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua2
1 files changed, 1 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index fe38d94c7..412fcc405 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1872,7 +1872,7 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
},
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 = "{{cPluginManager#CommandResult|CommandResult}}", Notes = "Executes the command as if given by the specified Player. Checks permissions. Returns true if executed." },
+ ExecuteCommand = { Params = "{{cPlayer|Player}}, CommandStr", Return = "{{cPluginManager#CommandResult|CommandResult}}", Notes = "Executes the command as if given by the specified Player. Checks permissions. Returns a {{cPluginManager#CommandResult|CommandResult}} value." },
FindPlugins = { Params = "", Return = "", Notes = "Refreshes the list of plugins to include all folders inside the Plugins folder (potentially new disabled plugins)" },
ForceExecuteCommand = { Params = "{{cPlayer|Player}}, CommandStr", Return = "{{cPluginManager#CommandResult|CommandResult}}", Notes = "Same as ExecuteCommand, but doesn't check permissions" },
ForEachCommand = { Params = "CallbackFn", Return = "bool", Notes = "Calls the CallbackFn function for each command that has been bound using BindCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function(Command, Permission, HelpString)</pre>. If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true." },