.\" 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 "Net::Hotline::User 3pm"
.TH Net::Hotline::User 3pm "2021-01-09" "perl v5.32.0" "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"
Net::Hotline::User \- User object used internally by Net::Hotline::Client
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::Hotline::User;
\&
\&    $user = new Net::Hotline::User;
\&    $user\->nick("joe blow");
\&    $user\->icon(128);
\&
\&    print "Nick: ", $user\->nick(), "\en";
\&    ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::Hotline::User is a simple class for storing and retrieving user
information,  You should never have to create your own Net::Hotline::User
objects when using Net::Hotline::Client.  Getting and setting attributes is all
that should be necessary.
.SH "CONSTRUCTION"
.IX Header "CONSTRUCTION"
.IP "new \s-1SOCKET, NICK, LOGIN, ICON, COLOR\s0" 4
.IX Item "new SOCKET, NICK, LOGIN, ICON, COLOR"
With no arguments, creates a new Net::Hotline::User object with all attributes
set to undef. The other option is to supply exactly 5 arguments as listed
above.
.SH "METHODS"
.IX Header "METHODS"
All the Net::Hotline::User methods are simple attribute get/set routines.
If given an argument, they set an attribute.  In all cases, they
return the current value of the attribute.
.IP "color \s-1NUMBER\s0" 4
.IX Item "color NUMBER"
The color of the user in the userlist.  Values are numbers from 0 to 3. The
hash \s-1HTLC_COLORS\s0 defined in Net::Hotline::Constants contains number to name
color mappings (i.e. \f(CW$HTLC_COLORS\fR{2} is \*(L"red\*(R").  Example:
.Sp
.Vb 3
\&        use Net::Hotline::Constants qw(HTLC_COLORS);
\&        ...
\&        print $user\->nick(), " is ", $HTLC_COLORS{$user\->color()}, "\en";
.Ve
.IP "icon \s-1NUMBER\s0" 4
.IX Item "icon NUMBER"
The user's icon number.  Negative values are accepted.
.IP "info \s-1TEXT\s0" 4
.IX Item "info TEXT"
User information as a block of \*(L"pretty-formatted\*(R" text.
.IP "login \s-1TEXT\s0" 4
.IX Item "login TEXT"
The user's login name.
.IP "nick \s-1TEXT\s0" 4
.IX Item "nick TEXT"
The user's nickname in the userlist.
.IP "socket \s-1NUMBER\s0" 4
.IX Item "socket NUMBER"
The user's unique socket number.  User's are assigned a socket number
whenthey connect to a Hotline server.
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Siracusa (siracusa@mindspring.com)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright(c) 1999 by John Siracusa.  All rights reserved.  This program is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.