From IRCBotWiki

Contents 1 IRCBot API Functions in BOTAPI_DEF 1.1 Version Functions 1.2 IRC Functions 1.3 Socket Functions 1.4 Configuration Functions 1.5 Sound Server Functions 1.6 Misc Functions 1.7 DEPRECATED Functions That No Longer Exist In IRCBot v3

IRCBot API Functions in BOTAPI_DEF

Version Functions

uint32 GetVersion()

char * GetVersionString()

IRC Functions

char * GetBotNick(int net)

bool IsNetworkReady(int num)

bool LogToChan(char * buf)

int NumNetworks()

int SendIRC(int netno, char * buf, size_t datalen)

Socket Functions

void ClearSockEntries(T_SOCKET * sock)

void SendRemoteReply(T_SOCKET * socket, REMOTE_HEADER * rHead, char * data)

int SendSock(T_SOCKET * sock, char * buf, size_t datalen)

Configuration Functions

DS_CONFIG_SECTION * GetConfigSection(DS_CONFIG_SECTION * parent, char * name)

long GetConfigSectionLong(DS_CONFIG_SECTION * section, char * name)

char * GetConfigSectionValue(DS_CONFIG_SECTION * section, char * name)

bool GetConfigSectionValueBuf(DS_CONFIG_SECTION * section, char * name, char * buf, unsigned long bufSize)

Sound Server Functions

void EnableRequests(bool activate)

int GetSSInfo(int ssnum, API_SS * ss)

STATS * GetStreamInfo()

Misc Functions

API_commands * commands (functions related to the new commands/triggers system)

API_textfunc * textfunc (pointer to a few handy text functions)

API_db * db (pointer to IRCBot DB functions)

PLUGIN_PUBLIC * GetPlugin(int plugnum)

IRCBOT_UI * GetUI()

int GetUserLevel(char * hostmask, char * pass)

char * GetUserPass(char * nick)

void ib_printf(char * fmt, ...)

bool LoadMessage(char * name, char * msgbuf, long bufSize)

int NumPlugins()

void ProcText(char * text, long bufsize)

void safe_sleep_seconds(int sleepfor) DEPRECATING

void safe_sleep_milli(int sleepfor) DEPRECATING

int SendMessage(int toplug, unsigned int MsgID, void * data, long datalen)

DEPRECATED Functions That No Longer Exist In IRCBot v3

char * GetBotNick() (replaced with GetBotNick(-1))

char * GetParameter(int num)

void PushMessage(unsigned int MsgID, void * data, unsigned int datalen) (replaced by SendMessage)

void * PopMessage(unsigned int MsgID) (replaced by SendMessage)

void MessageFreeData(void * data) (replaced by SendMessage)

void safe_sleep(int sleepfor, bool inmilli) (this is still provided by the Drift Standard Libraries)

int SendSock(int netno, char * buf, long datalen) (replaced with SendIRC)

IRCBot v • d • e
IRCBot main pages
Main Page • Installation • Changelog • Commands • Plugins • FAQ • Configuration• Credits • Remote Client • Buffered Send • Built-In Variables • Multi Sound Server Mode
Auto DJ Pages
Auto DJ Main Page • WebRequest System • Scheduler • MP3 Encoder • Voice Support • MySQL Plugin
IRCBot Programming v • d • e
IRCBot Programming
Plugin API • IPC Messages • Remote Commands • Plugin Initialization • IRCBot DB
Plugin API Functions (in Basic and Full)
ClearSockEntries • ib_printf • GetBotNick • GetConfigSection • GetConfigSectionLong • GetConfigSectionValue • GetConfigSectionValueBuf • GetPlugin • GetUI • GetUserLevel • GetUserPass • GetVersion • GetVersionString • IsNetworkReady • LoadMessage • LogToChan • NumNetworks • NumPlugins • ProcText • safe_sleep_seconds • safe_sleep_milli • SendIRC • SendMessage • SendRemoteReply • SendSock
Plugin API Functions (in Full only)
EnableRequests • GetSSInfo • GetStreamInfo
Tcl Functions
Tcl Scripting • Tcl Events
Plugin API Structures
API_commands • API_db • API_textfunc • API_SS • IRCBOT_UI • PLUGIN_PUBLIC • STATS • T_SOCKET All structure references on this site are here as an aid and to give an idea of bot usage and may change drastically with IRCBot versions. Each copy of plugins.h is tied to a specific version of the bot, and other versions of structures may not be interchanged.