Skip to content
Permalink
Browse files

Improve documentation around banning (#9088)

* Fix ban chatcommand description
* Correct ban API documentation
  • Loading branch information
sfan5 committed Nov 5, 2019
1 parent 2907c0f commit 15a030ec9f5d9016c287cf3964894683121e59fd
Showing with 13 additions and 10 deletions.
  1. +4 −4 builtin/game/chat.lua
  2. +9 −6 doc/lua_api.txt
@@ -909,8 +909,8 @@ core.register_chatcommand("shutdown", {
})

core.register_chatcommand("ban", {
params = "[<name> | <IP_address>]",
description = "Ban player or show ban list",
params = "[<name>]",
description = "Ban the IP of a player or show the ban list",
privs = {ban=true},
func = function(name, param)
if param == "" then
@@ -922,7 +922,7 @@ core.register_chatcommand("ban", {
end
end
if not core.get_player_by_name(param) then
return false, "No such player."
return false, "Player is not online."
end
if not core.ban_player(param) then
return false, "Failed to ban player."
@@ -935,7 +935,7 @@ core.register_chatcommand("ban", {

core.register_chatcommand("unban", {
params = "<name> | <IP_address>",
description = "Remove player ban",
description = "Remove IP ban belonging to a player/IP",
privs = {ban=true},
func = function(name, param)
if not core.unban_player_or_ip(param) then
@@ -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
---------

0 comments on commit 15a030e

Please sign in to comment.
You can’t perform that action at this time.