1.6EoS

2 files changed, 52 insertions, 1 deletions

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index e6ee4ca10..f903308d1 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1984,6 +1984,7 @@ cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
 				HOOK_PLAYER_USING_ITEM = { Notes = "Called when the player is about to right-click with a usable item in their hand." },
 				HOOK_POST_CRAFTING = { Notes = "Called after a valid recipe has been chosen for the current contents of the crafting grid. Plugins may modify the recipe." },
 				HOOK_PRE_CRAFTING = { Notes = "Called before a recipe is searched for the current contents of the crafting grid. Plugins may provide a recipe and cancel the built-in search." },
+				HOOK_SERVER_PING = { Notes = "Called when a client pings the server from the server list. Plugins may change the favicon, server description, players online and maximum players values." },
 				HOOK_SPAWNED_ENTITY = { Notes = "Called after an entity is spawned in a {{cWorld|world}}. The entity is already part of the world." },
 				HOOK_SPAWNED_MONSTER = { Notes = "Called after a mob is spawned in a {{cWorld|world}}. The mob is already part of the world." },
 				HOOK_SPAWNING_ENTITY = { Notes = "Called just before an entity is spawned in a {{cWorld|world}}." },
@@ -2814,7 +2815,7 @@ end
 		Globals =
 		{
 			Desc = [[
-				These functions are available directly, without a class instance. Any plugin cal call them at any
+				These functions are available directly, without a class instance. Any plugin can call them at any
 				time.
 			]],
 			Functions =
diff --git a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
new file mode 100644
index 000000000..6d2325fe6
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
@@ -0,0 +1,50 @@
+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. 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.
+		]],
+		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 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.
+		]],
+		CodeExamples = {
+			{
+				Title = "Change information returned to the player",
+				Desc = "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.",
+				Code = [[
+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 != "") then
+			Favicon = Base64Encode(FaviconData)
+		end
+	end
+
+	return false, ServerDescription, OnlinePlayers, MaxPlayers, Favicon
+end				
+				]],
+			},
+		},
+	},  -- HOOK_SERVER_PING
+}