@drincs/pixi-vn/dist/classes/ticker/FadeAlphaTicker.d.ts

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

import { Ticker } from 'pixi.js';
import { FadeAlphaTickerProps } from '../../types/ticker/FadeAlphaTickerProps.js';
import { T as TickerBase } from '../../TickerBase-3rLpDpmb.js';
import '../../types/StorageElementType.js';
import '../../types/TickerIdType.js';

/**
 * A ticker that fades the alpha of the canvas element of the canvas.
 * This ticker can be used on all canvas elements that extend the {@link Container} class.
 * @example
 * ```typescript
 * let bunny = addImage("bunny1", "https://pixijs.com/assets/eggHead.png")
 * await bunny.load()
 * GameWindowManager.addCanvasElement("bunny", bunny);
 * // ...
 * const ticker = new FadeAlphaTicker({
 *     duration: 4, // 4 seconds
 *     type: "hide",
 * }),
 * GameWindowManager.addTicker("bunny", ticker)
 * ```
 */
declare class FadeAlphaTicker extends TickerBase<FadeAlphaTickerProps> {
    fn(ticker: Ticker, args: FadeAlphaTickerProps, tags: string[], tickerId: string): void;
}

export { FadeAlphaTicker as default };