luanti-org/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-10-17 18:35:20 +02:00
Code Activity

Improve documentation around banning (#9088)

Browse Source 
* Fix ban chatcommand description
* Correct ban API documentation
This commit is contained in:
sfan5
2019-11-05 19:24:51 +01:00
committed by GitHub
parent 2907c0f3a2
commit 15a030ec9f
2 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/lua_api.txt
View File

@@ -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
---------