From dac97826f7d0c9b9135c1a08c4d5f16b61494bd1 Mon Sep 17 00:00:00 2001
From: Mattes D <github@xoft.cz>
Date: Wed, 26 Aug 2015 10:58:51 +0200
Subject: Renamed output directory to Server

---
 .../Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua  | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Server/Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua

(limited to 'Server/Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua')

diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua b/Server/Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua
new file mode 100644
index 000000000..e718c5d97
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnPlayerBrokenBlock.lua
@@ -0,0 +1,36 @@
+return
+{
+	HOOK_PLAYER_BROKEN_BLOCK =
+	{
+		CalledWhen = "After a player has broken a block. Notification only.",
+		DefaultFnName = "OnPlayerBrokenBlock",  -- also used as pagename
+		Desc = [[
+			This function is called after a {{cPlayer|player}} breaks a block. The block is already removed
+			from the {{cWorld|world}} and {{cPickup|pickups}} have been spawned. To get the world in which the
+			block has been dug, use the {{cPlayer}}:GetWorld() function.</p>
+			<p>
+			See also the {{OnPlayerBreakingBlock|HOOK_PLAYER_BREAKING_BLOCK}} hook for a similar hook called
+			before the block is broken. To intercept the creation of pickups, see the
+			{{OnBlockToPickups|HOOK_BLOCK_TO_PICKUPS}} hook.
+		]],
+		Params =
+		{
+			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who broke the block" },
+			{ Name = "BlockX", Type = "number", Notes = "X-coord of the block" },
+			{ Name = "BlockY", Type = "number", Notes = "Y-coord of the block" },
+			{ Name = "BlockZ", Type = "number", Notes = "Z-coord of the block" },
+			{ Name = "BlockFace", Type = "number", Notes = "Face of the block upon which the player interacted. One of the BLOCK_FACE_ constants" },
+			{ Name = "BlockType", Type = "BLOCKTYPE", Notes = "The block type of the block" },
+			{ Name = "BlockMeta", Type = "NIBBLETYPE", Notes = "The block meta of the block" },
+		},
+		Returns = [[
+			If the function returns false or no value, the next plugin's callback is called. If the function
+			returns true, no other callback is called for this event.
+		]],
+	},  -- HOOK_PLAYER_BROKEN_BLOCK
+}
+
+
+
+
+
-- 
cgit v1.2.3