2007-08-19 16:42:30 +00:00
\section emit emit - Emit a generic event
\subsection block-synopsis Synopsis
2012-12-20 00:11:55 +00:00
<tt>emit EVENT_NAME [ARGUMENTS...]</tt>
2007-08-19 16:42:30 +00:00
\subsection emit-description Description
2012-12-20 00:11:55 +00:00
The emit builtin fires a generic fish event. Such events can be caught by special functions called event handlers. The arguments are passed to the event handlers as function arguments.
2007-08-19 16:42:30 +00:00
\subsection emit-example Example
2007-09-08 22:24:53 +00:00
The following code first defines an event handler for the generic
2007-08-19 16:42:30 +00:00
event named 'test_event', and then emits an event of that type.
2007-09-08 22:24:53 +00:00
<pre>function event_test --on-event test_event
2012-12-20 00:11:55 +00:00
echo event test: $argv
2007-08-19 16:42:30 +00:00
end
2012-12-20 00:11:55 +00:00
emit test_event something
</pre>