@drincs/pixi-vn/dist/classes/ticker/TickerBase.js

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

'use strict';

// src/classes/ticker/TickerBase.ts
var TickerBase = class {
  /**
   * @param args The arguments that you want to pass to the ticker.
   * @param duration The duration of the ticker in seconds. If is undefined, the step will end only when the animation is finished (if the animation doesn't have a goal to reach then it won't finish). @default undefined
   * @param priority The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
   */
  constructor(args, duration, priority) {
    /**
     * Get the id of the ticker. This variable is used in the system to get the ticker by id, {@link geTickerInstanceById}
     */
    this.id = "ticker_id_not_set";
    this.args = args;
    this.duration = duration;
    this.priority = priority;
    this.id = this.constructor.prototype.id;
  }
  /**
   * The method that will be called every frame.
   * This method should be overridden and you can use GameWindowManager.addCanvasElement() to get the canvas element of the canvas, and edit them.
   * @param _ticker The ticker that is calling this method
   * @param _args The arguments that you passed when you added the ticker
   * @param _tags The tags of the canvas elements that are connected to this ticker
   * @param _tickerId The id of the ticker. You can use this to get the ticker from the {@link GameWindowManager.currentTickers}
   */
  fn(_ticker, _args, _tags, _tickerId) {
    throw new Error("[Pixi'VN] The method TickerBase.fn() must be overridden");
  }
};

module.exports = TickerBase;
//# sourceMappingURL=TickerBase.js.map
//# sourceMappingURL=TickerBase.js.map