Events

#Events

A list of Events that api.Events emits with data from picarto's servers.

This section is very much WIP and I have not been able to debug all messages. Help is always appreciated

##connected Emitted when connection to Picarto is established successfully. The Bot is ready to read and/or write.

##disconnected Emitted when the bot gets disconnected from Picarto, either because of connection failure or the user closing connection.

Parameters:

"The reason for the disconnect"

##reconnected Emitted when a reconnect attempt was successful and the connection is established again. Does not emit connected event on reconnect. ##reconnect_attempt Emitted when connection has been terminated and there's an attempt at restoring it. ##chatMode /// Still requires debugging ##srvMsg /// Still requires debugging ##channelUsers Sent out on changes of user list

Parameters:

[
	// Contains one of the following objects for each User
	{
		username: '',
        color: '#ffffff',
        mod: false,
        premium: 0,
        admin: false,
        ptvadmin: false,
        banned: false,
        registered: false
	}
]

##userMsg Emitted on every chat message.

Parameters:

{
	username: '',
	msg: '',
	color: '#FFFFFF',
	premium: 0,
	mod: false,
	admin: false,
	subscriber: false,
	ptvadmin: false,
	registered: false,
	id: '31570255b78f735ccb249480'
}

##meMsg /// Still requires debugging ##globalMsg /// Still requires debugging ##clearChat Emitted when a mod clears the chat ##commandHelp /// Still requires debugging ##modToolsVisible /// Still requires debugging ##modList /// Still requires debugging ##whisper Emitted when someone whispers to the bot

Parameters:

{
    username: "",
    msg: "",
    color: "#FFFFFF",
    enableReply: true
}

##color Sent on initial connect with bot's chat color

Parameters:

"#FFFFFF"

##onlineState Sent periodically and gives information about the channel that the bot is connected to.

Parameters:

{
    channel: "",
    viewers: 0
}

##raffleUsers /// Still requires debugging ##wonRaffle /// Still requires debugging ##runPoll /// Still requires debugging ##showPoll /// Still requires debugging ##pollVotes /// Still requires debugging ##voteResponse /// Still requires debugging ##finishPoll /// Still requires debugging ##gameMode /// Still requires debugging ##adultMode /// Still requires debugging ##commissionsAvailable /// Still requires debugging ##clearUser /// Still requires debugging ##removeMsg /// Still requires debugging ##warnAdult /// Still requires debugging ##warnGaming /// Still requires debugging ##warnMovies /// Still requires debugging ##multiStatus /// Still requires debugging

##See also API - The API Object for all plugins