.\" 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::BotAddressed 3pm"
.TH POE::Component::IRC::Plugin::BotAddressed 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::BotAddressed \- A PoCo\-IRC plugin that generates
events when you are addressed
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE::Component::IRC::Plugin::BotAddressed;
\&
\& $irc\->plugin_add( \*(AqBotAddressed\*(Aq, POE::Component::IRC::Plugin::BotAddressed\->new() );
\&
\& sub irc_bot_addressed {
\&     my ($kernel, $heap) = @_[KERNEL, HEAP];
\&     my $nick = ( split /!/, $_[ARG0] )[0];
\&     my $channel = $_[ARG1]\->[0];
\&     my $what = $_[ARG2];
\&
\&     print "$nick addressed me in channel $channel with the message \*(Aq$what\*(Aq\en";
\& }
\&
\& sub irc_bot_mentioned {
\&     my ($nick) = ( split /!/, $_[ARG0] )[0];
\&     my ($channel) = $_[ARG1]\->[0];
\&     my ($what) = $_[ARG2];
\&
\&     print "$nick mentioned my name in channel $channel with the message \*(Aq$what\*(Aq\en";
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::BotAddressed is a
POE::Component::IRC plugin. It watches for public
channel traffic (i.e. \f(CW\*(C`irc_public\*(C'\fR and \f(CW\*(C`irc_ctcp_action\*(C'\fR) and will generate
an \f(CW\*(C`irc_bot_addressed\*(C'\fR, \f(CW\*(C`irc_bot_mentioned\*(C'\fR or \f(CW\*(C`irc_bot_mentioned_action\*(C'\fR
event if its name comes up in channel discussion.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
One optional argument:
.PP
\&\fB'eat'\fR, set to true to make the plugin eat the \f(CW\*(C`irc_public\*(C'\fR /
\&\f(CW\*(C`irc_ctcp_action\*(C'\fR
event and only generate an appropriate event, default is false.
.PP
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"
.ie n .SS """irc_bot_addressed"""
.el .SS "\f(CWirc_bot_addressed\fP"
.IX Subsection "irc_bot_addressed"
Has the same parameters passed as \f(CW\*(C`irc_ctcp_public\*(C'\fR.
\&\f(CW\*(C`ARG2\*(C'\fR contains the message with the addressed nickname removed, ie. Assuming
that your bot is called LameBOT, and someone says 'LameBOT: dance for me',
you will actually get 'dance for me'.
.ie n .SS """irc_bot_mentioned"""
.el .SS "\f(CWirc_bot_mentioned\fP"
.IX Subsection "irc_bot_mentioned"
Has the same parameters passed as \f(CW\*(C`irc_public\*(C'\fR.
.ie n .SS """irc_bot_mentioned_action"""
.el .SS "\f(CWirc_bot_mentioned_action\fP"
.IX Subsection "irc_bot_mentioned_action"
Has the same parameters passed as \f(CW\*(C`irc_ctcp_action\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams <chris@bingosnet.co.uk>