summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks
diff options
context:
space:
mode:
authorAlexander Harkness <me@bearbin.net>2014-09-27 22:27:48 +0200
committerAlexander Harkness <me@bearbin.net>2014-09-27 22:27:48 +0200
commit57e83f7d49485e254ab33ee348ce66c3981005a5 (patch)
tree519e083e9b0e0490c11825595c43a1b625b19480 /MCServer/Plugins/APIDump/Hooks
parentFixed typo again. (diff)
downloadcuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar.gz
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar.bz2
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar.lz
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar.xz
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.tar.zst
cuberite-57e83f7d49485e254ab33ee348ce66c3981005a5.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnServerPing.lua4
1 files changed, 3 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
index 7cfbd06ac..e4c8b054b 100644
--- a/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
+++ b/MCServer/Plugins/APIDump/Hooks/OnServerPing.lua
@@ -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
}