From d34fa4970ac56c3624654f148faafce096243fe7 Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Mon, 14 Oct 2013 22:01:10 +0200
Subject: APIDump: Documented HOOK_PLAYER_ANIMATION.

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

(limited to 'MCServer/Plugins/APIDump')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 3c9ee9421..e7ed25cdc 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2611,6 +2611,27 @@ end;
 			]],
 		},  -- HOOK_LOGIN
 
+		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
 	},  -- Hooks[]
 	
 
-- 
cgit v1.2.3