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

changed description to be more readable.

Browse Source
This commit is contained in:
Alexander Harkness 2014-09-27 21:35:08 +01:00
parent e5873d4e89
commit 24275e058b
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,9 +17,8 @@ return
{ Name = "Favicon", Type = "string", Notes = "The base64 encoded favicon to be displayed in the server list for compatible clients" },
},
Returns = [[
The plugin returns <code>res, ServerDescription, OnlinePlayersCount, MaxPlayersCount, Favicon</code>.
res is a boolean which stops other plugins being notified of the ping if it's set to true, and the others
are the same as the arguments, and if emitted change the values transmitted to the client.
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.
]],
}, -- HOOK_SERVER_PING
}