new Signal()
A Signal is an event dispatch mechansim that supports broadcasting to multiple listeners.
Event listeners are uniquely identified by the listener/callback function and the context.
- Source code: core/Signal.js (Line 16)
Public Properties
-
active : boolean
-
Is the Signal active? Only active signals will broadcast dispatched events.
Setting this property during a dispatch will only affect the next dispatch. To stop the propagation of a signal from a listener use halt.
- Default Value
- true
- Source code: core/Signal.js (Line 57)
-
memorize : boolean
-
Memorize the previously dispatched event?
If an event has been memorized it is automatically dispatched when a new listener is added with add or addOnce. Use forget to clear any currently memorized event.
- Source code: core/Signal.js (Line 41)
Public Methods
-
add(listener, listenerContext, priority, args) → {Phaser.SignalBinding}
-
Add an event listener for this signal.
An event listener is a callback with a related context and priority.
You can optionally provide extra arguments which will be passed to the callback after any internal parameters.
For example:
Phaser.Key.onDownwhen dispatched will send the Phaser.Key object that caused the signal as the first parameter. Any arguments you've specified afterprioritywill be sent as well:fireButton.onDown.add(shoot, this, 0, 'lazer', 100);When onDown dispatches it will call the
shootcallback passing it:Phaser.Key, 'lazer', 100.Where the first parameter is the one that Key.onDown dispatches internally and 'lazer', and the value 100 were the custom arguments given in the call to 'add'.
Parameters
Name Type Argument Default Description listenerfunction The function to call when this Signal is dispatched.
listenerContextobject <optional>
The context under which the listener will be executed (i.e. the object that should represent the
thisvariable).prioritynumber <optional>
The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)
argsany <optional>
<repeatable>
(none) Additional arguments to pass to the callback (listener) function. They will be appended after any arguments usually dispatched.
Returns
An Object representing the binding between the Signal and listener.
- Source code: core/Signal.js (Line 189)
-
addOnce(listener, listenerContext, priority, args) → {Phaser.SignalBinding}
-
Add a one-time listener - the listener is automatically removed after the first execution.
If there is as memorized event then it will be dispatched and the listener will be removed immediately.
Parameters
Name Type Argument Default Description listenerfunction The function to call when this Signal is dispatched.
listenerContextobject <optional>
The context under which the listener will be executed (i.e. the object that should represent the
thisvariable).prioritynumber <optional>
The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)
argsany <optional>
<repeatable>
(none) Additional arguments to pass to the callback (listener) function. They will be appended after any arguments usually dispatched.
Returns
An Object representing the binding between the Signal and listener.
- Source code: core/Signal.js (Line 231)
-
dispatch(params)
-
Dispatch / broadcast the event to all listeners.
To create an instance-bound dispatch for this Signal, use boundDispatch.
Parameters
Name Type Argument Description paramsany <optional>
Parameters that should be passed to each handler.
- Source code: core/Signal.js (Line 352)
-
dispose()
-
Dispose the signal - no more events can be dispatched.
This removes all event listeners and clears references to external objects. Calling methods on a disposed objects results in undefined behavior.
- Source code: core/Signal.js (Line 408)
-
forget()
-
Forget the currently memorized event, if any.
- Source code: core/Signal.js (Line 394)
-
getNumListeners() → {integer}
-
Gets the total number of listeners attached to this Signal.
Returns
integer -Number of listeners attached to the Signal.
- Source code: core/Signal.js (Line 326)
-
halt()
-
Stop propagation of the event, blocking the dispatch to next listener on the queue.
This should be called only during event dispatch as calling it before/after dispatch won't affect another broadcast. See active to enable/disable the signal entirely.
- Source code: core/Signal.js (Line 338)
-
has(listener, context) → {boolean}
-
Check if a specific listener is attached.
Parameters
Name Type Argument Description listenerfunction Signal handler function.
contextobject <optional>
Context on which listener will be executed (object that should represent the
thisvariable inside listener function).Returns
boolean -If Signal has the specified listener.
- Source code: core/Signal.js (Line 175)
-
remove(listener, context) → {function}
-
Remove a single event listener.
Parameters
Name Type Argument Default Description listenerfunction Handler function that should be removed.
contextobject <optional>
null Execution context (since you can add the same handler multiple times if executing in a different context).
Returns
function -Listener handler function.
- Source code: core/Signal.js (Line 262)
-
removeAll(context)
-
Remove all event listeners.
Parameters
Name Type Argument Default Description contextobject <optional>
null If specified only listeners for the given context will be removed.
- Source code: core/Signal.js (Line 286)
-
toString() → {string}
-
A string representation of the object.
Returns
string -String representation of the object.
- Source code: core/Signal.js (Line 428)