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

Fixed return value descriptions.

Browse Source
This commit is contained in:
Alexander Harkness 2014-09-27 21:27:48 +01:00
parent 990a467eb4
commit 57e83f7d49
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,7 +17,9 @@ 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.
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.
]],
}, -- HOOK_SERVER_PING
}