From b079676290cdd6be5b6e3fd84f46b8d25f959b9e Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Tue, 15 Oct 2013 17:35:34 +0200
Subject: APIDump: Documented HOOK_POST_CRAFTING.

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

(limited to 'MCServer/Plugins/APIDump')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index b4b2e11a3..9430f370d 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2864,6 +2864,35 @@ end;
 			]],
 		},  -- HOOK_PLAYER_PLACING_BLOCK
 
+		HOOK_POST_CRAFTING =
+		{
+			CalledWhen = "After the built-in recipes are checked and a recipe was found.",
+			DefaultFnName = "OnPostCrafting",  -- also used as pagename
+			Desc = [[
+				This hook is called when a {{cPlayer|player}} changes contents of their
+				{{cCraftingGrid|crafting grid}}, after the recipe has been established by MCServer. Plugins may use
+				this to modify the resulting recipe or provide an alternate recipe.</p>
+				<p>
+				If a plugin implements custom recipes, it should do so using the {{OnPreCrafting|HOOK_PRE_CRAFTING}}
+				hook, because that will save the server from going through the built-in recipes. The
+				HOOK_POST_CRAFTING hook is intended as a notification, with a chance to tweak the result.</p>
+				<p>
+				Note that this hook is not called if a built-in recipe is not found;
+				{{OnCraftingNoRecipe|HOOK_CRAFTING_NO_RECIPE}} is called instead in such a case.
+			]],
+			Params =
+			{
+				{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has changed their crafting grid contents" },
+				{ Name = "Grid", Type = "{{cCraftingGrid}}", Notes = "The new crafting grid contents" },
+				{ Name = "Recipe", Type = "{{cCraftingRecipe}}", Notes = "The recipe that MCServer has decided to use (can be tweaked by plugins)" },
+			},
+			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. In either case, MCServer uses the value
+				of Recipe as the recipe to be presented to the player.
+			]],
+		},  -- HOOK_POST_CRAFTING
+
 	},  -- Hooks[]
 	
 
-- 
cgit v1.2.3