.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::BotTraffic 3pm"
.TH POE::Component::IRC::Plugin::BotTraffic 3pm "2021-09-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::IRC::Plugin::BotTraffic \- A PoCo\-IRC plugin that generates
events when you send messages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE::Component::IRC::Plugin::BotTraffic;
\&
\& $irc\->plugin_add( \*(AqBotTraffic\*(Aq, 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 \*(Aq$what\*(Aq on channel $channel\en";
\&     return;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.PP
These events are useful for logging what your bot says.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
No arguments required. Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.SH "OUTPUT EVENTS"
.IX Header "OUTPUT EVENTS"
These are the events generated by the plugin. Both events have \f(CW\*(C`ARG0\*(C'\fR set
to an arrayref of recipients and \f(CW\*(C`ARG1\*(C'\fR the text that was sent.
.ie n .SS """irc_bot_public"""
.el .SS "\f(CWirc_bot_public\fP"
.IX Subsection "irc_bot_public"
\&\f(CW\*(C`ARG0\*(C'\fR will be an arrayref of recipients. \f(CW\*(C`ARG1\*(C'\fR will be the text sent.
.ie n .SS """irc_bot_msg"""
.el .SS "\f(CWirc_bot_msg\fP"
.IX Subsection "irc_bot_msg"
\&\f(CW\*(C`ARG0\*(C'\fR will be an arrayref of recipients. \f(CW\*(C`ARG1\*(C'\fR will be the text sent.
.ie n .SS """irc_bot_action"""
.el .SS "\f(CWirc_bot_action\fP"
.IX Subsection "irc_bot_action"
\&\f(CW\*(C`ARG0\*(C'\fR will be an arrayref of recipients. \f(CW\*(C`ARG1\*(C'\fR will be the text sent.
.ie n .SS """irc_bot_notice"""
.el .SS "\f(CWirc_bot_notice\fP"
.IX Subsection "irc_bot_notice"
\&\f(CW\*(C`ARG0\*(C'\fR will be an arrayref of recipients. \f(CW\*(C`ARG1\*(C'\fR will be the text sent.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams [chris@bingosnet.co.uk]
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Component::IRC