summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua
diff options
context:
space:
mode:
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua25
1 files changed, 25 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua b/MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua
new file mode 100644
index 000000000..743d3bb5e
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua
@@ -0,0 +1,25 @@
+return
+{
+ HOOK_PLUGIN_MESSAGE =
+ {
+ CalledWhen = "The server receives a plugin message from a client",
+ DefaultFnName = "OnPluginMessage", -- also used as pagename
+ Desc = [[
+ A plugin may implement an OnPluginMessage() function and register it as a Hook to process plugin messages
+ from the players. The function is then called for every plugin message sent from any player.
+ ]],
+ Params = {
+ { Name = "Client", Type = "{{cClientHandle}}", Notes = "The client who sent the plugin message" },
+ { Name = "Channel", Type = "string", Notes = "The channel on which the message was sent" },
+ { Name = "Message", Type = "string", Notes = "The message's payload" },
+ },
+ 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.
+ ]],
+ }, -- HOOK_CHAT
+}
+
+
+
+