1
0
mirror of https://github.com/sys4-fr/server-nalc.git synced 2024-11-13 22:10:31 +01:00
server-nalc/mods/xban2/doc/API.md
2015-05-26 23:37:16 +02:00

839 B
Executable File

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").