From d9dc241e6fe669585d7c0b13d55818a22e1c76bc Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Sat, 23 Nov 2013 21:26:24 +0100
Subject: APIDump: The descriptions are read from multiple files.

All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
---
 MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua | 27 +++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua')

diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua
new file mode 100644
index 000000000..2756529ef
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerMoving.lua
@@ -0,0 +1,27 @@
+return
+{
+	HOOK_PLAYER_MOVING =
+	{
+		CalledWhen = "Player tried to move in the tick being currently processed. Plugin may refuse movement.",
+		DefaultFnName = "OnPlayerMoving",  -- also used as pagename
+		Desc = [[
+			This function is called in each server tick for each {{cPlayer|player}} that has sent any of the
+			player-move packets. Plugins may refuse the movement.
+		]],
+		Params =
+		{
+			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has moved. The object already has the new position stored in it." },
+		},
+		Returns = [[
+			If the function returns true, movement is prohibited. FIXME: The player's client is not informed.</p>
+			<p>
+			If the function returns false or no value, other plugins' callbacks are called and finally the new
+			position is permanently stored in the cPlayer object.</p>
+		]],
+	},  -- HOOK_PLAYER_MOVING
+}
+
+
+
+
+
-- 
cgit v1.2.3