M2O Scripting APIScripting reference
    Preparing search index…
    Data shapeClient API

    EventBus

    Asynchronous resource event bus. Native event names and callback payloads are inferred from EventMap. Script-defined event names remain supported by the string overloads.

    interface EventBus {
        emit(eventName: string, ...args: unknown[]): Promise<void>;
        emitLocal(eventName: string, ...args: unknown[]): Promise<void>;
        emitTo(
            resourceName: string,
            eventName: string,
            ...args: unknown[],
        ): Promise<void>;
        listenerCount(eventName: string): number;
        off<K extends keyof EventMap>(
            eventName: K,
            handler: (...args: EventMap[K]) => unknown,
        ): void;
        off(eventName: string, handler: (...args: unknown[]) => unknown): void;
        offClient(
            eventName: string,
            handler: (...args: unknown[]) => unknown,
        ): void;
        on<K extends keyof EventMap>(
            eventName: K,
            handler: (...args: EventMap[K]) => unknown,
        ): () => void;
        on(eventName: string, handler: (...args: unknown[]) => unknown): () => void;
        once<K extends keyof EventMap>(
            eventName: K,
            handler: (...args: EventMap[K]) => unknown,
        ): void;
        once(eventName: string, handler: (...args: unknown[]) => unknown): void;
        onceClient(
            eventName: string,
            handler: (...args: unknown[]) => unknown,
        ): void;
        onClient(
            eventName: string,
            handler: (...args: unknown[]) => unknown,
        ): () => void;
        onLocal(eventName: string, handler: (...args: unknown[]) => unknown): void;
    }
    Index
    • Parameters

      • eventName: string
      • ...args: unknown[]

      Returns Promise<void>

    • Parameters

      • eventName: string
      • ...args: unknown[]

      Returns Promise<void>

    • Parameters

      • resourceName: string
      • eventName: string
      • ...args: unknown[]

      Returns Promise<void>

    • Parameters

      • eventName: string
      • handler: (...args: unknown[]) => unknown

      Returns void

    • Type Parameters

      Parameters

      • eventName: K
      • handler: (...args: EventMap[K]) => unknown

      Returns () => void

    • Parameters

      • eventName: string
      • handler: (...args: unknown[]) => unknown

      Returns () => void

    • Parameters

      • eventName: string
      • handler: (...args: unknown[]) => unknown

      Returns void

    • Parameters

      • eventName: string
      • handler: (...args: unknown[]) => unknown

      Returns () => void

    • Parameters

      • eventName: string
      • handler: (...args: unknown[]) => unknown

      Returns void