ryansnewell
/
mcserver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed line left in.

master
Alexander Harkness 2014-09-27 15:40:33 +01:00
parent 3ff7103440
commit 9dccbe7792
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
View File

@ -1,5 +1,3 @@
(cClientHandle & a_ClientHandle, AString & a_ServerDescription, int & a_OnlinePlayersCount, int & a_MaxPlayersCount, AString & a_Favicon);
return
{
HOOK_SERVER_PING =
@ -8,7 +6,8 @@ return
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.
clients in the server server list. It can change the logged in players and player capacity, as well
as the server description and the favicon by editing the values passed in.
]],
Params = {
{ Name = "ClientHandle", Type = "{{cClientHandle}}", Notes = "The client handle that pinged the server" },
@ -18,7 +17,7 @@ return
{ 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.
The plugin may return a boolean.
]],
}, -- HOOK_SERVER_PING
}