Differences

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

Link to this comparison view

Both sides previous revision Previous revision
api:event [2017/07/20 07:06]
payonel [Functions]
api:event [2019/01/04 00:35] (current)
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.  ​