@drincs/pixi-vn/dist/functions/TickerUtility.d.ts

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

import { TickerProgrationType } from '../interface/TickerProgrationType.js';

/**
 * This function updates the progression of the ticker.
 * For example, if the speed of the ticker is 0.1 and the progression is 0.01, then the speed will be 0.11.
 * @param args The arguments that are passed to the ticker
 * @param propertyName The property name that will be updated
 * @param progression The progression of the ticker
 * @param valueConvert The function that converts the amount and limit of progression
 * @returns
 */
declare function updateTickerProgression<T extends {}>(args: T, propertyName: keyof T, progression: TickerProgrationType, valueConvert?: (value: number) => number): void;

export { updateTickerProgression };