summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authorandrew <xdotftw@gmail.com>2014-02-23 12:25:02 +0100
committerandrew <xdotftw@gmail.com>2014-02-23 12:25:02 +0100
commit30b22e9f59e0873be84e80c83d274dbe5353b835 (patch)
tree7d4a1de7ac03ccb112340ca80905ae77cfbea77b /MCServer/Plugins/APIDump/APIDesc.lua
parentDocumented and exported cMapManager (diff)
downloadcuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar.gz
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar.bz2
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar.lz
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar.xz
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.tar.zst
cuberite-30b22e9f59e0873be84e80c83d274dbe5353b835.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua2
1 files changed, 1 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 8265b4e19..c8811df66 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1541,7 +1541,7 @@ a_Player:OpenWindow(Window);
]],
Functions =
{
- DoWithMap = { Params = "ID, Callback", Return = "bool", Notes = "Calls the callback for the map with the specified ID. Returns true if the map was found and the callback called, false if map not found." },
+ DoWithMap = { Params = "ID, CallbackFunction, [CallbackData]", Return = "bool", Notes = "If a map with the specified ID exists, calls the CallbackFunction for that map. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cMap|Map}}, [CallbackData])</pre> Returns true if the map was found and the callback called, false if map not found." },
GetNumMaps = { Params = "", Return = "number", Notes = "Returns the number of registered maps." },
},