new Signal()
- Source:
Members
-
active
-
If Signal is active and should broadcast events. IMPORTANT: Setting this property during a dispatch will only affect the next dispatch, if you want to stop the propagation of a signal use
halt()instead.- Default Value:
- true
- Source:
Properties:
Name Type Description activeboolean -
memorize
-
If Signal should keep record of previously dispatched parameters and automatically execute listener during
add()/addOnce()if Signal was already dispatched before.- Source:
Properties:
Name Type Description memorizeboolean
Methods
-
add(listener, listenerContext, priority) → {Phaser.SignalBinding}
-
Add a listener to the signal.
Parameters:
Name Type Argument 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)
- Source:
Returns:
An Object representing the binding between the Signal and listener.
- Type
- Phaser.SignalBinding
-
addOnce(listener, listenerContext, priority) → {Phaser.SignalBinding}
-
Add listener to the signal that should be removed after first execution (will be executed only once).
Parameters:
Name Type Argument 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)
- Source:
Returns:
An Object representing the binding between the Signal and listener.
- Type
- Phaser.SignalBinding
-
dispatch(params)
-
Dispatch/Broadcast Signal to all listeners added to the queue.
Parameters:
Name Type Argument Description paramsany <optional>
Parameters that should be passed to each handler.
- Source:
-
dispatch()
-
- Source:
Properties:
Name Type Description dispatchfunction The dispatch function is what sends the Signal out.
-
dispose()
-
Remove all bindings from signal and destroy any reference to external objects (destroy Signal object). IMPORTANT: calling any method on the signal instance after calling dispose will throw errors.
- Source:
-
forget()
-
Forget memorized arguments.
- Source:
- See:
-
- Signal.memorize
-
getNumListeners() → {number}
-
Gets the total number of listeneres attached to ths Signal.
- Source:
Returns:
Number of listeners attached to the Signal.
- Type
- number
-
halt()
-
Stop propagation of the event, blocking the dispatch to next listeners on the queue. IMPORTANT: should be called only during signal dispatch, calling it before/after dispatch won't affect signal broadcast.
- Source:
- See:
-
- Signal.prototype.disable
-
has(listener, context) → {boolean}
-
Check if listener was attached to Signal.
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).- Source:
Returns:
If Signal has the specified listener.
- Type
- boolean
-
remove(listener, context) → {function}
-
Remove a single listener from the dispatch queue.
Parameters:
Name Type Argument Description listenerfunction Handler function that should be removed.
contextobject <optional>
Execution context (since you can add the same handler multiple times if executing in a different context).
- Source:
Returns:
Listener handler function.
- Type
- function
-
removeAll(context)
-
Remove all listeners from the Signal.
Parameters:
Name Type Argument Default Description contextobject <optional>
null If specified only listeners for the given context will be removed.
- Source:
-
toString() → {string}
-
- Source:
Returns:
String representation of the object.
- Type
- string