Class Signal<T>

A Signal is an object that is used to dispatch and receive arbitrary events.

Type Parameters

  • T extends unknown[] | unknown = void

Properties

disconnectAllRequested queuedConnections

Methods

Connect ConnectWithPriority Destroy DisconnectAll Fire GetConnectionCount HasConnections Once Proxy RegisterQueuedConnections Wait WithAllowYield

Properties

Private disconnectAllRequested

disconnectAllRequested: boolean = false

This flag is to safely handle DisconnectAll while firing. When enabled we stop looping callbacks for the current Fire.

Private queuedConnections

queuedConnections: Map<number, CallbackItem<T>[]> = ...

Map from priority to all callbacks queued at that priority. Holds connections that were registered while this signal was firing (to be added after fire completes).

Methods

Connect

  • Connect(callback): (() => void)

  • Connect a callback function to the signal.

    The returned function can be called to disconnect the callback.

    Parameters

    • callback: SignalCallback<T>

    Returns (() => void)

      • (): void

      • Returns void

ConnectWithPriority

  • ConnectWithPriority(priority, callback): (() => void)

  • Connect a callback function to the signal. Highest SignalPriority is called first.

    The returned function can be called to disconnect the callback.

    Parameters

    • priority: SignalPriority
    • callback: SignalCallback<T>

    Returns (() => void)

      • (): void

      • Returns void

Destroy

  • Destroy(): void

  • Alias for DisconnectAll().

    Returns void

DisconnectAll

  • DisconnectAll(): void

  • Clears all connections.

    Returns void

Fire

  • Fire(...args): T

  • Invokes all callback functions with the given arguments.

    Parameters

    • Rest ...args: Parameters<[T] extends [unknown[]]
          ? ((...args) => never)
          : [T] extends [unknown]
              ? ((arg) => never)
              : (() => never)>

    Returns T

GetConnectionCount

  • GetConnectionCount(): number

  • Returns the number of connections.

    Returns number

HasConnections

  • HasConnections(): boolean

  • Returns true if there are any connections.

    Returns boolean

Once

  • Once(callback): (() => void)

  • Connects a callback function to the signal. The connection is automatically disconnected after the first invocation.

    The returned function can be called to disconnect the callback.

    Parameters

    • callback: SignalCallback<T>

    Returns (() => void)

      • (): void

      • Returns void

Proxy

  • Proxy(signal): (() => void)

  • Fires the given signal any time this signal is fired.

    The returned function can be called to disconnect the proxy.

    Parameters

    Returns (() => void)

      • (): void

      • Returns void

Private RegisterQueuedConnections

  • RegisterQueuedConnections(): void

  • Register all queued connections during fire

    Returns void

Wait

  • Wait(): SignalWait<T>

  • Yields the current thread until the next invocation of the signal occurs. The invoked arguments will be returned.

    Returns SignalWait<T>

WithAllowYield

  • WithAllowYield(value): Signal<T>

  • A yieldable signal is one in which calling Fire() may yield if any connected function handlers yield. This also means that all events will run in series. The default behavior is false, where the signal will call event handlers in separate threads, thus calling Fire() will not yield by default.

    Note: When using Cancellable events and not allowing Fire() to yield, then any connected handlers that do yield will throw a warning.

    // Example:
    const signal = new Signal().WithAllowYield(true);

    Parameters

    • value: boolean

    Returns Signal<T>

Settings

Member Visibility

Theme

On This Page

disconnectAllRequestedqueuedConnectionsConnectConnectWithPriorityDestroyDisconnectAllFireGetConnectionCountHasConnectionsOnceProxyRegisterQueuedConnectionsWaitWithAllowYield