[This is preliminary documentation and is subject to change.]

Manages all the ranks on a server. Controlls what ranks are avaliable and in what order they exist in.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.3.5 (0.6.3.5)

Syntax

   
 C# 
public static class RankManager

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
AddRank(Rank)
Adds a new rank to the list. Checks for duplicates.
BlockDBAutoEnableRank
Rank used by BlockDB to determine whether it should be auto-enabled on a world or not. Worlds where BuildSecurity.MinRank is equal or lower than this rank WILL have BlockDB auto-enabled.
CanRenameRank(Rank, String)
DefaultBuildRank
The default minimum Rank required to build in newly created worlds.
DefaultRank
Default Rank of a new user.
DeleteRank(Rank, Rank)
Removes the specified rank from the list of available ranks
FindRank(Int32)
Finds rank by index. Rank at index 0 is the highest.
FindRank(String)
Parses rank name (without the ID) using autocompletion.
GenerateID()()()()
Creates a 16 character unique rank ID, via Server.GetRandomString().
GetIndex(Rank)
GetMinRankWithAllPermissions(array<Permission>[]()[][])
Finds the lowest rank that has all the required permissions.
GetMinRankWithAnyPermission(array<Permission>[]()[][])
Finds the lowest rank that has all the required permissions.
HighestRank
Highest Rank available in the server.
LowerRank(Rank)
Lowers the index value of the specified Rank, and then raises the rank that was previously in that position.
LowestRank
Lowest Rank available in the server.
PatrolledRank
Highest Rank that Patrol will consider when selecting canditates.
RaiseRank(Rank)
Raises the index value of the specified Rank, and then lowers the rank that was previously in that position.
Ranks
List of all Ranks, in no particular order.
RanksByFullName
List of Ranks, indexed by their fully qualified name.
RanksByID
List of Ranks, indexed by their ID.
RanksByName
List of Ranks, indexed by their name.
RenameRank(Rank, String)

Inheritance Hierarchy

System..::..Object
  fCraft..::..RankManager

See Also