From d9dc241e6fe669585d7c0b13d55818a22e1c76bc Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Sat, 23 Nov 2013 21:26:24 +0100
Subject: APIDump: The descriptions are read from multiple files.

All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
---
 MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua | 38 ++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua')

diff --git a/MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua b/MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua
new file mode 100644
index 000000000..937e6b981
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnUpdatedSign.lua
@@ -0,0 +1,38 @@
+return
+{
+	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
+}
+
+
+
+
+
-- 
cgit v1.2.3