From f59740b262bf5259225ab4d6cd2537bead2a12a5 Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Thu, 25 Dec 2014 00:36:01 +0100
Subject: APIDump: Added details about client handle in OnServerPing hook.
---
MCServer/Plugins/APIDump/Hooks/OnServerPing.lua | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
(limited to 'MCServer/Plugins')
diff --git a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
index 76b6d1517..430465786 100644
--- a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
+++ b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
@@ -7,7 +7,10 @@ return
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.
+ 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.
]],
Params = {
{ Name = "ClientHandle", Type = "{{cClientHandle}}", Notes = "The client handle that pinged the server" },
--
cgit v1.2.3