Events

Name: onannouncereceived
Type: function
Return type: bool
Argument 1 type: function

// fires after announce text is displayed

Events.onannouncereceived(function (roomobj, text)
{

});

Name: onannouncereceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before announce text is displayed

Events.onannouncereceiving(function (roomobj, text)
{
    return text;
});

Name: oncommandsending
Type: function
Return type: bool
Argument 1 type: function

// fires before a command is sent

Events.oncommandsending(function (roomobj, text)
{
    return text;
});

Name: onconnected
Type: function
Return type: bool
Argument 1 type: function

// fires after you connect to a room

Events.onconnected(function (roomobj)
{

});

Name: onconnecting
Type: function
Return type: bool
Argument 1 type: function

// fires before you connect to a room

Events.onconnecting(function (roomobj)
{

});

Name: oncustomdatareceived
Type: function
Return type: bool
Argument 1 type: function

// fires after you receive custom data

Events.oncustomdatareceived(function (roomobj, userobj, ident, data)
{

});

Name: ondisconnected
Type: function
Return type: bool
Argument 1 type: function

// fires after you lose connection to a room

Events.ondisconnected(function (roomobj)
{

});

Name: onemotereceived
Type: function
Return type: bool
Argument 1 type: function

// fires after emote text has been displayed

Events.onemotereceived(function (roomobj, userobj, text)
{

});

Name: onemotereceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before emote text has been displayed

Events.onemotereceiving(function (roomobj, userobj, text)
{
    return text;
});

Name: onemotesending
Type: function
Return type: bool
Argument 1 type: function

// fires before emote text is sent

Events.onemotesending(function (roomobj, text)
{
    return text;
});

Name: onerror
Type: function
Return type: bool
Argument 1 type: function

// fires after a script error has occurred

Events.onerror(function (scriptName, lineNumber, errorMessage)
{

});

Name: onhtmlreceived
Type: function
Return type: bool
Argument 1 type: function

// fires after an unhandled HTML packet is received

Events.onhtmlreceived(function (roomobj, html)
{

});

Name: onlinkclicked
Type: function
Return type: bool
Argument 1 type: function

// fires when you click a link

Events.onlinkclicked(function (roomobj, url)
{
    return true;
});

Name: onload
Type: function
Return type: bool
Argument 1 type: function

// fires after a script loads

Events.onload(function ()
{

});

Name: onnudgereceiving
Type: function
Return type: bool
Argument 1 type: function

// fires when a nudge is received

Events.onnudgereceiving(function (roomobj, userobj)
{
    return true;
});

Name: onpmreceived
Type: function
Return type: bool
Argument 1 type: function

// fires after a private message is displayed

Events.onpmreceived(function (roomobj, userobj, text)
{

});

Name: onpmreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a private message is displayed

Events.onpmreceiving(function (roomobj, userobj, text)
{
    return text;
});

Name: onpmsending
Type: function
Return type: bool
Argument 1 type: function

// fires before a private message is sent

Events.onpmsending(function (roomobj, userobj, text)
{
    return text;
});

Name: onredirecting
Type: function
Return type: bool
Argument 1 type: function

// fires before you are redirected to another room

Events.onredirecting(function (roomobj, nextRoom)
{
    return true;
});

Name: onroomclosed
Type: function
Return type: bool
Argument 1 type: function

// fires when you have left a room

Events.onroomclosed(function (roomobj)
{

});

Name: onroomopened
Type: function
Return type: bool
Argument 1 type: function

// fires when you have joined a room

Events.onroomopened(function (roomobj)
{

});

Name: onscreencallback
Type: function
Return type: bool
Argument 1 type: function

// fires when you use the "cb0t.callback(ident, text)" function from
// within the chat screen's javascript engine

Events.onscreencallback(function (roomobj, ident, text)
{

});

Name: onscribblereceived
Type: function
Return type: bool
Argument 1 type: function

// fires after a scribble is displayed

Events.onscribblereceived(function (roomobj, userobj)
{

});

Name: onscribblereceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a scribble is displayed

Events.onscribblereceiving(function (roomobj, userobj)
{
    return true;
});

Name: onsongchanged
Type: function
Return type: bool
Argument 1 type: function

// fires when you listen to a different song

Events.onsongchanged(function (songName, playerType)
{
    /*
        player types:
            1 = Internal
            2 = Windows Media Player
            3 = VLC
            4 = Winamp
            5 = Foobar
            6 = iTunes
    */
});

Name: ontextsending
Type: function
Return type: bool
Argument 1 type: function

// fires before you send regular text

Events.ontextsending(function (roomobj, text)
{
    return text;
});

Name: ontextreceived
Type: function
Return type: bool
Argument 1 type: function

// fires after regular text is displayed

Events.ontextreceived(function (roomobj, userobj, text)
{

});

Name: ontextreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before regular text is displayed

Events.ontextreceiving(function (roomobj, userobj, text)
{
    return text;
});

Name: ontimer
Type: function
Return type: bool
Argument 1 type: function

// fires once per second

Events.ontimer(function ()
{

});

Name: ontopicreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a topic is updated

Events.ontopicreceiving(function (roomobj, text)
{
    return text;
});

Name: onuiselected
Type: function
Return type: bool
Argument 1 type: function

// fires when your script UI is selected in settings

Events.onuiselected(function ()
{

});

Name: onurlreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a URL tag is updated

Events.onurlreceiving(function (roomobj, text, url)
{
    return text;
});

Name: onuseravatarreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a user's avatar is updated

Events.onuseravatarreceiving(function (roomobj, userobj)
{
    return true;
});

Name: onuserfontchanging
Type: function
Return type: bool
Argument 1 type: function

// fires before a user's custom font is updated

Events.onuserfontchanging(function (roomobj, userobj, font)
{
    return true;
});

Name: onuserjoined
Type: function
Return type: bool
Argument 1 type: function

// fires after a user has joined

Events.onuserjoined(function (roomobj, userobj)
{

});

Name: onuserjoining
Type: function
Return type: bool
Argument 1 type: function

// fires before a user has joined

Events.onuserjoining(function (roomobj, userobj)
{
    return true;
});

Name: onuserlevelchanged
Type: function
Return type: bool
Argument 1 type: function

// fires when a user's admin level has changed

Events.onuserlevelchanged(function (roomobj, userobj)
{

});

Name: onuserlistreceived
Type: function
Return type: bool
Argument 1 type: function

// fires when the user list has been received

Events.onuserlistreceived(function (roomobj)
{

});

Name: onusermessagereceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a user's personal message has updated

Events.onusermessagereceiving(function (roomobj, userobj, text)
{
    return true;
});

Name: onuseronlinestatuschanged
Type: function
Return type: bool
Argument 1 type: function

// fires when a user's online status has changed

Events.onuseronlinestatuschanged(function (roomobj, userobj)
{

});

Name: onuserparted
Type: function
Return type: bool
Argument 1 type: function

// fires after a user has parted

Events.onuserparted(function (roomobj, userobj)
{

});

Name: onuserparting
Type: function
Return type: bool
Argument 1 type: function

// fires before a user has parted

Events.onuserparting(function (roomobj, userobj)
{
    return true;
});

Name: onuserwritingstatuschanged
Type: function
Return type: bool
Argument 1 type: function

// fires when a user's writing status has changed

Events.onuserwritingstatuschanged(function (roomobj, userobj)
{

});

Name: onvoiceclipreceived
Type: function
Return type: bool
Argument 1 type: function

// fires after a voice clip has been received

Events.onvoiceclipreceived(function (roomobj, userobj)
{

});

Name: onvoiceclipreceiving
Type: function
Return type: bool
Argument 1 type: function

// fires before a voice clip has been received

Events.onvoiceclipreceiving(function (roomobj, userobj)
{
    return true;
});

Last edited Jun 24, 2014 at 9:52 AM by oobenoob, version 11