2007-08-20 02:42:30 +10:00
\section emit emit - Emit a generic event
2014-08-01 03:37:32 +01:00
\subsection emit-synopsis Synopsis
2014-08-01 13:25:41 +01:00
\fish{synopsis}
2014-08-01 03:37:32 +01:00
emit EVENT_NAME [ARGUMENTS...]
\endfish
2007-08-20 02:42:30 +10:00
\subsection emit-description Description
2014-08-01 03:37:32 +01:00
`emit` emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
2007-08-20 02:42:30 +10:00
2014-08-19 13:41:23 +01:00
2007-08-20 02:42:30 +10:00
\subsection emit-example Example
2014-08-19 13:41:23 +01:00
The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.
2007-08-20 02:42:30 +10:00
2014-08-01 03:37:32 +01:00
\fish
function event_test --on-event test_event
2012-12-20 01:11:55 +01:00
echo event test: $argv
2007-08-20 02:42:30 +10:00
end
2012-12-20 01:11:55 +01:00
emit test_event something
2018-03-07 19:45:36 -05:00
\endfish
2017-03-22 20:53:39 -07:00
2017-07-11 22:50:55 -07:00
\subsection emit-notes Notes
2017-03-22 20:53:39 -07:00
Note that events are only sent to the current fish process as there is no way to send events from one fish process to another.