From d3f5a979b4f1f058763c6c3bc75d8c709e916ee4 Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Thu, 17 Oct 2013 16:07:18 +0200
Subject: APIDump: Documented HOOK_TICK.

---
 MCServer/Plugins/APIDump/APIDesc.lua | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

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.",
-- 
cgit v1.2.3