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.
---
 .../Plugins/APIDump/Hooks/OnPlayerAnimation.lua    | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua

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

diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua
new file mode 100644
index 000000000..baf99834e
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua
@@ -0,0 +1,28 @@
+return
+{
+	HOOK_PLAYER_ANIMATION =
+	{
+		CalledWhen = "A client has sent an Animation packet (0x12)",
+		DefaultFnName = "OnPlayerAnimation",  -- also used as pagename
+		Desc = [[
+			This hook is called when the server receives an Animation packet (0x12) from the client.</p>
+			<p>
+			For the list of animations that are sent by the client, see the
+			<a href="http://wiki.vg/Protocol#0x12">Protocol wiki</a>.
+		]],
+		Params =
+		{
+			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player from whom the packet was received" },
+			{ Name = "Animation", Type = "number", Notes = "The kind of animation" },
+		},
+		Returns = [[
+			If the function returns false or no value, the next plugin's callback is called. Afterwards, the
+			server broadcasts the animation packet to all nearby clients. If the function returns true, no other
+			callback is called for this event and the packet is not broadcasted.
+		]],
+	},  -- HOOK_PLAYER_ANIMATION
+}
+
+
+
+
-- 
cgit v1.2.3