summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authorandrew <xdotftw@gmail.com>2014-03-01 13:03:16 +0100
committerandrew <xdotftw@gmail.com>2014-03-01 13:03:16 +0100
commita28e5eca1835e1be868c3bcd22d87e3cfae2f547 (patch)
tree278c6e7ac3743414539944fd2df6420e1ec651ed /MCServer/Plugins/APIDump
parentExported and documented cScoreboard (diff)
downloadcuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar.gz
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar.bz2
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar.lz
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar.xz
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.tar.zst
cuberite-a28e5eca1835e1be868c3bcd22d87e3cfae2f547.zip
Diffstat (limited to 'MCServer/Plugins/APIDump')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua1
1 files changed, 1 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index c2dd6ba99..5bc69eb24 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1865,6 +1865,7 @@ end
Functions =
{
AddPlayerScore = { Params = "Name, Type, Value", Return = "", Notes = "Adds a value to all player scores of the specified objective type." },
+ ForEachObjective = { Params = "CallBackFunction, [CallbackData]", Return = "bool", Notes = "Calls the specified callback for each objective in the scoreboard. Returns true if all objectives have been processed (including when there are zero objectives), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cObjective|Objective}}, [CallbackData])</pre> The callback should return false or no value to continue with the next objective, or true to abort the enumeration." },
GetNumObjectives = { Params = "", Return = "number", Notes = "Returns the nuber of registered objectives." },
GetNumTeams = { Params = "", Return = "number", Notes = "Returns the number of registered teams." },
GetObjective = { Params = "string", Return = "{{cObjective}}", Notes = "Returns the objective with the specified name." },