.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::NickReclaim 3pm"
.TH POE::Component::IRC::Plugin::NickReclaim 3pm "2018-01-01" "perl v5.26.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::NickReclaim \- A PoCo\-IRC plugin for reclaiming
your nickname
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use strict;
\& use warnings;
\& use POE qw(Component::IRC Component::IRC::Plugin::NickReclaim);
\&
\& my $nickname = \*(AqFlibble\*(Aq . $$;
\& my $ircname = \*(AqFlibble the Sailor Bot\*(Aq;
\& my $ircserver = \*(Aqirc.blahblahblah.irc\*(Aq;
\& my $port = 6667;
\&
\& my $irc = POE::Component::IRC\->spawn(
\&     nick => $nickname,
\&     server => $ircserver,
\&     port => $port,
\&     ircname => $ircname,
\& ) or die "Oh noooo! $!";
\&
\& POE::Session\->create(
\&     package_states => [
\&         main => [ qw(_start) ],
\&     ],
\& );
\&
\&  $poe_kernel\->run();
\&
\& sub _start {
\&     $irc\->yield( register => \*(Aqall\*(Aq );
\&
\&     # Create and load our NickReclaim plugin, before we connect
\&     $irc\->plugin_add( \*(AqNickReclaim\*(Aq =>
\&         POE::Component::IRC::Plugin::NickReclaim\->new( poll => 30 ) );
\&
\&     $irc\->yield( connect => { } );
\&     return;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::NickReclaim \- A
POE::Component::IRC plugin automagically deals with
your bot's nickname being in use and reclaims it when it becomes available
again.
.PP
It registers and handles 'irc_433' events. On receiving a 433 event it will
reset the nickname to the 'nick' specified with \f(CW\*(C`spawn\*(C'\fR or \f(CW\*(C`connect\*(C'\fR,
appendedwith an underscore, and then poll to try and change it to the
original nickname. If someone in your channel who has the nickname you're
after quits or changes nickname, the plugin will try to reclaim it
immediately.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes one optional argument:
.PP
\&\fB'poll'\fR, the number of seconds between nick change attempts, default is 30;
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams
.PP
With amendments applied by Zoffix Znet
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Component::IRC