2014-09-27 10:33:35 -04:00
|
|
|
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
|
2014-09-27 10:40:33 -04:00
|
|
|
clients in the server server list. It can change the logged in players and player capacity, as well
|
2014-09-27 16:28:59 -04:00
|
|
|
as the server description and the favicon, that are displayed to the client in the server list.
|
2014-09-27 10:33:35 -04:00
|
|
|
]],
|
|
|
|
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 = [[
|
2014-09-27 16:35:08 -04:00
|
|
|
The plugin can return whether to continue processing of the hook with other plugins, the server description to
|
|
|
|
be displayed to the client, the currently online players, the player cap and the base64/png favicon data, in that order.
|
2014-09-27 10:33:35 -04:00
|
|
|
]],
|
|
|
|
}, -- HOOK_SERVER_PING
|
|
|
|
}
|