1 files changed, 32 insertions, 0 deletions

diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerShooting.lua b/Server/Plugins/APIDump/Hooks/OnPlayerShooting.lua
new file mode 100644
index 000000000..7315ede7a
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnPlayerShooting.lua
@@ -0,0 +1,32 @@
+return
+{
+	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
+			Cuberite creates the projectile. If the functino returns true, no other callback is called and no
+			projectile is created.
+		]],
+	},  -- HOOK_PLAYER_SHOOTING
+}
+
+
+
+
+