summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnTick.lua
diff options
context:
space:
mode:
authorTiger Wang <ziwei.tiger@hotmail.co.uk>2013-11-24 15:55:08 +0100
committerTiger Wang <ziwei.tiger@hotmail.co.uk>2013-11-24 15:55:08 +0100
commitf95064a85c83e1a77a5de2f8a09e5907573f8277 (patch)
tree9896aa6cff228acbc0b188b6c37e2032152fe661 /MCServer/Plugins/APIDump/Hooks/OnTick.lua
parentFixed some comments and added debug logging (diff)
parentRCONClient: Initial implementation. (diff)
downloadcuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar.gz
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar.bz2
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar.lz
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar.xz
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.tar.zst
cuberite-f95064a85c83e1a77a5de2f8a09e5907573f8277.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnTick.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnTick.lua29
1 files changed, 29 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnTick.lua b/MCServer/Plugins/APIDump/Hooks/OnTick.lua
new file mode 100644
index 000000000..d8c329253
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnTick.lua
@@ -0,0 +1,29 @@
+return
+{
+ HOOK_TICK =
+ {
+ CalledWhen = "Every server tick (approximately 20 times per second)",
+ DefaultFnName = "OnTick", -- also used as pagename
+ Desc = [[
+ This hook is called every game tick (50 msec, or 20 times a second). If the server is overloaded,
+ the interval is larger, which is indicated by the TimeDelta parameter.</p>
+ <p>
+ This hook is called in the context of the server-tick thread, that is, the thread that takes care of
+ {{cClientHandle|client connections}} before they're assigned to {{cPlayer|player entities}}, and
+ processing console commands.
+ ]],
+ Params =
+ {
+ { Name = "TimeDelta", Type = "number", Notes = "The number of milliseconds elapsed since the last server tick. Will not be less than 50 msec." },
+ },
+ Returns = [[
+ If the function returns false or no value, other plugins' callbacks are called. If the function
+ returns true, no other callbacks are called. There is no overridable behavior.
+ ]],
+ }, -- HOOK_TICK
+}
+
+
+
+
+