C# Class Kiwana.Api.Plugin

The class all Plugins must inherit from.

Datei anzeigen Open project: Banane9/Kiwana

Public Methods

Method	Description
HandleLine ( List ex, string recipient, string command, bool userAuthorized, bool console ) : void	This method gets called every time the bot receives a line.
Load ( ) : void	Called when the class is initialized. Load data, etc. here.
Unload ( ) : void	Called when the bot shuts down. Save data, etc. here.

Method	Description
SendData ( MessageTypes messageType, string argument = "" ) : void	This function is used by the derived class to send the event. Can be overridden.

This method gets called every time the bot receives a line.

public HandleLine ( List ex, string recipient, string command, bool userAuthorized, bool console ) : void
ex	List	The line from the server, split at spaces.
recipient	string	The channel or user the message came from. Empty when from console.
command	string	The normalized command. Empty if there's no command.
userAuthorized	bool	Whether the user sending the command is authorized. False if there's no command.
console	bool	Whether the line came from the console.
return	void

Called when the class is initialized. Load data, etc. here.

public Load ( ) : void
return	void

This function is used by the derived class to send the event. Can be overridden.

protected SendData ( MessageTypes messageType, string argument = "" ) : void
messageType	MessageTypes
argument	string
return	void

Called when the bot shuts down. Save data, etc. here.

public Unload ( ) : void
return	void