[This is preliminary documentation and is subject to change.]
Object representing persistent state ("record") of a player, online or offline.
There is exactly one PlayerInfo object for each known Minecraft account. All data is stored in the PlayerDB.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.0 (0.6.3.0)
Syntax
| C# |
public sealed class PlayerInfo : IClassy
Members
| All Members | Constructors  | Fields  | Properties  | Methods | Events  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| PlayerInfo(String, IPAddress, Rank) | Initializes a new instance of the PlayerInfo class |
| PlayerInfo(String, Rank, Boolean, RankChangeType) | Initializes a new instance of the PlayerInfo class |
| AccountType | Minecraft.net account type (paid/free/unknown). |
| 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. |
| BanChanged | Occurs after a player has been banned or unbanned. |
| BanChanging | Occurs when a player is about to be banned or unbanned. Cancellable. |
| BanDate | Date of most recent ban, UTC. May be DateTime.MinValue if player was never banned. |
| BandwidthUseMode | |
| BanIP(Player, String, Boolean, Boolean) | Bans given player and their IP address.
All players from IP are kicked. Throws PlayerOpException on problems. |
| BannedBy | Name of the entity responsible for most recent ban. May be empty. |
| BannedByClassy | |
| BannedUntil | Not implemented (for temp bans). |
| BanReason | Reason given for the most recent ban. May be empty. |
| BanStatus | Player's current BanStatus: Banned, NotBanned, or Exempt. |
| BeingCreated | Occurs when a new PlayerDB entry is being created.
Allows editing the starting rank. Cancellable (kicks the player). |
| BlocksBuilt | Total number of blocks manually built or painted by the player. |
| BlocksDeleted | Total number of blocks manually deleted by the player. |
| BlocksDrawn | Total number of blocks modified using draw and copy/paste commands. |
| Can(Permission) | |
| Can(Permission, Rank) | |
| ChangeRank(Player, Rank, String, Boolean, Boolean, Boolean) | Changes rank of the player (promotes or demotes). Throws PlayerOpException on problems. |
| CheckAccountType()()()() | Begins to asynchronously check player's account type. |
| ClassyName | |
| Created | Occurs after a new PlayerDB entry has been created. |
| DisplayedName | If set, replaces Name when printing name in chat. |
| 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.) |
| FirstLoginDate | First time the player ever logged in, UTC.
May be DateTime.MinValue if player has never been online. |
| Freeze(Player, Boolean, Boolean) | Freezes this player (prevents from moving, building, and from using most commands).
Throws PlayerOpException on problems. |
| FreezeChanged | Occurs after a player has been frozen or unfrozen. |
| FreezeChanging | Occurs when a player is about to be frozen or unfrozen. |
| FrozenBy | Name of the entity that most recently froze this player. May be empty. |
| FrozenByClassy | |
| FrozenOn | Date of the most recent freezing.
May be DateTime.MinValue of the player has never been frozen. |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| ID | Player's unique numeric ID. Issued on first join. |
| IsBanned | Returns whether player is name-banned or not. |
| IsFrozen | Whether this player is currently frozen. |
| IsHidden | Whether the player is currently hidden.
Use Player.CanSee() method to check visibility to specific observers. |
| IsMuted | Whether this player is currently muted. |
| IsOnline | Whether the player is currently online.
Another way to check online status is to check if PlayerObject is null. |
| LastFailedLoginDate | Date of most recent failed attempt to log in, UTC. |
| LastFailedLoginIP | IP from which player most recently tried (and failed) to log in, UTC. |
| LastIP | For offline players, last IP used to succesfully log in.
For online players, current IP. |
| LastKickBy | Name of the entity that most recently kicked this player. May be empty. |
| LastKickByClassy | |
| LastKickDate | Date of the most recent kick.
May be DateTime.MinValue if the player has never been kicked. |
| LastKickReason | Reason given for the most recent kick. May be empty. |
| LastLoginDate | Most recent time the player logged in, UTC.
May be DateTime.MinValue if player has never been online. |
| LastModified | |
| LastSeen | Last time the player has been seen online (last logout), UTC.
May be DateTime.MinValue if player has never been online. |
| LeaveReason | Reason for leaving the server last time. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| MessagesWritten | Total number of messages written. |
| MinFieldCount | |
| Mute(Player, TimeSpan, Boolean, Boolean) | Mutes this player (prevents from writing chat messages). |
| MuteChanged | Occurs after a player has been muted or unmuted. |
| MuteChanging | Occurs when a player is about to be muted or unmuted. |
| MutedBy | Name of the entity that most recently muted this player. May be empty. |
| MutedByClassy | |
| MutedUntil | Date until which the player is muted. If the date is in the past, player is NOT muted. |
| Name | Player's Minecraft account name. |
| Password | Not implemented (IRC/server password hash). |
| PlayerObject | If player is online, Player object associated with the session.
If player is offline, null. |
| PreviousRank | Player's previous rank.
May be null if player has never been promoted/demoted before. |
| ProcessBlockPlaced(Byte) | |
| ProcessDrawCommand(Int32) | |
| ProcessFailedLogin(Player) | |
| ProcessLogin(Player) | |
| ProcessLogout(Player) | |
| ProcessMessageWritten()()()() | |
| ProcessRankChange(Rank, String, String, RankChangeType) | |
| Rank | Player's current rank. |
| RankChanged | Occurs after a player's rank was changed (automatically or manually). |
| RankChangeDate | Date of the most recent promotion/demotion, UTC.
May be DateTime.MinValue if player has never been promoted/demoted before. |
| RankChangedBy | Name of the entity that most recently promoted/demoted this player. May be empty. |
| RankChangedByClassy | |
| RankChangeReason | Reason given for the most recent promotion/demotion. May be empty. |
| RankChangeType | Type of the most recent promotion/demotion. |
| RankChanging | Occurs when a player's rank is about to be changed (automatically or manually). |
| TimeMutedLeft | |
| TimesBannedOthers | Number of bans issued by this player. |
| TimeSinceBan | |
| TimeSinceFirstLogin | |
| TimeSinceFrozen | |
| TimeSinceLastKick | |
| TimeSinceLastLogin | |
| TimeSinceLastSeen | |
| TimeSinceRankChange | |
| TimeSinceUnban | |
| TimesKicked | Number of times that this player has been manually kicked. |
| TimesKickedOthers | Number of kicks issues by this player. |
| TimesVisited | Number of sessions/logins. |
| ToString()()()() | (Overrides Object..::..ToString()()()().) |
| TotalTime | Total amount of time the player spent on this server. |
| 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. |
| UnbanDate | Date of most recent unban, UTC. May be DateTime.MinValue if player was never unbanned. |
| UnbanIP(Player, String, Boolean, Boolean) | Unbans given player and their IP address. Throws PlayerOpException on problems. |
| UnbannedBy | Name of the entity responsible for most recent unban. May be empty. |
| UnbannedByClassy | |
| UnbanReason | Reason given for the most recent unban. May be empty. |
| 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). |
