From 15a030ec9f5d9016c287cf3964894683121e59fd Mon Sep 17 00:00:00 2001 From: sfan5 Date: Tue, 5 Nov 2019 19:24:51 +0100 Subject: Improve documentation around banning (#9088) * Fix ban chatcommand description * Correct ban API documentation --- doc/lua_api.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 1905eff44..c0501f6bf 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -4896,13 +4896,16 @@ Server Bans ---- -* `minetest.get_ban_list()`: returns the ban list - (same as `minetest.get_ban_description("")`). -* `minetest.get_ban_description(ip_or_name)`: returns ban description (string) -* `minetest.ban_player(name)`: ban a player -* `minetest.unban_player_or_ip(name)`: unban player or IP address -* `minetest.kick_player(name, [reason])`: disconnect a player with a optional +* `minetest.get_ban_list()`: returns a list of all bans formatted as string +* `minetest.get_ban_description(ip_or_name)`: returns list of bans matching + IP address or name formatted as string +* `minetest.ban_player(name)`: ban the IP of a currently connected player + * Returns boolean indicating success +* `minetest.unban_player_or_ip(ip_or_name)`: remove ban record matching + IP address or name +* `minetest.kick_player(name, [reason])`: disconnect a player with an optional reason. + * Returns boolean indicating success (false if player nonexistant) Particles --------- -- cgit v1.2.3