From ed935d82bb390413f9465372ad4a0de781ad5c6c Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Thu, 17 Oct 2013 16:18:16 +0200
Subject: APIDump: Documented HOOK_UPDATED_SIGN.

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

(limited to 'MCServer/Plugins/APIDump/APIDesc.lua')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index b4816c85d..4500e6984 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -3097,6 +3097,36 @@ end;
 			]],
 		},  -- HOOK_TICK
 
+		HOOK_UPDATED_SIGN =
+		{
+			CalledWhen = "After the sign text is updated. Notification only.",
+			DefaultFnName = "OnUpdatedSign",  -- also used as pagename
+			Desc = [[
+				This hook is called after a sign has had its text updated. The text is already updated at this
+				point.</p>
+				<p>The update may have been caused either by a {{cPlayer|player}} directly updating the sign, or by
+				a plugin changing the sign text using the API.</p>
+				<p>
+				See also the {{OnUpdatingSign|HOOK_UPDATING_SIGN}} hook for a similar hook called before the update,
+				with a chance to modify the text.
+			]],
+			Params =
+			{
+				{ Name = "World", Type = "{{cWorld}}", Notes = "The world in which the sign resides" },
+				{ Name = "BlockX", Type = "number", Notes = "X-coord of the sign" },
+				{ Name = "BlockY", Type = "number", Notes = "Y-coord of the sign" },
+				{ Name = "BlockZ", Type = "number", Notes = "Z-coord of the sign" },
+				{ Name = "Line1", Type = "string", Notes = "1st line of the new text" },
+				{ Name = "Line2", Type = "string", Notes = "2nd line of the new text" },
+				{ Name = "Line3", Type = "string", Notes = "3rd line of the new text" },
+				{ Name = "Line4", Type = "string", Notes = "4th line of the new text" },
+				{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who is changing the text. May be nil for non-player updates." }
+			},
+			Returns = [[
+				If the function returns false or no value, other plugins' callbacks are called. If the function
+				returns true, no other callbacks are called. There is no overridable behavior.
+			]],
+		},  -- HOOK_UPDATED_SIGN
 		HOOK_UPDATING_SIGN =
 		{
 			CalledWhen = "Before the sign text is updated. Plugin may modify the text / refuse.",
-- 
cgit v1.2.3