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

Merge pull request #3394 from cuberite/FixApiDesc

Browse Source 
Fix api desc
This commit is contained in:
Mattes D 2016-10-06 23:08:56 +02:00 committed by GitHub
commit 7775f54054
2 changed files with 32 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Server/Plugins/APIDump/APIDesc.lua
View File

@ -14048,10 +14048,12 @@ end
{
Name = "OnChunkAvailable",
Type = "function",
IsOptional = true,
},
{
Name = "OnAllChunksAvailable",
Type = "function",
IsOptional = true,
},
},
Notes = "Queues the specified chunks to be loaded or generated and calls the specified callbacks once they are loaded. ChunkCoordTable is an arra-table of chunk coords, each coord being a table of 2 numbers: { {Chunk1x, Chunk1z}, {Chunk2x, Chunk2z}, ...}. When any of those chunks are made available (including being available at the start of this call), the OnChunkAvailable() callback is called. When all the chunks are available, the OnAllChunksAvailable() callback is called. The function signatures are: <pre class=\"prettyprint lang-lua\">function OnChunkAvailable(ChunkX, ChunkZ)\

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

@ -107,7 +107,8 @@ return
Notes = "Sets the API version of the plugin. Currently unused.",
},
},
},
}, -- cPlugin
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.",
@ -130,7 +131,8 @@ return
},
},
Inherits = "cPlugin",
},
}, -- cPluginLua
cPluginManager =
{
Desc = [[
@ -439,21 +441,39 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
},
ForEachPlugin =
{
IsStatic = true,
Params =
{
IsStatic = true,
Params =
{
Name = "CallbackFn",
Type = "function",
{
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.",
},
Returns =
{
Params =
{
Type = "boolean",
{
Name = "CallbackFn",
Type = "function",
},
},
},
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.",
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 =
{