@drincs/pixi-vn/dist/interface/TickersSequence.d.cts

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

import { UPDATE_PRIORITY } from 'pixi.js';
import { PauseType } from '../types/PauseType.cjs';
import { RepeatType } from '../types/RepeatType.cjs';
import TickerArgs from './TickerArgs.cjs';

interface TickersStep<TArgs extends TickerArgs> {
    /**
     * Ticker class name
     */
    ticker: string;
    /**
     * Duration in seconds. If is undefined, the step will end only when the animation is finished.
     */
    duration?: number;
    /**
     * Arguments to pass to the ticker
     */
    args: TArgs;
    /**
     * Priority of the ticker
     */
    priority?: UPDATE_PRIORITY;
}
/**
 * The steps of the tickers
 */
interface TickersSequence {
    /**
     * The step number
     */
    currentStepNumber: number;
    /**
     * The steps of the tickers
     */
    steps: (TickersStep<any> | RepeatType | PauseType)[];
}

export type { TickersStep, TickersSequence as default };