path: root/docs
diff options
authorZoffix Znet <cpan@zoffix.com>2016-07-28 22:56:01 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-28 22:56:01 -0400
commit90e66335f345e78296c98024c67c46cf8e9d5246 (patch)
tree08fdf72902b98713176987fe817b76d1aeb17d80 /docs
parentcf80b1b4392b849cb5529c1a40083170098f6460 (diff)
Moar docs
Diffstat (limited to 'docs')
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md
index e42a659..62f89d6 100644
--- a/docs/02-event-reference.md
+++ b/docs/02-event-reference.md
@@ -17,6 +17,17 @@ be triggered via notice and private message, so it's wider;
and `irc-privmsg` also includes private messages to our bot. The chain ends
by the widest event of them all: `irc-all`.
+## Responding to Events
+See [section in Basic Tutorial](01-basics.md#responding-to-events) for
+responding by returning a value from the event handler.
+The Message Objects received by the event handlers for the `irc-privmsg` and
+`irc-notice` event chains also provide a `.reply` method using which you
+can reply to the event. When this method is called `.is-replied` attribute
+of the Message Object is set to `True`, which signals to the Client Object
+that the returned value from the event handler should be discarded.
## Event Map
All event chains end with `irc-all`, which is not shown in the table below,