[This is preliminary documentation and is subject to change.]
Controller for setting and checking per-rank permissions and per-player exceptions.
Used by World.AccessSecurity, World.BuildSecurity, and Zone.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.0 (0.6.3.0)
Syntax
| C# |
public sealed class SecurityController : ICloneable, INotifiesOnChange
Members
| All Members | Constructors | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| SecurityController()()()() | Creates a new controller with no restrictions. | |
| SecurityController(SecurityController) | Creates a copy of an existing controller. | |
| SecurityController(XContainer, Boolean) | Initializes a new instance of the SecurityController class | |
| Changed | ||
| Check(PlayerInfo) | Checks whether a player is allowed by this controller. | |
| CheckDetailed(PlayerInfo) | Checks player's permission status with this controller, in detail. | |
| Clone()()()() | Creates a copy of an existing controller. | |
| Equals(Object) | (Inherited from Object.) | |
| ExceptionList | ||
| Exclude(PlayerInfo) | Either specially excludes a player (if their state
was previously neutral), or removes a specific inclusion. | |
| 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.) | |
| GetDescription(IClassy, String, String) | Creates a description string of the controller. | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| HasRankRestriction | True if a rank restriction is in effect.
This property is used to distinguish cases of no MinRank set
vs. cases of MinRank set to LowestRank. | |
| HasRestrictions | True if this controller has any restrictions
(per-rank or per-player). | |
| Include(PlayerInfo) | Either specially includes a player (if their state
was previously neutral), or removes a specific exclusion. | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| MinRank | Lowest allowed player rank. | |
| Reset()()()() | Resets all permissions: minimum rank,
excluded player list, and included player list. | |
| ResetExcludedList()()()() | Clears the list of specifically excluded players. | |
| ResetIncludedList()()()() | Clears the list of specifically included players. | |
| ResetMinRank()()()() | ||
| Serialize()()()() | ||
| Serialize(String) | ||
| ToString()()()() | (Inherited from Object.) | |
| XmlRootElementName |