bitbot-3.11-fork/EVENTS.md

# Events
Below is a list of each event that is propagated through BitBot and the keyword arguments (and their types!) that come with them.

## Newly created objects
#### new.user
> user (IRCUser), server (IRCServer)
#### new.channel
> channel (IRCChannel), server (IRCServer)
#### new.server
> server (IRCServer)


## Default events
#### raw.[command]
> server (IRCServer), last (string), prefix (IRCPrefix), args (string[]), arbitrary (string), tags (dict)
#### received.numeric.[numeric]
> line (string), server (IRCServer), tags (dict), last (string), line_split (string[]), number (string)
#### received.[command]
> line (string), line_split (string[]), command (string), server (IRCServer), tags (dict), last (string)

## RPL_ISUPPORT
#### received.numeric.005
> isupport (string), server (IRCServer)

## Channel topics
#### received.numeric.332
> channel (IRCChannel), server (IRCServer), topic (string)
#### received.numeric.333
> channel (IRCChannel), setter (string), set_at (int), server (IRCServer)
#### received.topic
> channel (IRCChannel), server (IRCServer), topic (string), user (IRCUser)

## User activity in a channel
#### received.join
> channel (IRCChannel), user (IRCUser), server (IRCServer), account (string), realname (string)
#### received.part
> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)
#### received.kick
> channel (IRCChannel), reason (string), target_user (IRCUser), user (IRCUser), server (IRCServer)
#### received.quit
> reason (string), user (IRCUser), server (IRCServer)
#### received.invite
> user (IRCUser), target_channel (string), server (IRCServer), target_user (IRCUser)
#### self.join
> channel (IRCChannel), server (IRCServer), account (string), realname (string)
#### self.part
> channel (IRCChannel), reason (string), server (IRCServer)
#### self.kick
> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)

## NICK
#### self.nick
> server (IRCServer), new_nickname (string), old_nickname (string)
#### received.nick
> new_nickname (string), old_nickname (string), user (IRCUser), server (IRCServer)

## Channel/user modes
#### self.mode
> modes, server (IRCServer)
#### received.mode.channel
> modes, mode_args, channel (IRCChannel), server (IRCServer), user (IRCUser)

## IRCv3
#### received.cap.ls
> server (IRCServer), capabilities (dict)
#### received.cap.new 
> server (IRCServer), capabilities (dict)
#### received.cap.del
> server (IRCServer), capabilities (dict)
#### received.cap.ack
> server (IRCServer), capabilities (dict)
#### received.authenticate
> message (string), server (IRCServer)
#### received.tagmsg.channel
> channel (IRCChannel), user (IRCUser), tags (dict), server (IRCServer)
#### received.tagmsg.private
> user (IRCUser), tags (dict), server (IRCServer)
#### received.away.on
> user (IRCUser), server (IRCServer), message (string)
#### received.away.off
> user (IRCUser), server (IRCServer)
#### received.account.login
> user (IRCUser), server (IRCServer), account (string)
#### received.account.logout
> user (IRCUser), server (IRCServer)

## PRIVMSG (private/channel)
#### received.message.channel
> user (IRCUser), channel (IRCChannel), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)
#### received.message.private
> user (IRCUser), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)
#### self.message.channel
> message (string), message_split (string[]), channel (IRCChannel), action (bool), server (IRCServer)
#### self.message.private
> message (string), message_split (string[]), user (IRCUser), action (bool), server (IRCServer)

## NOTICE (private/channel/server)
#### received.server-notice
> message (string), message_split (string[]), server (IRCServer)
#### received.notice.channel
> message (string), message_split (string[]), user (IRCUser), server (IRCServer), channel (IRCChannel), tags (dict)
#### received.notice.private
> message (string), message_split (string[]), user (IRCUser), server (IRCServer), tags (dict)

## !commands
#### preprocess.command
> hook (EventCallback), user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), is_channel (bool), tags (dict)
#### received.command
> user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), args (string), args_split (string[]), stdout, stderr, command (string), is_channel (bool), tags (dict)
Add header to EVENTS.md 2018-09-30 11:00:59 +00:00			`# Events`
			`Below is a list of each event that is propagated through BitBot and the keyword arguments (and their types!) that come with them.`

Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## Newly created objects`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### new.user`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### new.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### new.server`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00

Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## Default events`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### raw.[command]`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), last (string), prefix (IRCPrefix), args (string[]), arbitrary (string), tags (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.numeric.[numeric]`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> line (string), server (IRCServer), tags (dict), last (string), line_split (string[]), number (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.[command]`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> line (string), line_split (string[]), command (string), server (IRCServer), tags (dict), last (string)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## RPL_ISUPPORT`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.numeric.005`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> isupport (string), server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## Channel topics`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.numeric.332`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), server (IRCServer), topic (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.numeric.333`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), setter (string), set_at (int), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.topic`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), server (IRCServer), topic (string), user (IRCUser)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## User activity in a channel`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.join`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), user (IRCUser), server (IRCServer), account (string), realname (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.part`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.kick`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), reason (string), target_user (IRCUser), user (IRCUser), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.quit`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> reason (string), user (IRCUser), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.invite`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), target_channel (string), server (IRCServer), target_user (IRCUser)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.join`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), server (IRCServer), account (string), realname (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.part`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), reason (string), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.kick`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## NICK`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.nick`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), new_nickname (string), old_nickname (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.nick`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> new_nickname (string), old_nickname (string), user (IRCUser), server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## Channel/user modes`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.mode`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> modes, server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.mode.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> modes, mode_args, channel (IRCChannel), server (IRCServer), user (IRCUser)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## IRCv3`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.cap.ls`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), capabilities (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.cap.new`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), capabilities (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.cap.del`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), capabilities (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.cap.ack`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> server (IRCServer), capabilities (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.authenticate`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.tagmsg.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> channel (IRCChannel), user (IRCUser), tags (dict), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.tagmsg.private`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), tags (dict), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.away.on`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer), message (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.away.off`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.account.login`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer), account (string)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.account.logout`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## PRIVMSG (private/channel)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.message.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), channel (IRCChannel), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.message.private`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.message.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), message_split (string[]), channel (IRCChannel), action (bool), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### self.message.private`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), message_split (string[]), user (IRCUser), action (bool), server (IRCServer)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## NOTICE (private/channel/server)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.server-notice`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), message_split (string[]), server (IRCServer)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.notice.channel`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), message_split (string[]), user (IRCUser), server (IRCServer), channel (IRCChannel), tags (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.notice.private`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> message (string), message_split (string[]), user (IRCUser), server (IRCServer), tags (dict)`
Add first version of EVENTS.md 2018-09-30 10:43:52 +00:00
Make section headers ## instead of ### 2018-09-30 10:59:37 +00:00			`## !commands`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### preprocess.command`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> hook (EventCallback), user (IRCUser), server (IRCServer), target (IRCUser\|IRCChannel), is_channel (bool), tags (dict)`
Change ### to #### 2018-09-30 11:07:00 +00:00			`#### received.command`
"> " is actually a block quote. also change from to #### 2018-09-30 10:56:54 +00:00			`> user (IRCUser), server (IRCServer), target (IRCUser\|IRCChannel), args (string), args_split (string[]), stdout, stderr, command (string), is_channel (bool), tags (dict)`