@drincs/pixi-vn/dist/HistoryChoiceMenuOption-unaLLfKR.d.cts

Pixi'VN is a npm package that provides various features for creating visual novels.

import { S as StorageElementType } from './StorageElementType-DTGcnkzF.cjs';
import { D as DialogueInterface, C as CloseType, L as LabelRunModeType } from './OpenedLabel-Dgkgemkv.cjs';

interface NarrationHistory {
    /**
     * Dialogue to be shown in the game
     */
    dialogue?: DialogueInterface;
    /**
     * List of choices asked of the player
     */
    choices?: HistoryChoiceMenuOption[];
    /**
     * The player made a choice
     */
    playerMadeChoice?: boolean;
    /**
     * The index of the step in the history.
     */
    stepIndex: number;
    /**
     * The input value of the player
     */
    inputValue?: StorageElementType;
}

/**
 * HistoryChoiceMenuOption is a type that contains the history information of a choice menu option.
 */
type HistoryChoiceMenuOption = {
    /**
     * Text to be displayed in the menu
     */
    text: string | string[];
    /**
     * Method used to open the label, or close the menu.
     */
    type: CloseType | LabelRunModeType;
    /**
     * This choice is a response
     */
    isResponse: boolean;
    /**
     * The choice is hidden
     */
    hidden: boolean;
};

export type { HistoryChoiceMenuOption as H, NarrationHistory as N };