[This is preliminary documentation and is subject to change.]
The IPBanList type exposes the following methods.
Methods
| Member | Description | |
|---|---|---|
| Add(IPBanInfo, Boolean) | Adds a new IP Ban. | |
| BanAll(IPAddress, Player, String, Boolean, Boolean) | Bans given IP address and all accounts on that IP. All players from IP are kicked.
Throws PlayerOpException on problems. | |
| BanIP(IPAddress, Player, String, Boolean, Boolean) | Bans given IP address. All players from IP are kicked. If an associated PlayerInfo is known,
use a different overload of this method instead. Throws PlayerOpException on problems. | |
| Contains(IPAddress) | Checks whether the given address is banned. | |
| Get(IPAddress) | Retrieves ban information for a given IP address. | |
| Remove(IPAddress, Boolean) | Removes a given IP address from the ban list (if present). | |
| UnbanAll(IPAddress, Player, String, Boolean, Boolean) | Unbans given IP address and all accounts on that IP. | |
| UnbanIP(IPAddress, Player, String, Boolean, Boolean) | Unbans an IP address. If an associated PlayerInfo is known,
use a different overload of this method instead. Throws PlayerOpException on problems. |