summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-17 16:07:18 +0200
committermadmaxoft <github@xoft.cz>2013-10-17 16:07:18 +0200
commitd3f5a979b4f1f058763c6c3bc75d8c709e916ee4 (patch)
treedf171bafa8bc2818ab635df0aaf2ff984fd3413a /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Documented HOOK_TAKE_DAMAGE. (diff)
downloadcuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar.gz
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar.bz2
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar.lz
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar.xz
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.tar.zst
cuberite-d3f5a979b4f1f058763c6c3bc75d8c709e916ee4.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua22
1 files changed, 22 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 7698552e0..b4816c85d 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -3075,6 +3075,28 @@ end;
]],
}, -- HOOK_TAKE_DAMAGE
+ 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
+
HOOK_UPDATING_SIGN =
{
CalledWhen = "Before the sign text is updated. Plugin may modify the text / refuse.",