NAME

BoBot::PlugIn - Root class for the plugins.

SYNOPSIS

  use BoBot::PlugIn (
        TYPE => typeOfPlugIn,
        MANAGER => typeOfManagement,
        CLASS => {      CLASS1 => {     attr1 => [ re111, re112 ],
                                        attr2 =>[ re121 ]
                                },
                        CLASS2 => [ re21, re22 ]
                } );

DESCRIPTION

External Methods

class->new( parent, pattern ): constructor.
this->close( ): Close the plugin.
this->Chan( ): return the channel object (aka BoBot::Channel) wich is the direct parent of this.
this->Bot( ): return the bot object (aka BoBot::Server) wich is the direct parent oft this. method created by import( ).
this->Root( ): return the root object aka an BoBot::IRC object
this->match( message ): return if the plugin match the message; CLASS => { PRIVMSG => [ { Nick => [qr/toto/], PMsg => [qr/opme/] }, { Nick => [ qr/titi/ ], PMsg => [qr/kwel] } ], ... }
this->handler( message ): default handler for a plugin. MUST BE OVERLOADED.
this->dump( ref ): Dumps a reference in order to debug.

Internal Methods

this->DESTROY( ): Destructor.
this->import: The import methode called by ``use''. Place inheritance, and create some methods of the plugin.
this->subMatch( Message, patternLevel ): Test on the message a pattern level.
this->settingRules(): Initialize the rules of the plugin for a certain context.; /!\ THIS IS EXPERIMENTAL STUFF, READ THE CODE.
dclone( $ref ): Clone a struct deeply.
this->AUTOLOAD( ): Autoloder.

BUGS

I don't know ...

TO DO

Better documentation
Add tests ...

COPYRIGHT, LICENCE

 Copyright (c) 1997-2002 Sebastien BONNET
 Copyright (c) 2001-2002 Samuel    MOUNIEE
 Copyright (c) 2002      Jerome    QUELIN

This file is part of Bobot.

Bobot is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Bobot is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Bobot; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

AUTHOR

Samuel Mouniée
Jérôme Quelin