spacetac/src/ui/common/UIOverlay.ts

module TK.SpaceTac.UI {
    export interface UIOverlayOptions {
        color: number,
        alpha?: number,
        on_click?: Function
    }

    /**
     * UI component to display a semi-transparent overlay that fills the whole view and captures inputs
     */
    export class UIOverlay extends UIGraphics {
        constructor(view: BaseView, options: UIOverlayOptions) {
            super(view, "overlay");

            let rect = { x: 0, y: 0, width: view.getWidth(), height: view.getHeight() };
            this.addRectangle(rect, options.color, undefined, undefined, options.alpha);
            this.setInteractive({
                hitArea: rect,
                hitAreaCallback: Phaser.Geom.Rectangle.Contains,
            });
            this.on("pointerup", options.on_click || nop);
        }
    }
}