summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authorAlexander Harkness <me@bearbin.net>2015-05-06 19:39:03 +0200
committerAlexander Harkness <me@bearbin.net>2015-05-06 19:39:03 +0200
commit68614e7224a4c7c9db86f981b76765fa9fc6871c (patch)
tree50cdad96880a503c2d4bd22483f3545431a450ad /MCServer/Plugins/APIDump
parentMerge pull request #1946 from SafwatHalaby/lean (diff)
downloadcuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar.gz
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar.bz2
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar.lz
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar.xz
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.tar.zst
cuberite-68614e7224a4c7c9db86f981b76765fa9fc6871c.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua7
1 files changed, 3 insertions, 4 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 7c0a8e818..ad86837e3 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -8,8 +8,7 @@
g_APIDesc =
{
Classes =
- {
- --[[
+F --[[
-- What the APIDump plugin understands / how to document stuff:
ExampleClassName =
{
@@ -2046,8 +2045,8 @@ a_Player:OpenWindow(Window);
BroadcastChatLeave = { Params = "MessageText", Return = "", Notes = "Broadcasts the specified message to all players, with its message type set to mtLeave. Use for players leaving the server." },
BroadcastChatSuccess = { Params = "MessageText", Return = "", Notes = "Broadcasts the specified message to all players, with its message type set to mtSuccess. Use for success messages." },
BroadcastChatWarning = { Params = "MessageText", Return = "", Notes = "Broadcasts the specified message to all players, with its message type set to mtWarning. Use for concerning events, such as plugin reload etc." },
- CreateAndInitializeWorld = { Params = "WorldName", Return = "{{cWorld|cWorld}}", Notes = "Creates a new world and initializes it. If there is a world whith the same name it returns nil.<br/><br/><b>NOTE</b>This function is currently unsafe, do not use!" },
- FindAndDoWithPlayer = { Params = "PlayerName, CallbackFunction", Return = "", Notes = "Calls the given callback function for all players with names partially (or fully) matching the name string provided." },
+ CreateAndInitializeWorld = { Params = "WorldName", Return = "{{cWorld|cWorld}}", Notes = "Creates a new world and initializes it. If there is a world whith the same name it returns nil.<br><br><b>NOTE</b>This function is currently unsafe, do not use!" },
+ FindAndDoWithPlayer = { Params = "PlayerName, CallbackFunction", Return = "", Notes = "Calls the given callback function for all players with names partially (or fully) matching the name string provided.<br>This function is not case-sensitive." },
DoWithPlayerByUUID = { Params = "PlayerUUID, CallbackFunction", Return = "bool", Notes = "If there is the player with the uuid, calls the CallbackFunction with the {{cPlayer}} parameter representing the player. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|Player}})</pre> The function returns false if the player was not found, or whatever bool value the callback returned if the player was found." },
ForEachPlayer = { Params = "CallbackFunction", Return = "", Notes = "Calls the given callback function for each player. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|cPlayer}})</pre>" },
ForEachWorld = { Params = "CallbackFunction", Return = "", Notes = "Calls the given callback function for each world. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cWorld|cWorld}})</pre>" },