C# Класс fCraft.RankManager

Manages all the ranks on a server. Controls what ranks are available and in what order they exist in.
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
DefaultRank Rank

Private Properties

Свойство Тип Описание
CheckIfPlayerDBLoaded void
DefineDefaultRanks XElement
FindRank Rank
FindRank Rank
FindRank Rank
GenerateId string
GetMinRankWithAllPermissions Rank
GetMinRankWithAnyPermission Rank
ParsePermissionLimits void
RankManager System
RebuildIndex void
Reset void
SortRanksByLegacyNumericRank void

Открытые методы

Метод Описание
AddRank ( Rank rank ) : void

Adds a new rank to the list. Checks for duplicates.
AddRank ( [ rank ) : void

Adds a new rank to the list. Checks for duplicates.
AddRank ( [ newRank, int desiredIndex ) : void

Adds a new rank to the list at the desired position in the hierarchy. Checks for duplicates.
CanRenameRank ( Rank rank, string newName ) : bool
CanRenameRank ( [ rank, [ newName ) : bool
DeleteRank ( Rank deletedRank, Rank replacementRank ) : bool
DeleteRank ( [ deletedRank, [ replacementRank ) : bool
GenerateID ( ) : string
GetIndex ( Rank rank ) : int
GetMinRankWithPermission ( ) : Rank

Finds the lowest rank that has all the required permissions.
LowerRank ( Rank rank ) : bool
LowerRank ( [ rank ) : bool
ParseRank ( string name ) : Rank

Parses serialized rank. Accepts either the "name" or "name#ID" format. Uses legacy rank mapping table for unrecognized ranks. Does not autocomple.
RaiseRank ( Rank rank ) : bool
RaiseRank ( [ rank ) : bool
RenameRank ( Rank rank, string newName ) : void
RenameRank ( [ rank, [ newName ) : void
ResetToDefaults ( ) : void

Resets the list of ranks to defaults (guest/builder/op/owner). Warning: This method is not thread-safe, and should never be used on a live server.

Приватные методы

Метод Описание
CheckIfPlayerDBLoaded ( ) : void
DefineDefaultRanks ( ) : XElement
FindRank ( [ name ) : Rank
FindRank ( int index ) : Rank
FindRank ( string name ) : Rank
GenerateId ( ) : string
GetMinRankWithAllPermissions ( ) : Rank
GetMinRankWithAnyPermission ( ) : Rank
ParsePermissionLimits ( ) : void
RankManager ( ) : System
RebuildIndex ( ) : void
Reset ( ) : void

Clears the list of ranks.
SortRanksByLegacyNumericRank ( ) : void

Описание методов

AddRank() публичный статический Метод

Adds a new rank to the list. Checks for duplicates.
public static AddRank ( Rank rank ) : void
rank Rank
Результат void

AddRank() публичный статический Метод

Adds a new rank to the list. Checks for duplicates.
public static AddRank ( [ rank ) : void
rank [
Результат void

AddRank() публичный статический Метод

Adds a new rank to the list at the desired position in the hierarchy. Checks for duplicates.
If rank is null. If PlayerDB is already loaded. If a rank with this name or ID is already defined.
public static AddRank ( [ newRank, int desiredIndex ) : void
newRank [ Rank to add to the list.
desiredIndex int Desired rank index (zero-based).
Результат void

CanRenameRank() публичный статический Метод

public static CanRenameRank ( Rank rank, string newName ) : bool
rank Rank
newName string
Результат bool

CanRenameRank() публичный статический Метод

public static CanRenameRank ( [ rank, [ newName ) : bool
rank [
newName [
Результат bool

DeleteRank() публичный статический Метод

public static DeleteRank ( Rank deletedRank, Rank replacementRank ) : bool
deletedRank Rank
replacementRank Rank
Результат bool

DeleteRank() публичный статический Метод

public static DeleteRank ( [ deletedRank, [ replacementRank ) : bool
deletedRank [
replacementRank [
Результат bool

GenerateID() публичный статический Метод

public static GenerateID ( ) : string
Результат string

GetIndex() публичный статический Метод

public static GetIndex ( Rank rank ) : int
rank Rank
Результат int

GetMinRankWithPermission() публичный статический Метод

Finds the lowest rank that has all the required permissions.
public static GetMinRankWithPermission ( ) : Rank
Результат Rank

LowerRank() публичный статический Метод

public static LowerRank ( Rank rank ) : bool
rank Rank
Результат bool

LowerRank() публичный статический Метод

public static LowerRank ( [ rank ) : bool
rank [
Результат bool

ParseRank() публичный статический Метод

Parses serialized rank. Accepts either the "name" or "name#ID" format. Uses legacy rank mapping table for unrecognized ranks. Does not autocomple.
public static ParseRank ( string name ) : Rank
name string Full rank name
Результат Rank

RaiseRank() публичный статический Метод

public static RaiseRank ( Rank rank ) : bool
rank Rank
Результат bool

RaiseRank() публичный статический Метод

public static RaiseRank ( [ rank ) : bool
rank [
Результат bool

RenameRank() публичный статический Метод

public static RenameRank ( Rank rank, string newName ) : void
rank Rank
newName string
Результат void

RenameRank() публичный статический Метод

public static RenameRank ( [ rank, [ newName ) : void
rank [
newName [
Результат void

ResetToDefaults() публичный статический Метод

Resets the list of ranks to defaults (guest/builder/op/owner). Warning: This method is not thread-safe, and should never be used on a live server.
public static ResetToDefaults ( ) : void
Результат void

Описание свойств

DefaultRank публичное статическое свойство

public static Rank DefaultRank
Результат Rank