BanAPI

Changelog

• PMMP 1.1dev (no API version) - Introduced
• NC 1.1.0dev (1.0.2dev, API 12.1) deprecated BanAPI::cmdWhitelist

API to ban, kick players, and check their statuses.

Functions

isOp(username)

• Description: Checks is player op or not
• Return: true if the player is op, false otherwise.
• Arguments:
  • mixed username - username to check. Must be a string.

isBanned(username)

• Description: Checks is player banned or not
• Return: true if the player is banned, false otherwise.
• Arguments:
  • mixed username - username to check. Must be a string.

isIPBanned(ip)

• Description: Checks is ip banned or not
• Return: true if ip is banned, false otherwise.
• Arguments:
  • mixed ip - ip to check. Must be a string.

inWhitelist(username)

• Description: Checks is player whitelisted or not
• Return: true if the player is whitelisted, false otherwise.
• Arguments:
  • mixed username - username to check. Must be a string.

ban(username)

• Description: Ban a player.
• Return: nothing
• Arguments:
  • mixed username - username to ban. Must be a string.

pardon(username)

• Description: Unban a player.
• Return: nothing
• Arguments:
  • mixed username - username to unban. Must be a string.

kick(username, reason="No Reason")

• Description: Kick a player.
• Return: nothing
• Arguments:
  • mixed username - username to kick. Must be a string.
  • mixed reason - kick reason. Must be a string.

banIP(ip)

• Description: Ban ip address.
• Return: nothing
• Arguments:
  • mixed ip - ip to ban. Must be a string.

pardonIP(ip)

• Description: Unban ip address.
• Return: nothing
• Arguments:
  • mixed ip - ip to ban. Must be a string.

Deprecated cmdWhitelist(cmd)

• Description: Use ConsoleAPI::cmdWhitelist.
• Return: nothing
• Arguments:
  • mixed cmd - Name of the command. Must be a string.