Bot::BasicBot::Pluggable::Module::RD_Basic - Basic RDBot commands

Bot-BasicBot-Pluggable-Module-RD documentation Contained in the Bot-BasicBot-Pluggable-Module-RD distribution.

Index

Code Index:

NAME

Top

Bot::BasicBot::Pluggable::Module::RD_Basic - Basic RDBot commands

SYNOPSIS

Top

  !load RD

See the synopsis of Bot::BasicBot::Pluggable for how to load this plugin.

DESCRIPTION

Top

This is an example module of how to use the Bot::BasicBot::Pluggable::Module::RD grammar framework, and should be used as the basis of creating new pluggable RDBot modules.

Note that the grammar and methods in this module are available once RD has been loaded, but that will not be generally be true. A module that uses RD will need to have RD loaded first.

Grammar

The following simple commands are provided:

  say Hello channel
  tell ivorw I'm connected

There's also a catch all verb "Sorry", useful for dealing with, and disposing of error messages from other bots.

init

This is called by the BasicBot infrastructure. Put anything else here that needs to happen when your module is loaded.

help

You need to provide a help method, which is called when someone says

  bot: help module

See also Bot::BasicBot::Pluggable::Module.

command namespace

You provide subs in __PACKAGE__::Command for each command verb which get called. Note that there must be a new method available either here or in its super class.

BUGS

Top

Please report any bugs to http://rt.cpan.org.

AUTHOR

Top

    Ivor Williams
    CPAN ID: IVORW

    ivorw@cpan.org

COPYRIGHT

Top

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

Top

perl(1).

Bot-BasicBot-Pluggable-Module-RD documentation Contained in the Bot-BasicBot-Pluggable-Module-RD distribution. 
package Bot::BasicBot::Pluggable::Module::RD_Basic;
use strict;
use base qw(Bot::BasicBot::Pluggable::Module);
use Bot::BasicBot::Pluggable::Module::RD;

our $VERSION = '0.02';


my $grammar = <<'END';
<autotree>

command:    'say' /.*/
        |   'tell' recipient /.*/
        |   'Sorry'

recipient:  nick
        |   channel

nick:       /\w+/

channel:    /#\w+/

END


sub init {
    my $self = shift;

    Bot::BasicBot::Pluggable::Module::RD->extend( $grammar, __PACKAGE__ );
}


sub help {
    my $self = shift;

    return <<'END';
Basic RecDescent bot commands:
say <message>
tell <recipient> <message>
END

}


package Bot::BasicBot::Pluggable::Module::RD_Basic::Command;
use strict;

use base qw(Parse::RecDescent::Topiary::Base);

sub say {
    my ( $self, $bot, $context ) = @_;

    my $msg = $self->{__PATTERN1__};
    $bot->say( %$context, address => '', body => $msg );
}

sub tell {
    my ( $self, $bot, $context ) = @_;

    my $msg   = $self->{__PATTERN1__};
    my $recip = $self->{recipient};

    if ( exists $recip->{nick} ) {
        my $nick = $recip->{nick}{__VALUE__};
        $bot->say(
            %$context,
            body    => $msg,
            channel => 'msg',
            who     => $nick
        );
    }
    else {
        my $chan = $recip->{channel}{__VALUE__};
        $bot->say(
            %$context,
            body    => $msg,
            address => '',
            channel => $chan
        );
    }
}


1;