debian man page for poe::component::irc::plugin::bottraffic

POE::Component::IRC::Plugin::BotTraffic(3pm)		User Contributed Perl Documentation	      POE::Component::IRC::Plugin::BotTraffic(3pm)

NAME
       POE::Component::IRC::Plugin::BotTraffic - A PoCo-IRC plugin that generates events when you send messages

SYNOPSIS
	use POE::Component::IRC::Plugin::BotTraffic;

	$irc->plugin_add( 'BotTraffic', POE::Component::IRC::Plugin::BotTraffic->new() );

	sub irc_bot_public {
	    my ($kernel, $heap) = @_[KERNEL, HEAP];
	    my $channel = $_[ARG0]->[0];
	    my $what = $_[ARG1];

	    print "I said '$what' on channel $channel
";
	    return;
	}

DESCRIPTION
       POE::Component::IRC::Plugin::BotTraffic is a POE::Component::IRC plugin. It watches for when your bot sends PRIVMSGs and NOTICEs to the
       server and generates the appropriate events.

       These events are useful for logging what your bot says.

METHODS
   "new"
       No arguments required. Returns a plugin object suitable for feeding to POE::Component::IRC's "plugin_add" method.

OUTPUT EVENTS
       These are the events generated by the plugin. Both events have "ARG0" set to an arrayref of recipients and "ARG1" the text that was sent.

   "irc_bot_public"
       "ARG0" will be an arrayref of recipients. "ARG1" will be the text sent.

   "irc_bot_msg"
       "ARG0" will be an arrayref of recipients. "ARG1" will be the text sent.

   "irc_bot_action"
       "ARG0" will be an arrayref of recipients. "ARG1" will be the text sent.

   "irc_bot_notice"
       "ARG0" will be an arrayref of recipients. "ARG1" will be the text sent.

AUTHOR
       Chris 'BinGOs' Williams [chris@bingosnet.co.uk]

SEE ALSO
       POE::Component::IRC

perl v5.14.2							    2011-12-07			      POE::Component::IRC::Plugin::BotTraffic(3pm)