From 5a31d191eb9f12f20899db3ff1361891f29e4e10 Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Fri, 18 Oct 2013 09:57:35 +0200
Subject: APIDump: Documented HOOK_PLAYER_SHOOTING.

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

(limited to 'MCServer')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index d8aa77b19..4c22853f7 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2894,6 +2894,31 @@ end;
 			]],
 		},  -- HOOK_PLAYER_RIGHT_CLICK
 
+		HOOK_PLAYER_SHOOTING =
+		{
+			CalledWhen = "When the player releases the bow, shooting an arrow (other projectiles: unknown)",
+			DefaultFnName = "OnPlayerShooting",  -- also used as pagename
+			Desc = [[
+				This hook is called when the {{cPlayer|player}} shoots their bow. It is called for the actual
+				release of the {{cArrowEntity|arrow}}. FIXME: It is currently unknown whether other
+				{{cProjectileEntity|projectiles}} (snowballs, eggs) trigger this hook.</p>
+				<p>
+				To get the player's position and direction, use the {{cPlayer}}:GetEyePosition() and
+				cPlayer:GetLookVector() functions. Note that for shooting a bow, the position for the arrow creation
+				is not at the eye pos, some adjustments are required. FIXME: Export the {{cPlayer}} function for
+				this adjustment.
+			]],
+			Params =
+			{
+				{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player shooting" },
+			},
+			Returns = [[
+				If the function returns false or no value, the next plugin's callback is called, and finally
+				MCServer creates the projectile. If the functino returns true, no other callback is called and no
+				projectile is created.
+			]],
+		},  -- HOOK_PLAYER_SHOOTING
+
 		HOOK_PLAYER_SPAWNED =
 		{
 			CalledWhen = "After a player (re)spawns in the world to which they belong to.",
-- 
cgit v1.2.3