flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Fixed descriptions for cPluginManager:ForEachPlugin().

Browse Source
This commit is contained in:
Mattes D 2016-10-06 22:34:47 +02:00
parent 59c77ca3db
commit 71d46bbbd8
1 changed files with 30 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Server/Plugins/APIDump/Classes/Plugins.lua
View File

@ -107,7 +107,8 @@ return
Notes = "Sets the API version of the plugin. Currently unused.", Notes = "Sets the API version of the plugin. Currently unused.",
}, },
}, },
}, }, -- cPlugin
cPluginLua = cPluginLua =
{ {
Desc = "(<b>OBSOLETE</b>) This class is no longer useful in the API and will be removed as soon as all core plugins are migrated away from it. The {{cPlugin}} class serves as the main plugin instance's interface.", Desc = "(<b>OBSOLETE</b>) This class is no longer useful in the API and will be removed as soon as all core plugins are migrated away from it. The {{cPlugin}} class serves as the main plugin instance's interface.",
@ -130,7 +131,8 @@ return
}, },
}, },
Inherits = "cPlugin", Inherits = "cPlugin",
}, }, -- cPluginLua
cPluginManager = cPluginManager =
{ {
Desc = [[ Desc = [[
@ -438,6 +440,7 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
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.", 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 = ForEachPlugin =
{
{ {
IsStatic = true, IsStatic = true,
Params = Params =
@ -455,6 +458,23 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
}, },
Notes = "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.", Notes = "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.",
}, },
{
Params =
{
{
Name = "CallbackFn",
Type = "function",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "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 = Get =
{ {
IsStatic = true, IsStatic = true,