Mercurial > irccd
view doc/html/api/event/onCommand.md @ 24:392778b6d3c9
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 |
line wrap: on
line source
--- event: onCommand summary: "Execute special command." synopsis: "function onCommand(server, origin, channel, message)" arguments: - "**server**: the current server," - "**origin**: who invoked the command," - "**channel**: the channel where the message comes from," - "**message**: the real message, without the ! part." --- Special commands are not real IRC events. They are called from channel messages with a specific syntax using a delimiter and the plugin name. For instance, with default irccd parameters, saying on a channel `!ask foo` will call the special command of the plugin named **ask**.