Options
All
  • Public
  • Public/Protected
  • All
Menu

Excalibur base class that provides basic functionality such as EventDispatcher and extending abilities for vanilla Javascript projects

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

eventDispatcher: EventDispatcher<any>

Direct access to the game object event dispatcher.

Methods

  • emit(eventName: string, eventObject: any): void
  • Emits a new event

    Parameters

    • eventName: string

      Name of the event to emit

    • eventObject: any

      Data associated with this event

    Returns void

  • off(eventName: string, handler?: (event: any) => void): void
  • Alias for removeEventListener. If only the eventName is specified it will remove all handlers registered for that specific event. If the eventName and the handler instance are specified only that handler will be removed.

    Parameters

    • eventName: string

      Name of the event to listen for

    • Optional handler: (event: any) => void

      Event handler for the thrown event

        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns void

  • on(eventName: string, handler: (event: any) => void): void
  • Alias for addEventListener. You can listen for a variety of events off of the engine; see the events section below for a complete list.

    Parameters

    • eventName: string

      Name of the event to listen for

    • handler: (event: any) => void

      Event handler for the thrown event

        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns void

  • once(eventName: string, handler: (event: any) => void): void
  • Once listens to an event one time, then unsubscribes from that event

    Parameters

    • eventName: string

      The name of the event to subscribe to once

    • handler: (event: any) => void

      The handler of the event that will be auto unsubscribed

        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns void