Change ### to ####

This commit is contained in:
jesopo 2018-09-30 12:07:00 +01:00
parent 6ae3182aeb
commit c415cbfd80

View file

@ -2,108 +2,108 @@
Below is a list of each event that is propagated through BitBot and the keyword arguments (and their types!) that come with them. 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 ## Newly created objects
### new.user #### new.user
> user (IRCUser), server (IRCServer) > user (IRCUser), server (IRCServer)
### new.channel #### new.channel
> channel (IRCChannel), server (IRCServer) > channel (IRCChannel), server (IRCServer)
### new.server #### new.server
> server (IRCServer) > server (IRCServer)
## Default events ## Default events
### raw.[command] #### raw.[command]
> server (IRCServer), last (string), prefix (IRCPrefix), args (string[]), arbitrary (string), tags (dict) > server (IRCServer), last (string), prefix (IRCPrefix), args (string[]), arbitrary (string), tags (dict)
### received.numeric.[numeric] #### received.numeric.[numeric]
> line (string), server (IRCServer), tags (dict), last (string), line_split (string[]), number (string) > line (string), server (IRCServer), tags (dict), last (string), line_split (string[]), number (string)
### received.[command] #### received.[command]
> line (string), line_split (string[]), command (string), server (IRCServer), tags (dict), last (string) > line (string), line_split (string[]), command (string), server (IRCServer), tags (dict), last (string)
## RPL_ISUPPORT ## RPL_ISUPPORT
### received.numeric.005 #### received.numeric.005
> isupport (string), server (IRCServer) > isupport (string), server (IRCServer)
## Channel topics ## Channel topics
### received.numeric.332 #### received.numeric.332
> channel (IRCChannel), server (IRCServer), topic (string) > channel (IRCChannel), server (IRCServer), topic (string)
### received.numeric.333 #### received.numeric.333
> channel (IRCChannel), setter (string), set_at (int), server (IRCServer) > channel (IRCChannel), setter (string), set_at (int), server (IRCServer)
### received.topic #### received.topic
> channel (IRCChannel), server (IRCServer), topic (string), user (IRCUser) > channel (IRCChannel), server (IRCServer), topic (string), user (IRCUser)
## User activity in a channel ## User activity in a channel
### received.join #### received.join
> channel (IRCChannel), user (IRCUser), server (IRCServer), account (string), realname (string) > channel (IRCChannel), user (IRCUser), server (IRCServer), account (string), realname (string)
### received.part #### received.part
> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer) > channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)
### received.kick #### received.kick
> channel (IRCChannel), reason (string), target_user (IRCUser), user (IRCUser), server (IRCServer) > channel (IRCChannel), reason (string), target_user (IRCUser), user (IRCUser), server (IRCServer)
### received.quit #### received.quit
> reason (string), user (IRCUser), server (IRCServer) > reason (string), user (IRCUser), server (IRCServer)
### received.invite #### received.invite
> user (IRCUser), target_channel (string), server (IRCServer), target_user (IRCUser) > user (IRCUser), target_channel (string), server (IRCServer), target_user (IRCUser)
### self.join #### self.join
> channel (IRCChannel), server (IRCServer), account (string), realname (string) > channel (IRCChannel), server (IRCServer), account (string), realname (string)
### self.part #### self.part
> channel (IRCChannel), reason (string), server (IRCServer) > channel (IRCChannel), reason (string), server (IRCServer)
### self.kick #### self.kick
> channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer) > channel (IRCChannel), reason (string), user (IRCUser), server (IRCServer)
## NICK ## NICK
### self.nick #### self.nick
> server (IRCServer), new_nickname (string), old_nickname (string) > server (IRCServer), new_nickname (string), old_nickname (string)
### received.nick #### received.nick
> new_nickname (string), old_nickname (string), user (IRCUser), server (IRCServer) > new_nickname (string), old_nickname (string), user (IRCUser), server (IRCServer)
## Channel/user modes ## Channel/user modes
### self.mode #### self.mode
> modes, server (IRCServer) > modes, server (IRCServer)
### received.mode.channel #### received.mode.channel
> modes, mode_args, channel (IRCChannel), server (IRCServer), user (IRCUser) > modes, mode_args, channel (IRCChannel), server (IRCServer), user (IRCUser)
## IRCv3 ## IRCv3
### received.cap.ls #### received.cap.ls
> server (IRCServer), capabilities (dict) > server (IRCServer), capabilities (dict)
### received.cap.new #### received.cap.new
> server (IRCServer), capabilities (dict) > server (IRCServer), capabilities (dict)
### received.cap.del #### received.cap.del
> server (IRCServer), capabilities (dict) > server (IRCServer), capabilities (dict)
### received.cap.ack #### received.cap.ack
> server (IRCServer), capabilities (dict) > server (IRCServer), capabilities (dict)
### received.authenticate #### received.authenticate
> message (string), server (IRCServer) > message (string), server (IRCServer)
### received.tagmsg.channel #### received.tagmsg.channel
> channel (IRCChannel), user (IRCUser), tags (dict), server (IRCServer) > channel (IRCChannel), user (IRCUser), tags (dict), server (IRCServer)
### received.tagmsg.private #### received.tagmsg.private
> user (IRCUser), tags (dict), server (IRCServer) > user (IRCUser), tags (dict), server (IRCServer)
### received.away.on #### received.away.on
> user (IRCUser), server (IRCServer), message (string) > user (IRCUser), server (IRCServer), message (string)
### received.away.off #### received.away.off
> user (IRCUser), server (IRCServer) > user (IRCUser), server (IRCServer)
### received.account.login #### received.account.login
> user (IRCUser), server (IRCServer), account (string) > user (IRCUser), server (IRCServer), account (string)
### received.account.logout #### received.account.logout
> user (IRCUser), server (IRCServer) > user (IRCUser), server (IRCServer)
## PRIVMSG (private/channel) ## PRIVMSG (private/channel)
### received.message.channel #### received.message.channel
> user (IRCUser), channel (IRCChannel), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool) > user (IRCUser), channel (IRCChannel), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)
### received.message.private #### received.message.private
> user (IRCUser), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool) > user (IRCUser), message (string), message_split (string[]), server (IRCServer), tags (dict), action (bool)
### self.message.channel #### self.message.channel
> message (string), message_split (string[]), channel (IRCChannel), action (bool), server (IRCServer) > message (string), message_split (string[]), channel (IRCChannel), action (bool), server (IRCServer)
### self.message.private #### self.message.private
> message (string), message_split (string[]), user (IRCUser), action (bool), server (IRCServer) > message (string), message_split (string[]), user (IRCUser), action (bool), server (IRCServer)
## NOTICE (private/channel/server) ## NOTICE (private/channel/server)
### received.server-notice #### received.server-notice
> message (string), message_split (string[]), server (IRCServer) > message (string), message_split (string[]), server (IRCServer)
### received.notice.channel #### received.notice.channel
> message (string), message_split (string[]), user (IRCUser), server (IRCServer), channel (IRCChannel), tags (dict) > message (string), message_split (string[]), user (IRCUser), server (IRCServer), channel (IRCChannel), tags (dict)
### received.notice.private #### received.notice.private
> message (string), message_split (string[]), user (IRCUser), server (IRCServer), tags (dict) > message (string), message_split (string[]), user (IRCUser), server (IRCServer), tags (dict)
## !commands ## !commands
### preprocess.command #### preprocess.command
> hook (EventCallback), user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), is_channel (bool), tags (dict) > hook (EventCallback), user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), is_channel (bool), tags (dict)
### received.command #### received.command
> user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), args (string), args_split (string[]), stdout, stderr, command (string), is_channel (bool), tags (dict) > user (IRCUser), server (IRCServer), target (IRCUser|IRCChannel), args (string), args_split (string[]), stdout, stderr, command (string), is_channel (bool), tags (dict)