[This is preliminary documentation and is subject to change.]
Handles the addition, lookup, and removal of IP bans.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.1 (0.6.3.1)
Syntax
| C# |
public static class IPBanList
Members
| All Members | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| Add(IPBanInfo, Boolean) | Adds a new IP Ban. | |
| AddedIPBan | Occurs when a new IP ban has been added. | |
| AddingIPBan | Occurs when a new IP ban is about to be added (cancelable). | |
| 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. | |
| Count | Number of active IP bans on record. | |
| Get(IPAddress) | Retrieves ban information for a given IP address. | |
| IsLoaded | ||
| Remove(IPAddress, Boolean) | Removes a given IP address from the ban list (if present). | |
| RemovedIPBan | Occurs after an existing IP ban has been removed. | |
| RemovingIPBan | Occurs when an existing IP ban is about to be removed (cancelable). | |
| 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. |