diff options
| author | sfan5 <sfan5@live.de> | 2019-11-05 19:24:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-11-05 19:24:51 +0100 |
| commit | 15a030ec9f5d9016c287cf3964894683121e59fd (patch) | |
| tree | e9133a2fd02176575992f772221d88a0c9a8995f /doc | |
| parent | 2907c0f3a2953601aa1a81ff8226ff60086fb41b (diff) | |
| download | minetest-15a030ec9f5d9016c287cf3964894683121e59fd.tar.gz minetest-15a030ec9f5d9016c287cf3964894683121e59fd.tar.bz2 minetest-15a030ec9f5d9016c287cf3964894683121e59fd.zip | |
Improve documentation around banning (#9088)
* Fix ban chatcommand description
* Correct ban API documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 15 |
1 files changed, 9 insertions, 6 deletions
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 --------- |