From f8e3cbe44fd132d8eee7f6b8134ebc40260ccc9e Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Wed, 16 Oct 2013 15:33:56 +0200
Subject: APIDump: Documented HOOK_WORLD_TICK.

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

(limited to 'MCServer/Plugins/APIDump')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 2bede6323..f67b2f08a 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -3051,6 +3051,30 @@ end;
 			]],
 		},  -- HOOK_SPAWNING_MONSTER
 
+
+
+		HOOK_WORLD_TICK =
+		{
+			CalledWhen = "Every world tick (about 20 times per second), separately for each world",
+			DefaultFnName = "OnWorldTick",  -- also used as pagename
+			Desc = [[
+				This hook is called for each {{cWorld|world}} every tick (50 msec, or 20 times a second). If the
+				world is overloaded, the interval is larger, which is indicated by the TimeDelta parameter.</p>
+				<p>
+				This hook is called in the world's tick thread context and thus has access to all world data
+				guaranteed without blocking.
+			]],
+			Params =
+			{
+				{ Name = "World", Type = "{{cWorld}}", Notes = "World that is ticking" },
+				{ Name = "TimeDelta", Type = "number", Notes = "The number of milliseconds since the previous game tick. Will not be less than 50 msec" },
+			},
+			Returns = [[
+				If the function returns false or no value, the next plugin's callback is called. If the function
+				returns true, no other callback is called for this event. There is no overridable behavior.
+			]],
+		},  -- HOOK_WORLD_TICK
+
 	},  -- Hooks[]
 	
 
-- 
cgit v1.2.3