// get the user list for a channel called #magik_bot
var userList = getUserList( "#magik_bot" );

// for each user in the user list output its data to the console
for( var i = 0; i < userList.size(); i++ ) {
    debugStr( "Nick=" + userList[i].nick );
    debugStr( "Prefix=" + userList[i].prefix );
    debugStr( "Voice=" + userList[i].voice );
    debugStr( "Op=" + userList[i].op );
}

// output xml representation of the data to the console
debugStr( userList );

The IRC server that the bot connects to.

This property is empty by default. There are many IRC servers that allow bots, and you probably want to use the server that you normally connect to when using your favorite IRC client application.

Some popular IRC servers are:

Homelan (irc.homelan.com)
FunNet (irc.funnet.org)
Chatster (irc.chatster.org)
GamesNET (west.gamesnet.net)

In order to connect to one of the servers above, you would have to set the server property to its corresponding internet address. For example, to log into the Homelan server set the property value to: irc.homelan.com.

Not all servers allow bots or multiple instances, so it is important to check the rules of the specific server you wish to connect to. Failing to abide by the rules set forth by server administrators can lead to permanent banning on that server.

Disconnects from the server. Providing that the Bot was connected to the server, the receiveDisconnect event will be called as soon as the disconnection is made.

To re-establish a connection with the server once the Bot has been disconnected, you should call the reconnect message.

Returns a StringArray of all the channels the bot is in. To access the the StringArray reference the value as a standard Tekadence Magik array data type.

Example:
This example shows how you can call the getChannelList message and iterate through the list of channels passed back in the return value. Assume that the example is a script that is part of the Bot object we are calling.

var channelList = getChannelList();

for( var i = 0; i < channelList.size(); i++ ) {
    debugStr( channelList[i] ); // do something here with the channel
}

Returns a UserList of all the users in a specific channel. The Bot must be a member of the channel which is being queried in order to return the list of its users.

Example:
This example shows how you can call the getUserList message and iterate through the list of users passed back in the return value. Assume that the example is a script that is part of the Bot object we are calling.

var userList = getUserList( "#magik_bot" );

for( var i = 0; i < userList.size(); i++ ) {
    debugStr( userList[i] ); // do something here with the user
    debugStr( "Nick: " + userList[i].nick );
    debugStr( "Has Op: " + userList[i].op );
    debugStr( "Has Voice: " + userList[i].voice );
}

Joins a channel. If the Bot successfully joins the channel an immediate recieveJoin event will be sent.

Kicks a user off a specific channel, giving a reason. This message will only suceede if the Bot has operator privileges in the channel.

Leaves a channel. If the Bot successfully leaves the channel an immediate recieveLeave event will be sent.

Reconnects to the server. Providing that the Bot was previously connected to a server, the receiveConnect event will be called as soon as the connection is made.

To disconnect from the server once the Bot has been connected, you should call the disconnect message.

Sends an action to the target channel or user. An action is equivalent to using the "/me" command on most IRC servers.

Sends a CTCP (Client To Client Protocol) command to the target channel or user. CTCP commands include: "PING", "FINGER", and "VERSION", and their results will vary depending on the target client software.

Invites a user to join a channel. This is necessary for channels that are specified as "invite only".

Sends a message to the target channel or user.

Example:
This example shows how you can call sendMessage to send a message to both an entire channel, and as a private message to a specific user. Assume that the example is a script that is part of the Bot object we are calling.

// sends a message to the channel #magik_bot
sendMessage( "Hello there channel!", "#magik_bot" );

// sends a message to the user FrizzleFried
sendMessage( "Hi Frizz, you are the only one who can see this.", "FrizzleFried" );

Sends a notice to the target channel or user.

Send a raw line of text to to the server. This is useful if you wish to bypass the built-in messages in the Bot to execute a command on the server, or if the Bot does not have a message that maps to a specific command.

Grants or removes operator privilidges to a user on a specific channel. The Bot must itself have operator privildges on the channel for which it is attempting to set a users operator mode.

Sets the current topic for a channel. The channel may require the Bot to have operator privilidges for the channel it is trying to change, if the topic is protected.

Grants or removes voice privilidges to a user on a specific channel. The Bot must have operator privildges on the channel for which it is attempting to set a users voice mode.

This message is called when an ACTION is sent from a user.

This message is called when the bot connects to the server.

This message is called when the bot disconnects from the server.

This message is called when a user (including us) joins a channel.

This message is called when a user (including us) leaves a channel.

This message is called when the Bot generates a log message.

This message is called when a message is sent to a channel (not including messages sent by us).

receiveNickChange

This message is called when a user (including us) changes their nick.

This message is called when we recieve a notice.

This message is called when a private message is sent to the Bot.

This message is called when we receive a PING request from the server.

This message is called when we recieve a numeric server response.

This message is called when we recieve a user list from the server shortly after joining a channel.