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

Hopefully fix #1384

Browse Source 
Can @madmaxoft comment?
This commit is contained in:
Alexander Harkness 2014-09-27 15:33:35 +01:00
parent 4df56fde88
commit 400a4d1083
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
MCServer/Plugins/APIDump/Hooks/OnServerPing.lua Normal file
View File

@ -0,0 +1,24 @@
(cClientHandle & a_ClientHandle, AString & a_ServerDescription, int & a_OnlinePlayersCount, int & a_MaxPlayersCount, AString & a_Favicon);
return
{
HOOK_SERVER_PING =
{
CalledWhen = "Client pings the server from the server list.",
DefaultFnName = "OnServerPing", -- also used as pagename
Desc = [[
A plugin may implement an OnServerPing() function and register it as a Hook to process pings from
clients in the server server list.
]],
Params = {
{ Name = "ClientHandle", Type = "{{cClientHandle}}", Notes = "The client handle that pinged the server" },
{ Name = "ServerDescription", Type = "string", Notes = "The server description" },
{ Name = "OnlinePlayersCount", Type = "number", Notes = "The number of players currently on the server" },
{ Name = "MaxPlayersCount", Type = "number", Notes = "The current player cap for the server" },
{ Name = "Favicon", Type = "string", Notes = "The base64 encoded favicon to be displayed in the server list for compatible clients" },
},
Returns = [[
The plugin may return a boolean of whether to respond to the client that pinged.
]],
}, -- HOOK_SERVER_PING
}