C# Class Squishy.Irc.Commands.Command

Basic Command Class, Inherit your Commands from here. Automatically creates one instance per IrcClient when the Class is loaded, using the default constructor.

Datei anzeigen Open project: jaddie/WCell-Utility-Bot Class Usage Examples

Public Properties

Property	Type	Description
Aliases	string[]

Public Methods

Method	Description
Process ( CmdTrigger trigger ) : void	Is called when the command is triggered (case-insensitive).

Protected Methods

Method	Description
Command ( ) : System	In the Constructor you deliver the alias names. Calling this ctor automatically sets the Instance to the newly invoked instance.
OnFail ( CmdTrigger trigger ) : void	An array of possible server-side replies to this Command. If this command is executed, the response from the server will again be replied to the user who initiated this. Is triggered when the processing throws an Exception.

Private Methods

Method	Description
ExecutedNotify ( CmdTrigger trigger ) : void
FailNotify ( CmdTrigger trigger, Exception ex ) : void

Method Details

Command() protected method

In the Constructor you deliver the alias names. Calling this ctor automatically sets the Instance to the newly invoked instance.

protected Command ( ) : System
return	System

OnFail() protected method

An array of possible server-side replies to this Command. If this command is executed, the response from the server will again be replied to the user who initiated this. Is triggered when the processing throws an Exception.

protected OnFail ( CmdTrigger trigger ) : void
trigger	CmdTrigger
return	void

Process() public abstract method

Is called when the command is triggered (case-insensitive).

public abstract Process ( CmdTrigger trigger ) : void
trigger	CmdTrigger
return	void

Property Details

Aliases public_oe property

All Aliases which can trigger the Process method of this Command.

public string[] Aliases
return	string[]