@drincs/pixi-vn/dist/interface/Ticker.d.ts

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

import { UPDATE_PRIORITY } from 'pixi.js';
import { TickerIdType } from '../types/TickerIdType.js';
import TickerArgs from './TickerArgs.js';

interface Ticker<TArgs extends TickerArgs> {
    /**
     * Arguments to pass to the ticker
     */
    args: TArgs;
    /**
     * Duration in seconds to run the ticker
     */
    duration?: number;
    /**
     * Priority of the ticker
     */
    priority?: UPDATE_PRIORITY;
    /**
     * Get the id of the ticker. This variable is used in the system to get the ticker by id, {@link getTickerInstanceById}
     */
    id: TickerIdType;
}

export type { Ticker as default };