flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Documented the plugin messaging hook and function.

Browse Source
This commit is contained in:
madmaxoft 2014-01-13 19:18:00 +01:00
parent 252def339d
commit 55e92f056d
2 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -449,6 +449,7 @@ end
GetUsername = { Params = "", Return = "string", Notes = "Returns the username that the client has provided" }, GetUsername = { Params = "", Return = "string", Notes = "Returns the username that the client has provided" },
GetViewDistance = { Params = "", Return = "number", Notes = "Returns the viewdistance (number of chunks loaded for the player in each direction)" }, GetViewDistance = { Params = "", Return = "number", Notes = "Returns the viewdistance (number of chunks loaded for the player in each direction)" },
Kick = { Params = "Reason", Return = "", Notes = "Kicks the user with the specified reason" }, Kick = { Params = "Reason", Return = "", Notes = "Kicks the user with the specified reason" },
SendPluginMessage = { Params = "Channel, Message", Return = "", Notes = "Sends the plugin message on the specified channel." },
SetUsername = { Params = "Name", Return = "", Notes = "Sets the username" }, SetUsername = { Params = "Name", Return = "", Notes = "Sets the username" },
SetViewDistance = { Params = "ViewDistance", Return = "", Notes = "Sets the viewdistance (number of chunks loaded for the player in each direction)" }, SetViewDistance = { Params = "ViewDistance", Return = "", Notes = "Sets the viewdistance (number of chunks loaded for the player in each direction)" },
SendBlockChange = { Params = "BlockX, BlockY, BlockZ, BlockType, BlockMeta", Return = "", Notes = "Sends a BlockChange packet to the client. This can be used to create fake blocks only for that player." }, SendBlockChange = { Params = "BlockX, BlockY, BlockZ, BlockType, BlockMeta", Return = "", Notes = "Sends a BlockChange packet to the client. This can be used to create fake blocks only for that player." },

25
MCServer/Plugins/APIDump/Hooks/OnPluginMessage.lua Normal file
View File

@ -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
}