ecspresso
    Preparing search index...

    Interface SelectionPluginOptions<G>

    Configuration options for the selection plugin.

    interface SelectionPluginOptions<G extends string = "selection"> {
        boxFillAlpha?: number;
        boxFillColor?: number;
        boxStrokeAlpha?: number;
        boxStrokeColor?: number;
        clickThreshold?: number;
        phase?: SystemPhase;
        priority?: number;
        renderLayer?: string;
        selectedTint?: number;
        systemGroup?: G;
    }

    Type Parameters

    • G extends string = "selection"

    Hierarchy (View Summary)

    Index

    Properties

    boxFillAlpha? boxFillColor? boxStrokeAlpha? boxStrokeColor? clickThreshold? phase? priority? renderLayer? selectedTint? systemGroup?

    Properties

    boxFillAlpha?: number

    Selection box fill alpha (default: 0.15)

    boxFillColor?: number

    Selection box fill color (default: 0x00FF00)

    boxStrokeAlpha?: number

    Selection box stroke alpha (default: 0.8)

    boxStrokeColor?: number

    Selection box stroke color (default: 0x00FF00)

    clickThreshold?: number

    Minimum drag distance (px) to trigger box select vs click select (default: 5)

    phase?: SystemPhase

    Execution phase for the plugin's primary system

    priority?: number

    Priority for the plugin's primary system (default varies per plugin)

    renderLayer?: string

    Render layer for the selection box entity (default: undefined)

    selectedTint?: number

    Tint applied to selected entities' sprites (default: 0x44FF44)

    systemGroup?: G

    System group name for all systems registered by this plugin

    Settings

    Member Visibility

    On This Page

    Properties