summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks
diff options
context:
space:
mode:
authorAlexander Harkness <me@bearbin.net>2014-09-27 22:35:08 +0200
committerAlexander Harkness <me@bearbin.net>2014-09-27 22:35:08 +0200
commit24275e058b9e98d43c21d6754b29defc1cba28f6 (patch)
treefe7cc2192a28892bcbeeed555536f9f5f2903e9c /MCServer/Plugins/APIDump/Hooks
parentCopy edit. (diff)
downloadcuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar.gz
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar.bz2
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar.lz
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar.xz
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.tar.zst
cuberite-24275e058b9e98d43c21d6754b29defc1cba28f6.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnServerPing.lua5
1 files changed, 2 insertions, 3 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
index 2a6aaee27..6dcaf3f17 100644
--- a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
+++ b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
@@ -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
}