Mercurial > irccd

annotate doc/html/api/event/onCommand.md @ 24:392778b6d3c9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: arguments are now in bold, #423
author David Demelier <markand@malikania.fr>
date Tue, 16 Feb 2016 13:36:46 +0100
parents 1158cffe5a5e
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 event: onCommand
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Execute special command."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "function onCommand(server, origin, channel, message)"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 arguments:
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
6 - "**server**: the current server,"
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
7 - "**origin**: who invoked the command,"
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
8 - "**channel**: the channel where the message comes from,"
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
9 - "**message**: the real message, without the ! part."
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 Special commands are not real IRC events. They are called from channel messages with a specific syntax using a delimiter
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 and the plugin name.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 For instance, with default irccd parameters, saying on a channel `!ask foo` will call the special command of the plugin
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 named **ask**.