diff options
author | Julian Laubstein <julianlaubstein@yahoo.de> | 2015-08-11 22:48:55 +0200 |
---|---|---|
committer | Julian Laubstein <julianlaubstein@yahoo.de> | 2015-08-11 22:48:55 +0200 |
commit | 0958e167e89d2b3289c01905ebb8897e6bc86c43 (patch) | |
tree | 482062f5cdc11520ff0d0496e419524be01f1299 /MCServer/Plugins/APIDump/Classes/Plugins.lua | |
parent | Merge pull request #2423 from cuberite/JsonCppCheck (diff) | |
download | cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.gz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.bz2 cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.lz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.xz cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.tar.zst cuberite-0958e167e89d2b3289c01905ebb8897e6bc86c43.zip |
Diffstat (limited to 'MCServer/Plugins/APIDump/Classes/Plugins.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/Classes/Plugins.lua | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/Classes/Plugins.lua b/MCServer/Plugins/APIDump/Classes/Plugins.lua index 87f864950..d36658042 100644 --- a/MCServer/Plugins/APIDump/Classes/Plugins.lua +++ b/MCServer/Plugins/APIDump/Classes/Plugins.lua @@ -73,7 +73,7 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage); 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." }, ForEachConsoleCommand = { Params = "CallbackFn", Return = "bool", Notes = "Calls the CallbackFn function for each command that has been bound using BindConsoleCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function (Command, 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." }, - ForEachPlugin = { Params = "CallbackFn", Return = "bool", Notes = "(STATIC) Calls the CallbackFn function for each plugin that is currently discovered by MCServer (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</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." }, + ForEachPlugin = { Params = "CallbackFn", Return = "bool", Notes = "(STATIC) Calls the CallbackFn function for each plugin that is currently discovered by Cuberite (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</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." }, Get = { Params = "", Return = "cPluginManager", Notes = "(STATIC) Returns the single instance of the plugin manager" }, GetAllPlugins = { Params = "", Return = "table", Notes = "Returns a table (dictionary) of all plugins, [name => value], where value is a valid {{cPlugin}} if the plugin is loaded, or the bool value false if the plugin is not loaded." }, GetCommandPermission = { Params = "Command", Return = "Permission", Notes = "Returns the permission needed for executing the specified command" }, |