diff options
| author | Alexander Harkness <me@bearbin.net> | 2014-09-27 16:40:33 +0200 |
|---|---|---|
| committer | Alexander Harkness <me@bearbin.net> | 2014-09-27 16:40:33 +0200 |
| commit | 9dccbe7792cfdc6ffd56348aa9092004526b3794 (patch) | |
| tree | 82f6bf6de8391ef2955e44667fda083f0df7f5c4 /MCServer/Plugins/APIDump/Hooks/OnServerPing.lua | |
| parent | Remaining part of fix. (diff) | |
| download | cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar.gz cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar.bz2 cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar.lz cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar.xz cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.tar.zst cuberite-9dccbe7792cfdc6ffd56348aa9092004526b3794.zip | |
Diffstat (limited to '')
| -rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnServerPing.lua | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua index 8a710e047..7cfbd06ac 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua @@ -1,5 +1,3 @@ - (cClientHandle & a_ClientHandle, AString & a_ServerDescription, int & a_OnlinePlayersCount, int & a_MaxPlayersCount, AString & a_Favicon); - return { HOOK_SERVER_PING = @@ -8,7 +6,8 @@ return 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. + 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 by editing the values passed in. ]], Params = { { Name = "ClientHandle", Type = "{{cClientHandle}}", Notes = "The client handle that pinged the server" }, @@ -18,7 +17,7 @@ return { Name = "Favicon", Type = "string", Notes = "The base64 encoded favicon to be displayed in the server list for compatible clients" }, }, Returns = [[ - The plugin may return a boolean of whether to respond to the client that pinged. + The plugin may return a boolean. ]], }, -- HOOK_SERVER_PING } |