flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Added details about client handle in OnServerPing hook.

Browse Source
This commit is contained in:
Mattes D 2014-12-25 00:36:01 +01:00
parent 081e7ddd02
commit f59740b262
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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.</p>
<p>
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" },