[This is preliminary documentation and is subject to change.]
Rank of a player. Ranks are arranged in a linear hierarchy.
One instance of a Rank object should be shared by players of the same rank.
Rank objects are comparable - you can use comparison operators or CompareTo.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.5 (0.6.3.5)
Syntax
| C# |
public sealed class Rank : IClassy, IComparable<Rank>
Members
| All Members | Constructors  | Fields  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| Rank(XElement) | Initializes a new instance of the Rank class |
| Rank(String, String) | Sets the name and ID of this Rank. |
| AllowSecurityCircumvention | Whether players of this rank are allowed to remove restrictions that affect themselves.
Affects /WMain, /WAccess, /WBuild, /ZAdd, /ZEdit, and /ZRemove. |
| AntiGriefBlocks | Number of blocks that need to be modified in AntiGriefSeconds for the AntiGrief to kick in for this Rank. |
| AntiGriefSeconds | The interval in seconds for which to count number of blocks broken for use in AntiGrief for this Rank. |
| Can(Permission) | Checks whether this rank is granted the given permission. |
| Can(Permission, Rank) | Checks whether this rank is granted the given permission, and whether the limit is high |
| CanSee(Rank) | Whether players of this rank are allowed to see hidden players of the given rank. |
| ClassyName | Decorated name of the rank, including color and prefix
(if enabled by the configuration). |
| Color | Rank color code. Should not be left blank. |
| CompareTo(Rank) | |
| CopySlots | Maximum number of buffered copies this rank is allowed to have. |
| DrawLimit | Maximum number of blocks that player is allowed to draw at a time using draw commands. |
| Equals(Object) | (Inherited from Object.) |
| FillLimit | Maximum number of blocks away the origin that a fill is allowed to travel.
Applies to /Fill2D command. For example, a limit of 32, means that the maximum fill
dimensions are (32 * 2 + 1), which is 65 x 65 |
 | 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.) |
| FullName | Fully qualified name of the rank. Format: "Name#ID".
Should be used whereever rank name needs to be serialized. |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetLimit(Permission) | Returns the highest rank that is allowed to be affected by this rank,
in the conext of the given permission. If no limit was explicitly specified, returns this/own rank. |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| GreaterThan(Rank, Rank) | |
| GreaterThanOrEqual(Rank, Rank) | |
| HasLimitSet(Permission) | Checks whether this rank has a rank limit explicitly set for the given permission. |
| HasReservedSlot | Whether this rank has a reserved slot (is allowed to join the server even if it's full). |
| ID | Unique rank ID. Generated by Rank.GenerateID. Assigned once at creation.
Used to preserve compatibility in case a rank gets renamed. |
| IdleKickTimer | Time until the idle kicker will kick this Rank from the server. |
| Index | Rank's relative index on the hierarchy. Index of the top rank is always 0.
Subordinate ranks start at 1. Higher index = lower rank. |
| IsValidID(String) | |
| IsValidPrefix(String) | |
| IsValidRankName(String) | |
| LessThan(Rank, Rank) | |
| LessThanOrEqual(Rank, Rank) | |
| MainWorld | The main world for this Rank. Set and saved by WorldManager. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Name | Rank's displayed name.
Use rank.FullName instead for serializing (to improve backwards compatibility). |
| NextRankDown | The Rank immediately below this Rank. Null if there is no lower rank. Set by RankManager. |
| NextRankUp | The Rank immediately above this Rank. Null if there is no higher rank. Set by RankManager. |
| Parse(String) | Parses serialized rank. Accepts either the "name" or "name#ID" format.
Uses legacy rank mapping table for unrecognized ranks. Does not autocomple.
Name part is case-insensitive. ID part is case-sensitive. |
| PermissionLimits | |
| Permissions | Set of permissions given to this rank. Use Rank.Can() to access. |
| PlayerCount | Total number of players of this rank (online and offline). |
| Players | Shortcut to the list of all online players of this rank. |
| Prefix | String that prefixes the username of all members of this rank. |
| ResetLimit(Permission) | Resets the rank limit for the given permission to default ("own rank"). |
| Serialize()()()() | |
| SetLimit(Permission, Rank) | Sets the rank limit for the given permission. |
| ToString()()()() | (Overrides Object..::..ToString()()()().) |
