Chris Prather > Adam-0.09 > Adam

Download:
Adam-0.09.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.09   Source   Latest Release: Adam-0.91

NAME ^

Adam - The patriarch of IRC Bots

VERSION ^

This documentation refers to version 0.05.

SYNOPSIS ^

See the Synopsis in Moses. Adam is not meant to be used directly.

DESCRIPTION ^

The Adam class implements a basic POE::Component::IRC bot based on Moose and MooseX::POE.

ATTRIBUTES ^

nickname (Str)

The IRC nickname for the bot, it will default to the package name.

server (Str)

The IRC server to connect to.

port (Int)

The port for the IRC server, defaults to 6667

username(Str)

The username which we should use

password(Str)

The server password which we shoulduse

channels (ArrayRef[Str])

IRC channels to connect to.

owner (Str)

The hostmask of the ower of the bot. The owner can control the bot's plugins through IRC using the <POE::Component::IRC::Plugin::Plugman|Plugman> interface.

flood (Bool)

Disable flood protection. Defaults to False.

plugins (HashRef)

A list of plugins associated with the IRC bot. See Moses::Plugin for more details.

extra_args (HashRef)

A list of extra arguments to pass to the irc constructor.

METHODS ^

privmsg (Str $who, Str $what)

Send message $what as a private message to $who, a channel or nick.

run ()

Start the IRC bot. This method also works as a Class Method and will instanciate the bot if called as such.

DEPENDENCIES ^

MooseX::POE, namespace::autoclean, MooseX::Alias, POE::Component::IRC, MooseX::Getopt, MooseX::SimpleConfig, MooseX::LogDispatch

BUGS AND LIMITATIONS ^

None known currently, please email the author if you find any.

AUTHOR ^

Chris Prather (chris@prather.org)

LICENCE ^

Copyright 2007-2009 by Chris Prather.

This software is free. It is licensed under the same terms as Perl itself.

syntax highlighting: