⁘ common.signals

SignalBox

A boilerplate object to manage signals. Usually a single object has a single signalBox.

go to → Members

Constructor

new SignalBox()

Extends

Broadcasting

This section list the main methods used to watch/unwatch signals on this object. For more info on signals, see signals

Methods

Unwatch(p_signal, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

Watch(p_signal, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

WatchOnce(p_signalId, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

protected_Broadcast(p_signal, …args)

Inherited From:
Initialization

Methods

protectedoverride-me_Init()

Inherited From:

protectedoverride-me_PostInit()

Inherited From:
Utils

Methods

protected_Bind(p_func)

Inherited From:
Pooling

Group of methods related to the NKMjs pooling system.

Members

read-onlyisReleasing :boolean

Inherited From:

Methods

Release()

Inherited From:

protectedoverride-me_CleanUp()

Inherited From:
Misc

Members

silent :boolean

TODO

Methods

Add(p_signalId, p_fn, p_listener)

Register a signal subscription

Parameters:
Name Type Default Description
p_signalId Symbol
p_fn function
p_listener * null

AddOnce(p_signalId, p_fn, p_listener)

Register a signal subscription that will be removed after it fires once.

Parameters:
Name Type Default Description
p_signalId Symbol
p_fn function
p_listener * null

Broadcast(p_signalId, …args)

Broadcast a signal with arguments

Parameters:
Name Type Attributes Description
p_signalId Symbol
args * <repeatable>

Clear()

Clears all signals & subscriptions

PreventRelease()

Inherited From:

Remove(p_signalId, p_fn, p_listener)

Unregister a signal subscription

Parameters:
Name Type Default Description
p_signalId Symbol
p_fn function
p_listener * null

RemoveAll(p_signalId)

Unregister all subscription to a given signal

Parameters:
Name Type Description
p_signalId Symbol