@drincs/pixi-vn/dist/constants.d.cts

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

import { filters as filters$1 } from '@pixi/sound';
import { PauseType } from './types/PauseType.cjs';
import { RepeatType } from './types/RepeatType.cjs';

var version = "0.10.23";

declare const Repeat: RepeatType;
/**
 * Pause the tickers for a duration.
 * @param duration Duration in seconds
 * @returns The pause object
 */
declare function Pause(duration: number): PauseType;
declare const filters: {
    DistortionFilter: typeof filters$1.DistortionFilter;
    EqualizerFilter: typeof filters$1.EqualizerFilter;
    MonoFilter: typeof filters$1.MonoFilter;
    ReverbFilter: typeof filters$1.ReverbFilter;
    StereoFilter: typeof filters$1.StereoFilter;
    StreamFilter: typeof filters$1.StreamFilter;
    TelephoneFilter: typeof filters$1.TelephoneFilter;
};
declare const videoFormats: string[];
/**
 * Is a special alias to indicate the game layer.
 */
declare const CANVAS_APP_GAME_LAYER_ALIAS = "__game_layer__";
declare const CANVAS_CONTAINER_ID = "Container";
declare const CANVAS_IMAGE_CONTAINER_ID = "ImageContainer";
declare const CANVAS_IMAGE_ID = "Image";
declare const CANVAS_SPRITE_ID = "Sprite";
declare const CANVAS_TEXT_ID = "Text";
declare const CANVAS_VIDEO_ID = "Video";
declare const SYSTEM_RESERVED_STORAGE_KEYS: {
    /**
     * The key of the current dialogue memory
     */
    CURRENT_DIALOGUE_MEMORY_KEY: string;
    /**
     * The key of the last dialogue added in the step memory
     */
    LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: string;
    /**
     * The key of the current menu options memory
     */
    CURRENT_MENU_OPTIONS_MEMORY_KEY: string;
    /**
     * The key of the last menu options added in the step memory
     */
    LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: string;
    /**
     * The key of the input memory. This value can be read by pixi-vn json importer
     */
    CURRENT_INPUT_VALUE_MEMORY_KEY: string;
    /**
     * The key of the last input added in the step memory
     */
    LAST_INPUT_ADDED_IN_STEP_MEMORY_KEY: string;
    /**
     * The key of the current input info
     */
    CURRENT_INPUT_INFO_MEMORY_KEY: string;
    /**
     * The key of the characters memory
     */
    CHARACTER_CATEGORY_KEY: string;
    /**
     * The key of the flags memory
     */
    FLAGS_CATEGORY_KEY: string;
    /**
     * This variable is used to add the next dialog text into the current dialog memory.
     * This value was added to introduce Ink Glue functionality https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#glue
     */
    ADD_NEXT_DIALOG_TEXT_INTO_THE_CURRENT_DIALOG_FLAG_KEY: string;
    /**
     * The key of a list of all labels that have been opened during the progression of the steps.
     */
    OPENED_LABELS_COUNTER_KEY: string;
    /**
     * The key of a list of all choices that have been made during the progression of the steps.
     */
    ALL_CHOICES_MADE_KEY: string;
    /**
     * The key of the current step times counter.
     * This value was added to introduce Ink Sequences, cycles and other alternatives https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#sequences-cycles-and-other-alternatives
     */
    CURRENT_STEP_TIMES_COUNTER_KEY: string;
    /**
     * The key of the current step memory
     */
    TEMP_STORAGE_KEY: string;
    /**
     * The key of the current step memory deadlines
     */
    TEMP_STORAGE_DEADLINES_KEY: string;
};

export { CANVAS_APP_GAME_LAYER_ALIAS, CANVAS_CONTAINER_ID, CANVAS_IMAGE_CONTAINER_ID, CANVAS_IMAGE_ID, CANVAS_SPRITE_ID, CANVAS_TEXT_ID, CANVAS_VIDEO_ID, version as PIXIVN_VERSION, Pause, Repeat, SYSTEM_RESERVED_STORAGE_KEYS, filters, videoFormats };