[This is preliminary documentation and is subject to change.]
Describes a chat command. Defines properties, permission requirements, and usage information.
Specifies a handler method.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.1 (0.6.3.1)
Syntax
| C# |
public sealed class CommandDescriptor : IClassy
Members
| All Members | Constructors  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| CommandDescriptor()()()() | Initializes a new instance of the CommandDescriptor class |
| Aliases | List of aliases. May be null or empty. Default: null |
| AnyPermission | Whether any permission from the list is enough.
If this is false, ALL permissions are required. |
| Call(Player, CommandReader, Boolean) | Calls this command. |
| CanBeCalledBy(Rank) | Checks whether this command may be called by players of a given rank. |
| Category | Command category. Must be set before registering. |
| ClassyName | Returns a formatted name of the command,
colored and possibly prefixed according to MinRank requried to call this command. |
| DisableLogging | Whether calls to this command should not be logged. |
| Equals(Object) | (Inherited from Object.) |
 | 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.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| Handler | Callback function to execute when command is called. Must be set before registering. |
| Help | Full text of the help message. Default: null |
| HelpSections | Help sub-sections. |
| IsConsoleSafe | Whether the command may be used from console. Default: false |
| IsCustom | Whether the command is not part of fCraft core (set automatically). |
| IsHidden | Whether the command is hidden from command list (/cmds). Default: false |
| IsVisibleTo(Rank) | Checks whether players of the given rank should see this command in /cmds list.
Takes permissions and the hidden flag into account. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| MinRank | Gets the lowest rank that has any/all permissions to call this command.
Returns null if none of the ranks have necessary permissions. |
| Name | Primary command name. Must be set before registering. |
| NotRepeatable | Whether the command should be repeated by the "/" shortcut. Default: false |
| Permissions | List of permissions required to call the command. May be empty or null. Default: null |
| PrintUsage(Player) | Prints command usage syntax to the given player. |
| RepeatableSelection | Whether this command involves a selection that can be repeated with /static. Default: false |
| ToString()()()() | (Overrides Object..::..ToString()()()().) |
| UsableByFrozenPlayers | Whether the command should be usable by frozen players. Default: false |
| Usage | Brief demonstration of command's usage syntax. Defaults to "/Name". |
