diff options
author | Mattes D <github@xoft.cz> | 2015-08-12 08:25:29 +0200 |
---|---|---|
committer | Mattes D <github@xoft.cz> | 2015-08-12 08:25:29 +0200 |
commit | d118550a5bdf761cc90ff722ff8dd7391df7285f (patch) | |
tree | 482062f5cdc11520ff0d0496e419524be01f1299 /MCServer/Plugins/APIDump/Classes | |
parent | Merge pull request #2423 from cuberite/JsonCppCheck (diff) | |
parent | Updated APIDump to follow the namechange (diff) | |
download | cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar.gz cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar.bz2 cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar.lz cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar.xz cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.tar.zst cuberite-d118550a5bdf761cc90ff722ff8dd7391df7285f.zip |
Diffstat (limited to '')
-rw-r--r-- | MCServer/Plugins/APIDump/Classes/Geometry.lua | 4 | ||||
-rw-r--r-- | MCServer/Plugins/APIDump/Classes/Plugins.lua | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/MCServer/Plugins/APIDump/Classes/Geometry.lua b/MCServer/Plugins/APIDump/Classes/Geometry.lua index 9887bfb89..36bd222a6 100644 --- a/MCServer/Plugins/APIDump/Classes/Geometry.lua +++ b/MCServer/Plugins/APIDump/Classes/Geometry.lua @@ -123,10 +123,10 @@ various events. See below for further information. { Header = "Callbacks", Contents = [[ -The Callbacks in the Trace() function is a table that contains named functions. MCServer will call +The Callbacks in the Trace() function is a table that contains named functions. Cuberite will call individual functions from that table for the events that occur on the line - hitting a block, going out of valid world data etc. The following table lists all the available callbacks. If the callback function is -not defined, MCServer skips it. Each function can return a bool value, if it returns true, the tracing is +not defined, Cuberite skips it. Each function can return a bool value, if it returns true, the tracing is aborted and Trace() returns false.</p> <p> <table><tr><th>Name</th><th>Parameters</th><th>Notes</th></tr> 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" }, |