mirror of
https://github.com/pragma-/pbot.git
synced 2024-11-06 20:19:33 +01:00
0d7f0bf184
These are different from the loadable factoid modules. The factoid modules are external executable shell commands that take stdin as arguments and print to stdout as a return value. As such, they are not integrated into the bot and cannot make use of the bot's internal subroutines. These plugins are loaded internally and integrated into the bot such that they can interface with the bot's internal subroutines and state. All files in the Pluggable directory not beginning with an underscore will be automatically loaded at bot start-up. Plugins (including those starting with an underscore) can be manually loaded or unloaded with the `plug` and `unplug` commands. Use `pluglist` to list loaded plugins.
43 lines
1.1 KiB
Perl
43 lines
1.1 KiB
Perl
|
|
package PBot::Pluggable::_Example;
|
|
|
|
use warnings;
|
|
use strict;
|
|
|
|
use Carp ();
|
|
|
|
sub new {
|
|
Carp::croak("Options to " . __FILE__ . " should be key/value pairs, not hash reference") if ref $_[1] eq 'HASH';
|
|
my ($class, %conf) = @_;
|
|
my $self = bless {}, $class;
|
|
$self->initialize(%conf);
|
|
return $self;
|
|
}
|
|
|
|
sub initialize {
|
|
my ($self, %conf) = @_;
|
|
|
|
$self->{pbot} = delete $conf{pbot} // Carp::croak("Missing pbot reference to " . __FILE__);
|
|
|
|
$self->{pbot}->{event_dispatcher}->register_handler('irc.public', sub { $self->on_public(@_) });
|
|
}
|
|
|
|
sub unload {
|
|
my $self = shift;
|
|
# perform plugin clean-up here
|
|
# normally we'd unregister the 'irc.public' event handler; however, the
|
|
# event dispatcher will do this automatically for us when it sees there
|
|
# is no longer an existing sub.
|
|
}
|
|
|
|
sub on_public {
|
|
my ($self, $event_type, $event) = @_;
|
|
my ($nick, $user, $host, $msg) = ($event->{event}->nick, $event->{event}->user, $event->{event}->host, $event->{event}->args);
|
|
|
|
$self->{pbot}->{logger}->log("_Example plugin: got message from $nick!$user\@$host: $msg\n");
|
|
|
|
return 0;
|
|
}
|
|
|
|
1;
|