view doc/src/api/event/onCommand.md @ 614:ebdc614db066

Docs: get rid of metadata
author David Demelier <markand@malikania.fr>
date Sun, 17 Dec 2017 09:21:49 +0100
parents bb9771fb5f44
children
line wrap: on
line source

# Event onCommand

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**.

# Synopsis

```javascript
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.