Timers plugin for litecanvas

Helpers to manage timers in litecanvas games.

Install

NPM: npm i @litecanvas/plugin-timers

CDN: https://unpkg.com/@litecanvas/plugin-timers/dist/dist.js

Usage

1import litecanvas from "litecanvas"
2import pluginTimers from "@litecanvas/plugin-timers"
3
4litecanvas({
5  loop: { init },
6})
7
8use(pluginTimers) // load the plugin
9
10function init() {
11  wait(5, () => {
12    // this function will be executed after 5 seconds
13  })
14
15  loop(2, () => {
16    // this function will be executed every 2 seconds
17  })
18
19  repeat(10, 2, () => {
20    // this function will be executed only 10 times every 2 seconds
21  })
22}

Other features

Available for any kind of timer

Stop a timer:

1const t = wait(5, () => {
2  // ...
3})
4
5t.stop() // cancel the timer

Pause a timer:

1const t = wait(5, () => {
2  // ...
3})
4
5t.pause() // pause the timer
6
7t.resume() // resume a paused timer
8
9t.running // true if the timer is not paused

Get/set the remaining time:

1const t = wait(5, () => {
2  // ...
3})
4
5t.remaining += 10 // add 10 seconds

Get all active timers:

1...
2litecanvas()
3
4use(pluginTimers, {
5  exposeTimers: true // enable that settings
6})
7
8// now you can use the TIMERS variable
9TIMERS.forEach((t) => {
10  // ...
11})