C# Class fCraft.CommandManager

Static class that allows registration and parsing of all text commands.

Public Properties

Property	Type	Description
ReservedCommandNames	string[]

Method	Description
GetCommands ( ) : fCraft.CommandDescriptor[]	Gets a list of all commands (includding hidden ones).
GetCommands ( CommandCategory category, bool includeHidden ) : fCraft.CommandDescriptor[]	Gets a list of commands in a specified category. Note that commands may belong to more than one category.
GetCommands ( [ rank, bool includeHidden ) : fCraft.CommandDescriptor[]	Gets a list of commands available to a specified rank.
GetCommands ( bool hidden ) : fCraft.CommandDescriptor[]	Gets a list of ONLY hidden or non-hidden commands, not both.
Init ( ) : void
IsValidCommandName ( [ name ) : bool	Checks whether a command name is acceptible. Constraints are similar to Player.IsValidName, except for minimum length.
ParseCommand ( [ player, [ cmd, bool fromConsole ) : bool	Parses and calls a specified command.
RegisterCustomCommand ( [ descriptor ) : void	Registers a custom command with fCraft. CommandRegistrationException may be thrown if the given descriptor does not meet all the requirements.

Method	Description
GetDescriptor ( [ commandName, bool alsoCheckAliases ) : CommandDescriptor
RaiseCommandCalledEvent ( Command cmd, CommandDescriptor descriptor, Player player ) : void
RaiseCommandCallingEvent ( Command cmd, CommandDescriptor descriptor, Player player ) : bool
RaiseCommandRegisteredEvent ( CommandDescriptor descriptor ) : void
RaiseCommandRegisteringEvent ( CommandDescriptor descriptor ) : bool
RegisterCommand ( [ descriptor ) : void

Gets a list of all commands (includding hidden ones).

public static GetCommands ( ) : fCraft.CommandDescriptor[]
return	fCraft.CommandDescriptor[]

Gets a list of commands in a specified category. Note that commands may belong to more than one category.

public static GetCommands ( CommandCategory category, bool includeHidden ) : fCraft.CommandDescriptor[]
category	CommandCategory
includeHidden	bool
return	fCraft.CommandDescriptor[]

Gets a list of commands available to a specified rank.

public static GetCommands ( [ rank, bool includeHidden ) : fCraft.CommandDescriptor[]
rank	[
includeHidden	bool
return	fCraft.CommandDescriptor[]

Gets a list of ONLY hidden or non-hidden commands, not both.

public static GetCommands ( bool hidden ) : fCraft.CommandDescriptor[]
hidden	bool
return	fCraft.CommandDescriptor[]

public static Init ( ) : void
return	void

Checks whether a command name is acceptible. Constraints are similar to Player.IsValidName, except for minimum length.

public static IsValidCommandName ( [ name ) : bool
name	[	Command name to check.
return	bool

Parses and calls a specified command.

public static ParseCommand ( [ player, [ cmd, bool fromConsole ) : bool
player	[	Player who issued the command.
cmd	[	Command to be parsed and executed.
fromConsole	bool	Whether this command is being called from a non-player (e.g. Console).
return	bool

Registers a custom command with fCraft. CommandRegistrationException may be thrown if the given descriptor does not meet all the requirements.

public static RegisterCustomCommand ( [ descriptor ) : void
descriptor	[
return	void

public static string[] ReservedCommandNames
return	string[]