[This is preliminary documentation and is subject to change.]
The Rank type exposes the following properties.
Properties
| Member | Description | |
|---|---|---|
| ClassyName | Decorated name of the rank, including color and prefix
(if enabled by the configuration). | |
| Color | Rank color code. Should not be left blank. | |
| FullName | Fully qualified name of the rank. Format: "Name#ID".
Should be used whereever rank name needs to be serialized. | |
| ID | Unique rank ID. Generated by Rank.GenerateID. Assigned once at creation.
Used to preserve compatibility in case a rank gets renamed. | |
| MainWorld | The main world for this Rank. Set and saved by WorldManager. | |
| 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. | |
| 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. |