-
Notifications
You must be signed in to change notification settings - Fork 0
/
ModuleMethodConvention.txt
76 lines (64 loc) · 2.7 KB
/
ModuleMethodConvention.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
The return convention is to return true if you sent a message and otherwise
to return False. DO NOT VIOLATE THIS.
channel messages:
def onChannelMessage(connection, nick, channel, message):
connection is the irc connection; used for sending things back
nick is the name of the user who said it
channel is where it was said; should be a nick if it was private
message is the contents of the message
channel actions:
def onChannelAction(connection, nick, channel, message):
connection is the irc connection; used for sending things back
nick is the name of the user who said it
channel is where it was said; should be a nick if it was private
message is the contents of the message
channel mode:
def onChannelMode(connection, changer, channel, changed, extra):
connection is the irc connection; used for sending things back
changer is the nick of the person who changed it
channel is the channel where it was changed; will always be a
channel (I am pretty sure?)
changed is the mode change strong, like +o
extra is any other part, like the name of the person opped in +o
channel join:
def onJoin(connection, nick, channel):
connection is the irc connection; used for sending things back
nick is the nick of the one joining
channel is the channel where the join occurred (will never be nick)
channel kick:
def onKick(connection, nick, channel, kicker, reason):
connection is the irc connection; used for sending things back
nick is the person who was kicked
channel is the channel where the kicking occurred
kicker is the one doing the kicking
reson is the kickstring
channel part:
def onPart(connection, nick, channel, reason):
connection is the irc connection; used for sending things back
nick is the nick of the one parting
channel is where the part occurs
reason is the part string
user nick:
def onNick(connection, oldnick, channel, newnick):
connection is the irc connection; used for sending things back
old nick is the old nickname
channel is all channels where the user is
newnick is the new nickname changed to
channel quit:
no method; log these as parts for each chan; otherwise, too
difficult to track
bot join:
def onBotJoin(connection, channel):
connection is the irc connection; used for sending things back
channel is the channel that the bot has joined
bot part:
def onBotPart(connection, channel):
connection is the irc connection; used for sending things back
channel is the channel that the bot is ABOUT TO leave
bot quit:
this will only occur on an error, so fuck writing a method for
that. Call part if you really care.
bot nickchange:
def onBotNickChange(connection, newnick):
connection is the irc connection; used for sending things back
newnick is the new nickname for the bot