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

APIDump: Documented cPlugin

Browse Source
This commit is contained in:
STRWarrior 2013-10-04 20:58:25 +02:00
parent a1898521b0
commit fdc67142fd
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -1347,14 +1347,18 @@ a_Player:OpenWindow(Window);
cPlugin =
{
Desc = [[cPlugin describes a Lua plugin. This page is dedicated to new-style plugins and contain their functions.
Desc = [[cPlugin describes a Lua plugin. This page is dedicated to new-style plugins and contain their functions. Each plugin has its own Plugin object.
]],
Functions =
{
GetName = { Return = "string" },
SetName = { Return = "" },
GetVersion = { Notes = "int" },
SetVersion = { Return = "" },
Call = { Params = "Function name, [All the parameters divided with commas]", Notes = "This function allows you to call a function from another plugin. It can only use pass: integers, booleans, strings and usertypes (cPlayer, cEntity, cCuboid, etc.)." },
GetDirectory = { Return = "string", Notes = "Returns the name of the folder where the plugin's files are. (APIDump)" },
GetLocalDirectory = { Notes = "OBSOLETE use GetLocalFolder instead." },
GetLocalFolder = { Return = "string", Notes = "Returns the path where the plugin's files are. (Plugins/APIDump)" },
GetName = { Return = "string", Notes = "Returns the name of the plugin." },
SetName = { Params = "string", Notes = "Sets the name of the Plugin." },
GetVersion = { Return = "number", Notes = "Returns the version of the plugin." },
SetVersion = { Params = "number", Notes = "Sets the version of the plugin." },
GetFileName = { Return = "string" },
CreateWebPlugin = { Notes = "{{cWebPlugin|cWebPlugin}}" },
},