From fd7c1754d017e419850761b0cdd05198cf07ad3a Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Thu, 17 Oct 2013 17:14:57 +0200
Subject: APIDump: Documented HOOK_PLAYER_USED_BLOCK.

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

(limited to 'MCServer')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index dba487f09..1d1d0ead9 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2894,6 +2894,45 @@ end;
 			]],
 		},  -- HOOK_PLAYER_RIGHT_CLICK
 
+		HOOK_PLAYER_USED_BLOCK =
+		{
+			CalledWhen = "A player has just used a block (chest, furnace…). Notification only.",
+			DefaultFnName = "OnPlayerUsedBlock",  -- also used as pagename
+			Desc = [[
+				This hook is called after a {{cPlayer|player}} has right-clicked a block that can be used, such as a
+				{{cChestEntity|chest}} or a lever. It is called after MCServer processes the usage (sends the UI
+				handling packets / toggles redstone). Note that for UI-related blocks, the player is most likely
+				still using the UI. This is a notification-only event.</p>
+				<p>
+				Note that the block coords given in this callback are for the (solid) block that is being clicked,
+				not the air block between it and the player.</p>
+				<p>
+				To get the world at which the right-click occurred, use the {{cPlayer}}:GetWorld() function.</p>
+				<p>
+				See also the {{OnPlayerUsingBlock|HOOK_PLAYER_USING_BLOCK}} for a similar hook called before the
+				use, the {{OnPlayerUsingItem|HOOK_PLAYER_USING_ITEM}} and {{OnPlayerUsedItem|HOOK_PLAYER_USED_ITEM}}
+				for similar hooks called when a player interacts with any block with a usable item in hand, such as
+				a bucket.
+			]],
+			Params =
+			{
+				{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who used the block" },
+				{ Name = "BlockX", Type = "number", Notes = "X-coord of the clicked block" },
+				{ Name = "BlockY", Type = "number", Notes = "Y-coord of the clicked block" },
+				{ Name = "BlockZ", Type = "number", Notes = "Z-coord of the clicked block" },
+				{ Name = "BlockFace", Type = "number", Notes = "Face of clicked block which has been clicked. One of the BLOCK_FACE_ constants" },
+				{ Name = "CursorX", Type = "number", Notes = "X-coord of the cursor crosshair on the block being clicked" },
+				{ Name = "CursorY", Type = "number", Notes = "Y-coord of the cursor crosshair on the block being clicked" },
+				{ Name = "CursorZ", Type = "number", Notes = "Z-coord of the cursor crosshair on the block being clicked" },
+				{ Name = "BlockType", Type = "number", Notes = "Block type of the clicked block" },
+				{ Name = "BlockMeta", Type = "number", Notes = "Block meta of the clicked block" },
+			},
+			Returns = [[
+				If the function returns false or no value, other plugins' callbacks are called. If the function
+				returns true, no other callbacks are called for this event.
+			]],
+		},  -- HOOK_PLAYER_USED_BLOCK
+
 		HOOK_PLAYER_USED_ITEM =
 		{
 			CalledWhen = "A player has used an item in hand (bucket...)",
-- 
cgit v1.2.3