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/OnChat.lua | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnChat.lua

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

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