Timer

Defined in: plugins/TimerPlugin.ts:241

A Timer instance that can count down or up, optionally running in a web worker.

Features:

• Count down from a duration or count up indefinitely
• Run in main thread (synced with Pixi ticker) or web worker
• Pause, resume, and reset functionality
• Loop option for repeating timers
• Tick and completion callbacks

Example

// Create a 10-second countdown timer
const timer = new Timer({
  duration: 10000,
  autoStart: true,
  loop: true,
  onTick: (remaining) => {
    console.log(`${remaining / 1000} seconds remaining`);
  },
  onComplete: () => {
    console.log('Timer completed!');
  }
}, timerPlugin);

// Pause the timer
timer.pause();

// Resume the timer
timer.start();

// Reset the timer
timer.reset();

Constructors

Constructor

new Timer(options, plugin): Timer

Defined in: plugins/TimerPlugin.ts:249

Parameters

options

TimerOptions = {}

plugin

TimerPlugin

Returns

Timer

Methods

addTime()

addTime(ms): number

Defined in: plugins/TimerPlugin.ts:413

Adds time to the timer. For countdown timers, this increases the duration. For count-up timers, this effectively adds time to the elapsed time.

Parameters

ms

number

Time to add in milliseconds

Returns

number

The new time value after adjustment

Example

// Add 5 seconds to a countdown timer
timer.addTime(5000);

// Add 5 seconds to a count-up timer
timer.addTime(5000);

---

destroy()

destroy(): void

Defined in: plugins/TimerPlugin.ts:315

Destroys the timer, cleaning up all resources. A destroyed timer cannot be restarted.

Returns

void

---

getId()

getId(): string

Defined in: plugins/TimerPlugin.ts:377

Gets the unique ID of this timer.

Returns

string

The timer’s UUID

---

getOptions()

getOptions(): TimerOptions

Defined in: plugins/TimerPlugin.ts:385

Gets the timer’s configuration options.

Returns

TimerOptions

The TimerOptions object used to create this timer

---

getRemainingTime()

getRemainingTime(): number

Defined in: plugins/TimerPlugin.ts:368

Gets the remaining time for countdown timers.

Returns

number

Remaining time in milliseconds, or 0 for count-up timers

---

getTime()

getTime(): number

Defined in: plugins/TimerPlugin.ts:357

Gets the current time value (elapsed time for count-up, remaining time for countdown).

Returns

number

Time in milliseconds

---

isWorker()

isWorker(): boolean

Defined in: plugins/TimerPlugin.ts:393

Checks if this timer is running in a web worker.

Returns

boolean

true if the timer is worker-based, false if running on main thread

---

pause()

pause(): void

Defined in: plugins/TimerPlugin.ts:284

Pauses the timer, maintaining its current state. The timer can be resumed later from the same point.

Returns

void

---

removeTime()

removeTime(ms): number

Defined in: plugins/TimerPlugin.ts:448

Removes time from the timer. For countdown timers, this decreases the duration. For count-up timers, this effectively removes time from the elapsed time.

Parameters

ms

number

Time to remove in milliseconds

Returns

number

The new time value after adjustment

Example

// Remove 5 seconds from a countdown timer
timer.removeTime(5000);

// Remove 5 seconds from a count-up timer
timer.removeTime(5000);

---

reset()

reset(): void

Defined in: plugins/TimerPlugin.ts:299

Resets the timer to its initial state. If the timer is not paused, it will start running immediately after reset.

Returns

void

---

start()

start(): void

Defined in: plugins/TimerPlugin.ts:269

Starts or resumes the timer. If the timer was paused, it will continue from where it left off.

Returns

void

---

update()

update(): void

Defined in: plugins/TimerPlugin.ts:326

Returns

void