PokéRogue
    Preparing search index...

    Interface OptionSelectModeConfig<T>

    Customizations options for UiMode.OPTION_SELECT

    interface OptionSelectModeConfig<T extends OptionSelectItem = OptionSelectItem> {
        blockCancelButton?: boolean;
        canBypassInputDelay?: boolean;
        inputDelay?: number;
        maxOptions?: number;
        onResize?: (w: number, h: number) => void;
        options: T[];
        xOffset?: number;
        yOffset?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    blockCancelButton? canBypassInputDelay? inputDelay? maxOptions? onResize? options xOffset? yOffset?
    blockCancelButton?: boolean

    Whether to prevent using the cancel button as a shorcut to selecting the last option in the menu.

    canBypassInputDelay?: boolean

    Whether to allow bypassing the inputDelay with the cancel button.

    inputDelay?: number

    Optional delay (in ms) before the player is allowed to make a selection.

    maxOptions?: number

    The maximum number of options shown at once on screen.

    onResize?: (w: number, h: number) => void

    Optional callback for when the window gets resized.

    options: T[]

    The OptionSelectItems to display.

    xOffset?: number

    Horizontal offset for the window compared to the default (right of screen)

    yOffset?: number

    Vertical offset for the window compared to the default (bottom of screen)

    Settings
    Member Visibility

    On This Page
    Properties