excalibur/build/esm/Input/PointerComponent.d.ts

Excalibur.js is a simple JavaScript game engine with TypeScript bindings for making 2D games in HTML5 Canvas. Our mission is to make web game development as simple as possible.

import { Component } from '../EntityComponentSystem/Component';
import { BoundingBox } from '../Collision/BoundingBox';
export interface PointerComponentOptions {
    useColliderShape?: boolean;
    useGraphicsBounds?: boolean;
    localBounds?: BoundingBox;
}
/**
 * Add this component to optionally configure how the pointer
 * system detects pointer events.
 *
 * By default the collider shape is used and graphics bounds is not.
 *
 * If both collider shape and graphics bounds are enabled it will fire events if either or
 * are intersecting the pointer.
 */
export declare class PointerComponent extends Component {
    /**
     * Use any existing Collider component geometry for pointer events. This is useful if you want
     * user pointer events only to trigger on the same collision geometry used in the collider component
     * for collision resolution. Default is `true`.
     */
    useColliderShape: boolean;
    /**
     * Use any existing Graphics component bounds for pointers. This is useful if you want the axis aligned
     * bounds around the graphic to trigger pointer events. Default is `true`.
     */
    useGraphicsBounds: boolean;
    /**
     * Optionally use other bounds for pointer testing
     */
    localBounds?: BoundingBox;
    constructor(options?: PointerComponentOptions);
}