[This is preliminary documentation and is subject to change.]
The PlayerInfo type exposes the following methods.
Methods
| Member | Description | |
|---|---|---|
| Ban(Player, String, Boolean, Boolean) | Bans given player. Kicks if online. Throws PlayerOpException on problems. | |
| BanAll(Player, String, Boolean, Boolean) | Bans given player, their IP, and all other accounts on IP.
All players from IP are kicked. Throws PlayerOpException on problems. | |
| BanIP(Player, String, Boolean, Boolean) | Bans given player and their IP address.
All players from IP are kicked. Throws PlayerOpException on problems. | |
| Can(Permission) | ||
| Can(Permission, Rank) | ||
| ChangeRank(Player, Rank, String, Boolean, Boolean, Boolean) | Changes rank of the player (promotes or demotes). Throws PlayerOpException on problems. | |
| Equals(Object) | (Inherited from Object.) | |
| Escape(String) | ||
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| Freeze(Player, Boolean, Boolean) | Freezes this player (prevents from moving, building, and from using most commands).
Throws PlayerOpException on problems. | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Mute(Player, TimeSpan, Boolean, Boolean) | Mutes this player (prevents from writing chat messages). | |
| ProcessBlockPlaced(Byte) | ||
| ProcessDrawCommand(Int32) | ||
| ProcessFailedLogin(Player) | ||
| ProcessLogin(Player) | ||
| ProcessLogout(Player) | ||
| ProcessMessageWritten()()()() | ||
| ProcessRankChange(Rank, String, String, RankChangeType) | ||
| ToString()()()() | (Overrides Object..::..ToString()()()().) | |
| Unban(Player, String, Boolean, Boolean) | Unbans a player. Throws PlayerOpException on problems. | |
| UnbanAll(Player, String, Boolean, Boolean) | Unbans given player, their IP address, and all other accounts on IP.
Throws PlayerOpException on problems. | |
| UnbanIP(Player, String, Boolean, Boolean) | Unbans given player and their IP address. Throws PlayerOpException on problems. | |
| Unescape(String) | ||
| UnescapeOldFormat(String) | ||
| Unfreeze(Player, Boolean, Boolean) | Unfreezes this player. Throws PlayerOpException on problems. | |
| Unmute(Player, Boolean, Boolean) | Unmutes this player (allows them to write chat again). |