Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
api:event [2017/06/11 02:45]
payonel
api:event [2019/01/04 00:35]
payonel [Functions]
Line 20: Line 20:
 **event** - name of the signal to listen to.\\ **event** - name of the signal to listen to.\\
 **callback** - the function to call if this signal is received. The function will receive the event name it was registered for as first parameter, then all remaining parameters as defined by the [[component:​signals|signal]] that caused the event.\\ **callback** - the function to call if this signal is received. The function will receive the event name it was registered for as first parameter, then all remaining parameters as defined by the [[component:​signals|signal]] that caused the event.\\
-**Returns:​** `true` if the event was successfully registered, `false` if this function was already registered for this event type.+**Returns:​** `number`, the event id which can be canceled via `event.cancel`, ​if the event was successfully registered, `false` if this function was already registered for this event type.
 - `event.ignore(event:​ string, callback: function): boolean`  ​ - `event.ignore(event:​ string, callback: function): boolean`  ​
 Unregister a previously registered event listener.  ​ Unregister a previously registered event listener.  ​
Line 82: Line 82:
 Global event callback error handler. If an event listener throws an error, we handle it in this function to avoid it bubbling into unrelated code (that only triggered the execution by calling `event.pull`). Per default, this logs errors into a file on the temporary file system.  ​ Global event callback error handler. If an event listener throws an error, we handle it in this function to avoid it bubbling into unrelated code (that only triggered the execution by calling `event.pull`). Per default, this logs errors into a file on the temporary file system.  ​
 You can replace this function with your own if you want to handle event errors in a different way. You can replace this function with your own if you want to handle event errors in a different way.
 +- `event.push(name:​ string[, ...])`  ​
 +This is only an alias to [[api:​computer|computer.pushSignal]]. This does not modify the arguments in any way. It seemed logical to add the alias to the event library because there is also an `event.pull` for signals.
 +
  
 ===== Interrupts ===== ===== Interrupts =====