minetest-mods/xban2
1
0
Fork 2
mirror of https://github.com/minetest-mods/xban2.git synced 2025-07-01 07:50:24 +02:00
Code Issues Releases Wiki Activity

First commit.

Browse Source
This commit is contained in:
Diego Martinez
2014-05-19 23:23:43 -03:00
commit 8695476beb
5 changed files with 421 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/API.md Normal file
View File

@ -0,0 +1,32 @@
## Extended Ban Mod API
### ban_player
`xban.ban_player(player_or_ip, source, expires, reason)`
Ban a player and all of his/her alternative names and IPs.
#### Arguments:
* `player_or_ip` - Player to search for and ban. See note 1 below.
* `source` - Source of the ban. See note 2 below.
* `expires` - Time at which the ban expires. If nil, ban is permanent.
* `reason` - Reason for ban.
### unban_player
`xban.unban_player(player_or_ip, source)`
Unban a player and all of his/her alternative names and IPs.
#### Arguments:
* `player_or_ip` - Player to search for and unban.
* `source` - Source of the ban. See note 2 below.
### Notes
* 1: If player is currently online, all his accounts are kicked.
* 2: Mods using the xban API are advised to use the `"modname:source"`
format for `source` (for example: `"anticheat:main"`).