Plugins

Exporter

Plugins

Summary

Plugins
Variables
@EXPORT
Plugin Hashes
Functions
registerPlugin	Is called from each plugin to register Adds plugin to %plugins and %descriptions
getFunc	Is called when Bot gets a message.
getIdleFunc	Is called every 15 seconds
getDesc	Looksup the description of a plugin
getPlugins	a list of all plugin keys
getShortDesc	short Description for a Plugin

Variables

@EXPORT

our @EXPORT

Plugin Hashes

%plugins	Hash of plugins with key=command and value=reference to function in plugin
@idlefunctions	List of refereces to idlefunctions of plugins (this function gets called every 15 seconds)
%descriptions	Hash of plugins with key=command and value=description of plugin for help command
%shortDescriptions	Hash of plugins with key=command and value=shortdescription of plugin to give a short description for each plugin at the help command

Functions

registerPlugin

sub registerPlugin

Is called from each plugin to register Adds plugin to %plugins and %descriptions

Parameters

$keyword	Command to activate plugin
$function	Reference to plugin function
$description	String with description of plugin for help command

getFunc

sub getFunc

Is called when Bot gets a message. Checks if the first word is key of a plugin. If it is then the reference to the pluginfunction is returned. Else 0 is returned.

Parameters

$key	First word of received string.

Returns

Reference to plugin function or 0 (if no such plugin exists)

getIdleFunc

sub getIdleFunc

Is called every 15 seconds

Parameters

$key	First word of received string.

Returns

List of References to idlefunctions of plugins

getDesc

sub getDesc

Looksup the description of a plugin

Parameters

$key	Command of the plugin

Returns

Description of plugin or errormessage (if plugin doesn’t exists)

getPlugins

sub getPlugins

Returns

a list of all plugin keys

getShortDesc

sub getShortDesc

Returns

short Description for a Plugin