Options
All
  • Public
  • Public/Protected
  • All
Menu

Wrapper class for event handling.

Hierarchy

Index

Constructors

constructor

Methods

addEventListener

  • addEventListener(type: string, callback: (...args: any[]) => void, once?: boolean): void
  • Adds an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: (...args: any[]) => void

      Listener callback function.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional once: boolean

      (Optional) Indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked.

    Returns void

emitEvent

  • emitEvent<T>(event: T): void
  • Emits a player event.

    Type parameters

    Parameters

    • event: T

      Event that contains at least a 'type' property.

    Returns void

off

  • off(type: string, callback: (...args: any[]) => void): void
  • Alias method for removeEventListener.

    Parameters

    • type: string

      Event type.

    • callback: (...args: any[]) => void

      Listener callback function.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

on

  • on(type: string, callback: (...args: any[]) => void, once?: boolean): void
  • Alias method for addEventListener.

    Parameters

    • type: string

      Event type.

    • callback: (...args: any[]) => void

      Listener callback function.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional once: boolean

      (Optional) Indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked.

    Returns void

removeAllListeners

  • removeAllListeners(): void
  • Removes all listeners.

    Returns void

removeEventListener

  • removeEventListener(type: string, callback: (...args: any[]) => void): void
  • Removes an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: (...args: any[]) => void

      Listener callback function.

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void