summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2021-06-27 09:48:16 +0200
committerSébastien Helleu <flashcode@flashtux.org>2021-06-27 09:48:16 +0200
commitff8beb1918816ccd1c15954f7f564ab02e9cfb9f (patch)
tree30e74538429a15c36907f9266ce173de55286b93 /doc/en
parent59853d9b303991ac4169d36c23880dcca7b90acf (diff)
downloadweechat-ff8beb1918816ccd1c15954f7f564ab02e9cfb9f.zip
irc: allow signals "irc_raw_in" and "irc_in" to eat messages (issue #1657)
This is useful to implement IRC protocol extensions which introduce new commands.
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_plugin_api.en.adoc8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index c91069732..b568e9794 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -10124,7 +10124,9 @@ List of signals sent by WeeChat and plugins:
String: message. |
IRC message from server (before irc plugin uses it,
signal sent only if message is *not* ignored). +
- Since version 2.2, the whole IRC message is sent, including tags.
+ Since version 2.2, the whole IRC message is sent, including tags. +
+ If the return code of a callback is _WEECHAT_RC_OK_EAT_, then the IRC message
+ is immediately destroyed and not processed by WeeChat.
| irc |
[[hook_signal_xxx_irc_in2_yyy]] xxx,irc_in2_yyy ^(1)^ |
@@ -10139,7 +10141,9 @@ List of signals sent by WeeChat and plugins:
String: message. |
IRC message from server (before irc plugin uses it,
signal sent even if message is ignored). +
- Since version 2.2, the whole IRC message is sent, including tags.
+ Since version 2.2, the whole IRC message is sent, including tags. +
+ If the return code of a callback is _WEECHAT_RC_OK_EAT_, then the IRC message
+ is immediately destroyed and not processed by WeeChat.
| irc |
[[hook_signal_xxx_irc_raw_in2_yyy]] xxx,irc_raw_in2_yyy ^(1)^ +