From 311095fd68090ed82e9fff9f71003bc5247a108b Mon Sep 17 00:00:00 2001 From: Zoffix Znet Date: Thu, 28 Jul 2016 23:14:23 -0400 Subject: Document irc-started caveats --- docs/02-event-reference.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'docs/02-event-reference.md') diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md index f2bed7b..d990307 100644 --- a/docs/02-event-reference.md +++ b/docs/02-event-reference.md @@ -55,6 +55,18 @@ irc-addressed ▶ irc-to-me ▶ irc-notice-channel ▶ irc-notice irc-started ``` +**Note:** `irc-started` is a special event that's exempt from the rules +applicable to all other events and their event handlers: + +* It's called just once per call of `IRC::Client`'s `.run` method, regardless +of how many times the client reconnects +* When it's called, there's no guarantee the connections to servers have +been fully established yet or channels joined yet. +* Unless all other event handlers, this one does not take any arguments +* Return values from handlers are ignored and the event is propagated to all of +the plugins +* This event does not trigger `irc-all` event + ## Up Next Read [the method reference](03-method-reference.md) next. -- cgit v1.1