irc-translevel.txt

Lachesis an IRCRPG combat engine written in a combination of C and C++. The combat engine is being w

void ConnectionReady();
	Call to indicate we are connected to and registered on an IRC server.
	Calls Auth_Connect and handles joining our default channel.
void HandleDCCChatRequest(void *, const char *nick);
	Call to indicate we've received a DCC CHAT request. The first
	argument must be unique to each DCC request/connection, but is
	otherwise arbitrary. This function is provided for historical reasons 
	(BotNet only supplied the nick) but may be useful in other interfaces.
void HandleDCCChatRequestPfx(void *, const char *prefix);
	Call to indicate we've received a DCC CHAT request when we have the
	prefix for the request. The native interface should use this function.
void HandleDCCChatOpened(void *);
	Call to indicate a DCC CHAT connection has been established.
	Calls Auth_DCCEstablished.
void HandleDCCChatClosed(void *);
	Call to indicate the DCC CHAT connection was broken or remotely
	terminated. Calls Auth_DCCLost.
void HandleDCCChatMessage(void *, const char *);
	Call to indicate we've received text over a DCC CHAT.
	Calls Auth_DCCMessage.
void HandleNumeric(const int, const char *);
	Call to indicate we've received a numeric that the low-level interface
	isn't handling itself. Note: While we provide for the low-level
	interface to handle USERHOST replies, it's not needed. Passing the
	actual numeric here works, and the native interface does this.
void HandleNotice(const char *prefix, const char *target, const char *);
	Call to indicate we've received a NOTICE. In the event that this
	appears to be a message from NickServ we notify the bot's master.
	Otherwise, these are ignored at present, but may be tied into the
	logging system later.
const char * HandleCTCP(const char *prefix, const char *target, const char *);
	Call to indicate we've received a CTCP command. This function
	responds to CTCP requests, implementing CLIENTINFO, VERSION, USERINFO,
	FINGER, PING, ECHO, and ACTION. In particular, we call Log_Action for
	CTCP ACTION commands that occur in our current channel.
void HandleCTCPReply(const char *prefix, const char *);
	Call to indicate we've received a reply to a CTCP command. At present
	this does not do anything, but may in the future.
void HandleNames(const char *channel, const char **, const int);
	Call to indicate we've received a response to a NAMES command. Since
	we do not send NAMES commands explicitly, this should occur when we
	join channels. (Note to self, check Auth_Track again, see if we handle
	dupes correctly. Since we don't honor a NAMES response to a channel
	we are not in, if dupes are correctly handled then arbitrary NAMES
	commands should not be a problem.)
void HandleName(const char *channel, const char *);
	Similar to HandleName, but only takes a single nick. The low-level
	interface would call this once for each nick in the NAMES reply.
	I think the old BotNet interface used this... or was it the aborted
	EPIC script interface?
void HandleInvite(const char *prefix, const char *);
	Call to indicate we've received an INVITE. At the moment this does
	nothing, but eventually it should have the same effect and 
	restrictions as the DO JOIN command.
void HandleKick(const char *nick, const char *target, const char *channel, const char *);
	Call to indicate someone (possibly us) has been kicked out of a
	channel. If it's us, we destroy all tracking information for that
	channel. If it's someone else, we stop tracking them in that channel.
	Calls either HLIRC_RemChan or Auth_Track.
void HandleMSG(const char *prefix, const char *);
	Call to indicate we've received a PRIVMSG.
	Calls Auth_IRCMessage.
void HandlePublic(const char *prefix, const char *target, const char *);
	Call to indicate we've received a PRIVMSG over a channel.
	Calls Log_Public if we're logging that channel.
void HandleJoined(const char *channel);
	Call to indicate we've been joined to a channel. This sets the new
	channel as current (maybe this shouldn't be done here?) and adds
	the channel to the list of channels we are tracking.
void HandleJoin(const char *prefix, const char *channel);
	Call to indicate we've seen someone join a channel.
	Calls Auth_TrackPr.
void HandleOurNickChanged(const char *nick);
	Call to indicate our nick has changed. At the moment this does nothing.
void HandleNickChange(const char *prefix, const char *nick);
	Call to indicate we've seen someone change nicks.
	Calls Auth_Nick.
void HandlePart(const char *nick, const char *channel, const char *);
	Call to indicate that we've seen someone (possibly us) part from
	IRC. I suppose I really should have made this two different functions
	for consistency... Does the same thing as HandleKick for now.
void HandleQuit(const char *nick, const char *);
	Call to indicate that we've seen someone disconnect from IRC. We
	destroy all tracking info on that nick. Calls Auth_Track.
void HandleDisconnect(const char *, TF flag);
	Call to indicate that we've been disconnected from the IRC server.
	Calls Auth_Disconnect, cleans up all our info on the connection.
	If AUTO_RECONNECT is defined and we weren't actually trying to shut
	down, this should restart the IRC interface also; If not defined, it
	will call Shutdown. If flag is TRUE, this indicates we were trying
	to shut down.
void HandleUserhost(const char *nick, const char *user, const char *host);
	If the low-level IRC interface processes 302 numerics itself, we
	provide this hook for that event, which directly calls Auth_Userhost.
	The old BotNet interface used this, but the native interface uses
	HandleNumeric above.

@(#) $Id: irc-translevel.txt,v 1.1.1.1 2004/01/16 07:28:15 lachesis Exp $