summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authorAlexander Harkness <bearbin@gmail.com>2014-01-16 18:55:37 +0100
committerAlexander Harkness <bearbin@gmail.com>2014-01-16 18:55:37 +0100
commitbf0d58428dfa87b6b093b24e977e4163877fed00 (patch)
tree348e126aa37fc1014cf66b7878b413a91e9792b7 /MCServer/Plugins/APIDump
parentCMake: Fixed output paths for all MSVC versions. (diff)
parentDocumented the SchedualeTask function (diff)
downloadcuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar.gz
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar.bz2
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar.lz
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar.xz
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.tar.zst
cuberite-bf0d58428dfa87b6b093b24e977e4163877fed00.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 8776e928c..a5b6d8210 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2087,6 +2087,7 @@ end
QueueSetBlock = { Params = "BlockX, BlockY, BlockZ, BlockType, BlockMeta, TickDelay", Return = "", Notes = "Queues the block to be set to the specified blocktype and meta after the specified amount of game ticks. Uses SetBlock() for the actual setting, so simulators are woken up and block entities are handled correctly." },
QueueTask = { Params = "TaskFunction", Return = "", Notes = "Queues the specified function to be executed in the tick thread. This is the primary means of interaction with a cWorld from the WebAdmin page handlers (see {{WebWorldThreads}}). The function signature is <pre class=\"pretty-print lang-lua\">function()</pre>All return values from the function are ignored. Note that this function is actually called *after* the QueueTask() function returns." },
RegenerateChunk = { Params = "ChunkX, ChunkZ", Return = "", Notes = "Queues the specified chunk to be re-generated, overwriting the current data. To queue a chunk for generating only if it doesn't exist, use the GenerateChunk() instead." },
+ ScheduleTask = { Params = "TaskFunction, Ticks", Return = "", Notes = "Queues the specified function to be executed in the tick thread after a number of ticks. This enables operations to be queued for execution in the future. The function signature is <pre class=\"pretty-print lang-lua\">function()</pre>All return values from the function are ignored." },
SendBlockTo = { Params = "BlockX, BlockY, BlockZ, {{cPlayer|Player}}", Return = "", Notes = "Sends the block at the specified coords to the specified player's client, as an UpdateBlock packet." },
SetBlock = { Params = "BlockX, BlockY, BlockZ, BlockType, BlockMeta", Return = "", Notes = "Sets the block at the specified coords, replaces the block entities for the previous block type, creates a new block entity for the new block, if appropriate, and wakes up the simulators. This is the preferred way to set blocks, as opposed to FastSetBlock(), which is only to be used under special circumstances." },
SetBlockMeta =