A plugin may implement an OnServerPing() function and register it as a Hook to process pings from 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, that are displayed to the client in the server list.

The client handle already has its protocol version assigned to it, so the plugin can check that; however, there's no username associated with the client yet, and no player object.

Callback function

The default name for the callback function is OnServerPing. It has the following signature:

function OnServerPing(ClientHandle, ServerDescription, OnlinePlayersCount, MaxPlayersCount, Favicon)

Parameters:

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.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_SERVER_PING, MyOnServerPing);

Change information returned to the player

Tells the client that the server description is 'test', there are one more players online than there actually are, and that the player cap is zero. It also changes the favicon data.

function OnServerPing(ClientHandle, ServerDescription, OnlinePlayers, MaxPlayers, Favicon)
	-- Change Server Description
	ServerDescription = "Test"

	-- Change online / max players
	OnlinePlayers = OnlinePlayers + 1
	MaxPlayers = 0

	-- Change favicon
	if cFile:IsFile("my-favicon.png") then
		local FaviconData = cFile:ReadWholeFile("my-favicon.png")
		if (FaviconData ~= "") and (FaviconData ~= nil) then
			Favicon = Base64Encode(FaviconData)
		end
	end

	return false, ServerDescription, OnlinePlayers, MaxPlayers, Favicon
end