Return to Commands CVS log

Up to [local] / botnow

Initial revision

Output
========

putserv BOT TEXT

Sends text to the IRC server. Returns nothing.

Bind
========

bind TYPE FLAGS MASK PROC

Binds perl procedures to events. Currently flags and mask are ignored. Returns the name of the command that was added.

1. MSG

bind "MSG" FLAGS COMMAND PROC
procname BOT NICK USERHOST HANDLE TEXT

Called on /msg commands. The first word of the msg is the command, and the rest
the text.

bind("msg", "", "admin", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $text) = @_;
  ...
}

2. PUB

bind "PUB" FLAGS COMMAND PROC
procname BOT NICK USERHOST HANDLE CHANNEL TEXT

bind("pub", "", "help", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $chan, $text) = @_;
  ...
}

Called on commands in a channel. The first word of the msg is the command, and the rest
the text.

3. MSGM (stackable)

bind "MSGM" FLAGS MASK PROC
procname BOT NICK USERHOST HANDLE TEXT

bind("msgm", "", "", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $text) = @_;
  ...
}

Match all text from a /msg. MSGM binds are processed before MSG binds.

4. PUBM (stackable)

bind "PUBM" FLAGS MASK PROC
procname BOT NICK USERHOST HANDLE CHAN TEXT

bind("pubm", "", "", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $chan, $text) = @_;
  ...
}

Match all text from a message on a channel. PUBM binds are processed before PUB binds.

5. NOTC (stackable)

bind "NOTC" FLAGS MASK PROC
procname BOT NICK USERHOST HANDLE TEXT DEST

bind("notc", "", "", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $text, $dest) = @_;
  ...
}

Called when a notice is sent. $dest is either the bot's nickname or channel.
You should not respond to a /notice, so this is useful for logging and analytics.

6. JOIN (stackable)

bind "JOIN" FLAGS MASK PROC
procname BOT NICK USERHOST HANDLE CHANNEL

bind("join", "", "", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $chan) = @_;
  ...
}

Called when someone joins a channel.

7. PART (stackable)

bind "PART" FLAGS MASK PROC
procname BOT NICK USERHOST HANDLE CHANNEL TEXT

bind("part", "", "", $proc);
sub proc {
  my ($bot, $nick, $userhost, $hand, $chan, $text) = @_;
  ...
}

Called when someone parts a channel.