X-Chat 2 Perl Interface

Introduction

This is the new Perl interface for X-Chat 2. However, due to changes in xchat's plugin code you will need xchat 2.0.8 or above to load this. Scripts written using the old interface will continue to work. If there are any problems, questions, comments or suggestions please email them to the address on the bottom of this page.

Constants

Xchat::PRI_HIGHEST
Xchat::PRI_HIGH
Xchat::PRI_NORM
Xchat::PRI_LOW
Xchat::PRI_LOWEST

Xchat::EAT_NONE - pass the event along
Xchat::EAT_XCHAT - don't let xchat see this event
Xchat::EAT_PLUGIN - don't let other scripts and plugins see this event but xchat will still see it
Xchat::EAT_ALL - don't let anything else see this event

Xchat::KEEP - keep the timer going or hook watching the handle
Xchat::REMOVE - remove the timer or hook watching the handle

Xchat::FD_READ - invoke the callback when the handle is ready for reading

Xchat::FD_WRITE - invoke the callback when the handle is ready for writing

Xchat::FD_EXCEPTION - invo
<?xml version="1.0" encoding="utf-8"?> <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <ItemGroup Label="ProjectConfigurations"> <ProjectConfiguration Include="Release|Win32"> <Configuration>Release</Configuration> <Platform>Win32</Platform> </ProjectConfiguration> <ProjectConfiguration Include="Release|x64"> <Configuration>Release</Configuration> <Platform>x64</Platform> </ProjectConfiguration> </ItemGroup> <PropertyGroup Label="Globals"> <ProjectGuid>{19C52A0A-A790-409E-A28A-9745FF990F5C}</ProjectGuid> <Keyword>Win32Proj</Keyword> <RootNamespace>python</RootNamespace> </PropertyGroup> <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" /> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration"> <ConfigurationType>DynamicLibrary</ConfigurationType> <UseDebugLibraries>false</UseDebugLibraries> <WholeProgramOptimization>true</WholeProgramOptimization> <CharacterSet>MultiByte</CharacterSet> </PropertyGroup> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration"> <ConfigurationType>DynamicLibrary</ConfigurationType> <UseDebugLibraries>false</UseDebugLibraries> <WholeProgramOptimization>true</WholeProgramOptimization> <CharacterSet>MultiByte</CharacterSet> </PropertyGroup> <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" /> <ImportGroup Label="ExtensionSettings"> </ImportGroup> <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> <Import Project="..\..\win32\hexchat.props" /> </ImportGroup> <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="PropertySheets"> <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> <Import Project="..\..\win32\hexchat.props" /> </ImportGroup> <PropertyGroup Label="UserMacros" /> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> <LinkIncremental>false</LinkIncremental> <TargetName>$(PythonOutput)</TargetName> <OutDir>$(HexChatBin)</OutDir> <IntDir>$(HexChatObj)$(ProjectName)\</IntDir> </PropertyGroup> <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'"> <LinkIncremental>false</LinkIncremental> <TargetName>$(PythonOutput)</TargetName> <OutDir>$(HexChatBin)</OutDir> <IntDir>$(HexChatObj)$(ProjectName)\</IntDir> </PropertyGroup> <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> <ClCompile> <PrecompiledHeader> </PrecompiledHeader> <Optimization>MaxSpeed</Optimization> <FunctionLevelLinking>true</FunctionLevelLinking> <IntrinsicFunctions>true</IntrinsicFunctions> <PreprocessorDefinitions>WIN32;NDEBUG;_WINDOWS;_USRDLL;PYTHON_EXPORTS;$(OwnFlags);%(PreprocessorDefinitions)</PreprocessorDefinitions> <AdditionalIncludeDirectories>$(Glib);$(PythonPath)\include;..;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories> <MultiProcessorCompilation>true</MultiProcessorCompilation> </ClCompile> <Link> <SubSystem>Windows</SubSystem> <GenerateDebugInformation>true</GenerateDebugInformation> <EnableCOMDATFolding>true</EnableCOMDATFolding> <OptimizeReferences>true</OptimizeReferences> <ModuleDefinitionFile>python.def</ModuleDefinitionFile> <AdditionalDependencies>"$(PythonLib).lib";$(DepLibs);%(AdditionalDependencies)</AdditionalDependencies> <AdditionalLibraryDirectories>$(DepsRoot)\lib;$(OutDir);$(PythonPath)\libs;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories> </Link> </ItemDefinitionGroup> <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'"> <ClCompile> <PrecompiledHeader> </PrecompiledHeader> <Optimization>MaxSpeed</Optimization> <FunctionLevelLinking>true</FunctionLevelLinking> <IntrinsicFunctions>true</IntrinsicFunctions> <PreprocessorDefinitions>WIN32;_WIN64;_AMD64_;NDEBUG;_WINDOWS;_USRDLL;PYTHON_EXPORTS;$(OwnFlags);%(PreprocessorDefinitions)</PreprocessorDefinitions> <AdditionalIncludeDirectories>$(Glib);$(PythonPath)\include;..;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories> <MultiProcessorCompilation>true</MultiProcessorCompilation> </ClCompile> <Link> <SubSystem>Windows</SubSystem> <GenerateDebugInformation>true</GenerateDebugInformation> <EnableCOMDATFolding>true</EnableCOMDATFolding> <OptimizeReferences>true</OptimizeReferences> <ModuleDefinitionFile>python.def</ModuleDefinitionFile> <AdditionalDependencies>"$(PythonLib).lib";$(DepLibs);%(AdditionalDependencies)</AdditionalDependencies> <AdditionalLibraryDirectories>$(DepsRoot)\lib;$(OutDir);$(PythonPath)\libs;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories> </Link> </ItemDefinitionGroup> <ItemGroup> <None Include="python.def" /> </ItemGroup> <ItemGroup> <ClCompile Include="python.c" /> </ItemGroup> <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" /> <ImportGroup Label="ExtensionTargets"> </ImportGroup> </Project>
generated by cgit-pink 1.4.1 (git 2.36.1) at 2025-04-20 16:05:11 +0000
at::printf( $format, LIST )

$format - a format string, see "perldoc -f sprintf" for further detail

LIST - list of values for the format fields

Xchat::command( $command | \@commands, [$channel,[$server]] )

$command - the command to execute, without the leading /

\@commands - array reference containing a list of commands to execute

$channel - channel or tab with the given name where $command will be executed

$server - specifies that the command will be executed in a channel or tab that is associated with $server

The first argument can either be a string or an array reference of strings. Either or both of $channel and $server can be undef.

If called as Xchat::command( $command ), it will always return true. If called with either the channel or the channel and the server specified then it will return true if a context is found and false otherwise. The command will not be executed if the context is not found. The meaning of setting $channel or $server to undef is the same as find_context.

Xchat::commandf( $format, LIST )

$format - a format string, see "perldoc -f sprintf" for further detail

LIST - list of values for the format fields

Xchat::find_context( [$channel, [$server]] )

$channel - name of a channel

$server - name of a server

Either or both of $channel and $server can be undef. Calling Xchat::find_context() is the same as calling Xchat::find_context( undef, undef) and Xchat::find_context( $channel ) is the same as Xchat::find_context( $channel, undef ).

If $server is undef, find any channel named $channel. If $channel is undef, find the front most window or tab named $server.If both $channel and $server are undef, find the currently focused tab or window.

Return the context found for one of the above situations or undef if such a context cannot be found.

Xchat::get_context()

Returns the current context.

Xchat::set_context( $context | $channel,[$server] )

$context - context value as returned from get_context,find_context or one of the fields in the list of hashrefs returned by list_get

$channel - name of a channel you want to switch context to

$server - name of a server you want to switch context to

See find_context for more details on $channel and $server.

Returns true on success, false on failure

Xchat::get_info( $id )

$id - one of the following case sensitive values

ID Return value Associated Command(s)

away away reason or undef if you are not away AWAY, BACK

channel current channel name SETTAB

charset character-set used in the current context CHARSET

event_text <Event Name> text event format string for <Event name>
Example:

1

my $channel_msg_format = Xchat::get_info( "event_text Channel Message" );

host real hostname of the current server
id connection id
inputbox contents of the inputbox SETTEXT
libdirfs the system wide directory where xchat will look for plugins. this string is in the same encoding as the local file system
modes the current channels modes or undef if not known MODE
network current network name or undef, this value is taken from the Network List
nick current nick NICK
nickserv nickserv password for this network or undef, this value is taken from the Network List
server current server name
(what the server claims to be) undef if not connected
state_cursor current inputbox cursor position in characters SETCURSOR
topic current channel topic TOPIC
version xchat version number
win_status status of the xchat window, possible values are "active", "hidden" and "normal" GUI
win_ptr native window pointer, GtkWindow * on Unix, HWND on Win32.
On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object.
Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects.
See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box.

gtkwin_ptr similar to win_ptr except it will always be a GtkWindow *

xchatdir xchat config directory encoded in UTF-8
examples:
/home/user/.xchat2
C:\Documents and Settings\user\Application Data\X-Chat 2
xchatdirfs same as xchatdir except encoded in the locale file system encoding

This function is used to retrieve certain information about the current context. If there is an associated command then that command can be used to change the value for a particular ID.

Xchat::get_prefs( $name )

$name - name of a X-Chat setting (available through the /set command)

This function provides a way to retrieve X-Chat's setting information.

Returns undef if there is no setting called called $name.

Xchat::emit_print( $event, LIST )

$event - name from the Event column in Settings->Advanced->Text Events

LIST - this depends on the Description column on the bottom of Settings->Advanced->Text Events

This functions is used to generate one of the events listed under Settings->Advanced->Text Events

Note: when using this function you MUST return Xchat::EAT_ALL otherwise you will end up with duplicate events. One is the original and the second is the one you emit.

Returns true on success, false on failure

Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )

$target - a single nick to set the mode on

\@targets - an array reference of the nicks to set the mode on

$sign - the mode sign, either '+' or '-'

$mode - the mode character such as 'o' and 'v', this can only be one character long

$modes_per_line - an optional argument maximum number of modes to send per at once, pass 0 use the current server's maximum (default)

Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn't fit on one.

Example:

1

2

3

4

5

6

7

8

9

10

11

12

13

14

use strict; use warning; use Xchat qw(:all); hook_command( "MODES", sub { my (undef, $who, $sign, $mode) = @{$_[0]}; my @targets = split /,/, $who; if( @targets > 1 ) { send_modes( \@targets, $sign, $mode, 1 ); } else { send_modes( $who, $sign, $mode ); } return EAT_XCHAT; });

Xchat::nickcmp( $nick1, $nick2 )

$nick1, $nick2 - the two nicks or channel names that are to be compared

The comparsion is based on the current server. Either a RFC1459 compliant string compare or plain ascii will be using depending on the server. The comparison is case insensitive.

Returns a number less than, equal to or greater than zero if $nick1 is found respectively, to be less than, to match, or be greater than $nick2.

Xchat::get_list( $name )

$name - name of the list, one of the following: "channels", "dcc", "ignore", "notify", "users"

This function will return a list of hash references. The hash references will have different keys depend on the list. An empty list is returned if there is no such list.

"channels" - list of channels, querys and their server

Key Description

channel tab name

chantypes channel types supported by the server, typically "#&"

context can be used with set_context

flags Server Bits:
0 - Connected
1 - Connecting
2 - Away
3 - EndOfMotd(Login complete)
4 - Has WHOX
5 - Has IDMSG (FreeNode)

The following correspond to the /chanopt command
6 - Hide Join/Part Message (text_hidejoinpart)
7 - unused (was for color paste)
8 - Beep on message (alert_beep)
9 - Blink Tray (alert_tray)
10 - Blink Task Bar (alert_taskbar)

Example of checking if the current context has Hide Join/Part messages set:

1

2

3

if( Xchat::context_info->{flags} & (1 << 6) ) { Xchat::print( "Hide Join/Part messages is enabled" ); }

id Unique server ID

lag lag in milliseconds

maxmodes Maximum modes per line

network network name to which this channel belongs

nickprefixes Nickname prefixes e.g. "+@"

nickmodes Nickname mode chars e.g. "vo"

queue number of bytes in the send queue

server server name to which this channel belongs

type the type of this context
1 - server
2 - channel
3 - dialog
4 - notices
5 - server notices

users Number of users in this channel

"dcc" - list of DCC file transfers

Key Value

address32 address of the remote user(ipv4 address)

cps bytes per second(speed)

destfile destination full pathname

file file name

nick nick of the person this DCC connection is connected to

port TCP port number

pos bytes sent/received

poshigh bytes sent/received, high order 32 bits

resume point at which this file was resumed
(zero if it was not resumed)

resumehigh point at which this file was resumed, high order 32 bits

size file size in bytes low order 32 bits

sizehigh file size in bytes, high order 32 bits (when the files is > 4GB)

status DCC Status:
0 - queued
1 - active
2 - failed
3 - done
4 - connecting
5 - aborted

type DCC Type:
0 - send
1 - receive
2 - chatrecv
3 - chatsend
"ignore" - current ignore list

Key Value

mask ignore mask. e.g: *!*@*.aol.com

flags Bit field of flags.
0 - private
1 - notice
2 - channel
3 - ctcp
4 - invite
5 - unignore
6 - nosave
7 - dcc

"notify" - list of people on notify

Key Value

networks comma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to

nick nickname

flags 0 = is online

on time when user came online

off time when user went offline

seen time when user was last verified still online

the values indexed by on, off and seen can be passed to localtime and gmtime, see perldoc -f localtime and perldoc -f gmtime for more detail
"users" - list of users in the current channel

Key Value

away away status(boolean)

lasttalk last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)

nick nick name

host host name in the form: user@host or undef if not known

prefix prefix character, .e.g: @ or +

realname Real name or undef

selected selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks

"networks" - list of networks and the associated settings from network list

Key Value

autojoins An object with the following methods:

Method Description

channels() returns a list of this networks' autojoin channels in list context, a count of the number autojoin channels in scalar context

keys() returns a list of the keys to go with the channels, the order is the same as the channels, if a channel doesn't have a key, '' will be returned in it's place

pairs() a combination of channels() and keys(), returns a list of (channels, keys) pairs. This can be assigned to a hash for a mapping from channel to key.

as_hash() return the pairs as a hash reference

as_string() the original string that was used to construct this autojoin object, this can be used with the JOIN command to join all the channels in the autojoin list

as_array() return an array reference of hash references consisting of the keys "channel" and "key"

as_bool() returns true if the network has autojoins and false otherwise

connect_commands An array reference containing the connect commands for a network. An empty array if there aren't any

encoding the encoding for the network

flags a hash reference corresponding to the checkboxes in the network edit window

allow_invalid true if "Accept invalid SSL certificate" is checked

autoconnect true if "Auto connect to this network at startup" is checked

cycle true if "Connect to selected server only" is NOT checked

use_global true if "Use global user information" is checked

use_proxy true if "Bypass proxy server" is NOT checked

use_ssl true if "Use SSL for all the servers on this network" is checked

irc_nick1 Corresponds with the "Nick name" field in the network edit window

irc_nick2 Corresponds with the "Second choice" field in the network edit window

irc_real_name Corresponds with the "Real name" field in the network edit window

irc_user_name Corresponds with the "User name" field in the network edit window

network Name of the network

nickserv_password Corresponds with the "Nickserv password" field in the network edit window

selected Index into the list of servers in the "servers" key, this is used if the "cycle" flag is false

server_password Corresponds with the "Server password" field in the network edit window

servers An array reference of hash references with a "host" and "port" key. If a port is not specified then 6667 will be used.

Xchat::user_info( [$nick] )

$nick - the nick to look for, if this is not given your own nick will be used as default

This function is mainly intended to be used as a shortcut for when you need to retrieve some information about only one user in a channel. Otherwise it is better to use get_list. If $nick is found a hash reference containing the same keys as those in the "users" list of get_list is returned otherwise undef is returned. Since it relies on get_list this function can only be used in a channel context.

Xchat::context_info( [$context] )

$context - context returned from get_context, find_context and get_list, this is the context that you want infomation about. If this is omitted, it will default to current context.

This function will return the information normally retrieved with get_info, except this is for the context that is passed in. The information will be returned in the form of a hash. The keys of the hash are the $id you would normally supply to get_info as well as all the keys that are valid for the items in the "channels" list from get_list. Use of this function is more efficient than calling get_list( "channels" ) and searching through the result.

Example:

1

2

3

4

5

6

7

8

9

10

11

use strict; use warnings; use Xchat qw(:all); # imports all the functions documented on this page register( "User Count", "0.1", "Print out the number of users on the current channel" ); hook_command( "UCOUNT", \&display_count ); sub display_count { prnt "There are " . context_info()->{users} . " users in this channel."; return EAT_XCHAT; }

Xchat::strip_code( $string )

$string - string to remove codes from

This function will remove bold, color, beep, reset, reverse and underline codes from $string. It will also remove ANSI escape codes which might get used by certain terminal based clients. If it is called in void context $string will be modified otherwise a modified copy of $string is returned.

Examples

Asynchronous DNS resolution with hook_fd

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

use strict; use warnings; use Xchat qw(:all); use Net::DNS; hook_command( "BGDNS", sub { my $host = $_[0][1]; my $resolver = Net::DNS::Resolver->new; my $sock = $resolver->bgsend( $host ); hook_fd( $sock, sub { my $ready_sock = $_[0]; my $packet = $resolver->bgread( $ready_sock ); if( $packet->authority && (my @answers = $packet->answer ) ) { if( @answers ) { prnt "$host:"; my $padding = " " x (length( $host ) + 2); for my $answer ( @answers ) { prnt $padding . $answer->rdatastr . ' ' . $answer->type; } } } else { prnt "Unable to resolve $host"; } return REMOVE; }, { flags => FD_READ, }); return EAT_XCHAT; });

Contact Information

Contact Lian Wan Situ at <atmcmnky [at] yahoo.com> for questions, comments and corrections about this page or the Perl plugin itself. You can also find me in #xchat on FreeNode under the nick Khisanth.

X-Chat 2 Perl Interface

`Xchat::command( $command | \@commands, [$channel,[$server]] )`

`Xchat::commandf( $format, LIST )`

`Xchat::find_context( [$channel, [$server]] )`

`Xchat::get_context()`

`Xchat::set_context( $context | $channel,[$server] )`

`Xchat::get_info( $id )`

`Xchat::get_prefs( $name )`

`Xchat::emit_print( $event, LIST )`

`Xchat::send_modes( $target | \@targets, $sign, $mode, [ $modes_per_line ] )`

`Xchat::nickcmp( $nick1, $nick2 )`

`Xchat::get_list( $name )`

`Xchat::user_info( [$nick] )`

`Xchat::context_info( [$context] )`

`Xchat::strip_code( $string )`

Examples

Asynchronous DNS resolution with hook_fd

Contact Information

X-Chat 2 Perl Interface

Introduction

Constants

Priorities

Return values

Timer and fd hooks

hook_fd flags

ID	Return value	Associated Command(s)
away	away reason or undef if you are not away	AWAY, BACK
channel	current channel name	SETTAB
charset	character-set used in the current context	CHARSET
event_text <Event Name>	text event format string for <Event name> Example: 1 my $channel_msg_format = Xchat::get_info( "event_text Channel Message" );
host	real hostname of the current server
id	connection id
inputbox	contents of the inputbox	SETTEXT
libdirfs	the system wide directory where xchat will look for plugins. this string is in the same encoding as the local file system
modes	the current channels modes or undef if not known	MODE
network	current network name or undef, this value is taken from the Network List
nick	current nick	NICK
nickserv	nickserv password for this network or undef, this value is taken from the Network List
server	current server name (what the server claims to be) undef if not connected
state_cursor	current inputbox cursor position in characters	SETCURSOR
topic	current channel topic	TOPIC
version	xchat version number
win_status	status of the xchat window, possible values are "active", "hidden" and "normal"	GUI
win_ptr	native window pointer, GtkWindow * on Unix, HWND on Win32. On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( "win_ptr" ) ); to get a Gtk2::Window object. Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects. See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box.
gtkwin_ptr	similar to win_ptr except it will always be a GtkWindow *
xchatdir	xchat config directory encoded in UTF-8 examples: /home/user/.xchat2 C:\Documents and Settings\user\Application Data\X-Chat 2
xchatdirfs	same as xchatdir except encoded in the locale file system encoding

Key	Description
channel	tab name
chantypes	channel types supported by the server, typically "#&"
context	can be used with set_context
flags	Server Bits: 0 - Connected 1 - Connecting 2 - Away 3 - EndOfMotd(Login complete) 4 - Has WHOX 5 - Has IDMSG (FreeNode) The following correspond to the /chanopt command 6 - Hide Join/Part Message (text_hidejoinpart) 7 - unused (was for color paste) 8 - Beep on message (alert_beep) 9 - Blink Tray (alert_tray) 10 - Blink Task Bar (alert_taskbar) Example of checking if the current context has Hide Join/Part messages set: 1 2 3 if( Xchat::context_info->{flags} & (1 << 6) ) { Xchat::print( "Hide Join/Part messages is enabled" ); }
id	Unique server ID
lag	lag in milliseconds
maxmodes	Maximum modes per line
network	network name to which this channel belongs
nickprefixes	Nickname prefixes e.g. "+@"
nickmodes	Nickname mode chars e.g. "vo"
queue	number of bytes in the send queue
server	server name to which this channel belongs
type	the type of this context 1 - server 2 - channel 3 - dialog 4 - notices 5 - server notices
users	Number of users in this channel

Key	Value
address32	address of the remote user(ipv4 address)
cps	bytes per second(speed)
destfile	destination full pathname
file	file name
nick	nick of the person this DCC connection is connected to
port	TCP port number
pos	bytes sent/received
poshigh	bytes sent/received, high order 32 bits
resume	point at which this file was resumed (zero if it was not resumed)
resumehigh	point at which this file was resumed, high order 32 bits
size	file size in bytes low order 32 bits
sizehigh	file size in bytes, high order 32 bits (when the files is > 4GB)
status	DCC Status: 0 - queued 1 - active 2 - failed 3 - done 4 - connecting 5 - aborted
type	DCC Type: 0 - send 1 - receive 2 - chatrecv 3 - chatsend

Key	Value
mask	ignore mask. e.g: !@*.aol.com
flags	Bit field of flags. 0 - private 1 - notice 2 - channel 3 - ctcp 4 - invite 5 - unignore 6 - nosave 7 - dcc

Key	Value
networks	comma separated list of networks where you will be notfified about this user's online/offline status or undef if you will be notificed on every network you are connected to
nick	nickname
flags	0 = is online
on	time when user came online
off	time when user went offline
seen	time when user was last verified still online

Key	Value
away	away status(boolean)
lasttalk	last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS)
nick	nick name
host	host name in the form: user@host or undef if not known
prefix	prefix character, .e.g: @ or +
realname	Real name or undef
selected	selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks