From 9dafba50157086ff952bff9cbba774334caf190a Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Wed, 9 Oct 2013 15:10:25 +0200
Subject: APIDump: Implemented basic hook documentation.

---
 MCServer/Plugins/APIDump/APIDesc.lua | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

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

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index c41cac51b..33e1da976 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2055,6 +2055,33 @@ World:ForEachEntity(
 		},
 	},
 	
+	
+	Hooks =
+	{
+		HOOK_CHAT =
+		{
+			CalledWhen = "Player sends a chat message",
+			DefaultFnName = "OnChat",  -- also used as pagename
+			Desc = [[
+				A plugin may implement an OnChat() function and register it as a Hook to process chat messages from
+				the players. The function is then called for every in-game message sent from any player. Note that
+				commands are handled separately using a command framework API.
+			]],
+			Params = {
+				{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who sent the message" },
+				{ Name = "Message", Type = "string", Notes = "The message" },
+			},
+			Returns = [[
+				The plugin may return 2 values. The first is a boolean specifying whether the hook handling is to be
+				stopped or not. If it is false, the message is broadcast to all players in the world. If it is true,
+				no message is broadcast and no further action is taken.</p>
+				<p>
+				The second value is specifies the message to broadcast. This way, plugins may modify the message. If
+				the second value is not provided, the original message is used.
+			]],
+		},  -- HOOK_CHAT
+	},  -- Hooks[]
+	
 
 	IgnoreClasses =
 	{
@@ -2080,12 +2107,15 @@ World:ForEachEntity(
 		"%a+.delete",        -- AnyClass.delete
 		
 		-- Functions global in the APIDump plugin:
-		"Initialize",
-		"DumpAPITxt",
 		"CreateAPITables",
 		"DumpAPIHtml",
+		"DumpAPITxt",
+		"Initialize",
+		"LinkifyString",
 		"ReadDescriptions",
+		"ReadHooks",
 		"WriteHtmlClass",
+		"WriteHtmlHook",
 	},
 	
 	ExtraPages =
-- 
cgit v1.2.3