The PointerEventProcessor is responsible for collecting all the events from the canvas and transforming them into GlobalCoordinates

Hierarchy

  • Class
    • PointerEventReceiver

Constructors

Properties

currentFrameCancel: PointerEvent[] = []
currentFrameDown: PointerEvent[] = []
currentFrameMove: PointerEvent[] = []
currentFramePointerCoords: Map<number, GlobalCoordinates> = ...
currentFramePointerDown: Map<number, boolean> = ...
currentFrameUp: PointerEvent[] = []
currentFrameWheel: WheelEvent[] = []
engine: Engine
eventDispatcher: EventDispatcher<any>

Direct access to the game object event dispatcher.

lastFramePointerCoords: Map<number, GlobalCoordinates> = ...
lastFramePointerDown: Map<number, boolean> = ...
primary: PointerAbstraction = ...
target: GlobalEventHandlers & EventTarget

Methods

  • Locates a specific pointer by id, creates it if it doesn't exist

    Parameters

    • index: number

    Returns PointerAbstraction

  • Emits a new event

    Parameters

    • eventName: string

      Name of the event to emit

    • eventObject: any

      Data associated with this event

    Returns void

  • Initializes the pointer event receiver so that it can start listening to native browser events.

    Returns void

  • Is the specified pointer id down this frame

    Parameters

    • pointerId: number

    Returns boolean

  • Whether the Pointer just ended dragging.

    Parameters

    • pointerId: number

    Returns boolean

  • Whether the Pointer just started dragging.

    Parameters

    • pointerId: number

    Returns boolean

  • Whether the Pointer is currently dragging.

    Parameters

    • pointerId: number

    Returns boolean

  • Triggers an excalibur pointer event in a world space pos

    Useful for testing pointers in excalibur

    Parameters

    • type: "cancel" | "move" | "up" | "down"
    • pos: Vector

    Returns void

  • Called internally by excalibur

    Updates the current frame pointer info and emits raw pointer events

    This does not emit events to entities, see PointerSystem

    Returns void

  • Was the specified pointer id down last frame

    Parameters

    • pointerId: number

    Returns boolean