litecanvas 0.80.0 → 0.81.0

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import './types'
+import './types.d.ts'
 
 /**
  * The litecanvas constructor
@@ -10,24 +10,22 @@ export default function litecanvas(
 declare global {
     function litecanvas(settings?: LitecanvasOptions): LitecanvasInstance
 
-    /** The game screen width */
-    var WIDTH: number
-    /** The game screen height */
-    var HEIGHT: number
     /** The game canvas HTML element */
     var CANVAS: HTMLCanvasElement
+    /** The game screen width */
+    var W: number
+    /** The game screen height */
+    var H: number
     /** the amount of time (in seconds) since the game started */
-    var ELAPSED: number
+    var T: number
     /** the center X of the game screen */
-    var CENTERX: number
+    var CX: number
     /** the center Y of the game screen */
-    var CENTERY: number
+    var CY: number
     /** The current mouse's horizontal (X) position or -1 (if the mouse was not used or detected) */
-    var MOUSEX: number
+    var MX: number
     /** The current mouse's vertical (Y) position or -1 (if the mouse was not used or detected) */
-    var MOUSEY: number
-    /** the default `sfx()` sound */
-    var DEFAULT_SFX: number[]
+    var MY: number
 
     /** MATH API */
     /**
@@ -128,6 +126,20 @@ declare global {
      * @returns the normalized number.
      */
     function norm(value: number, start: number, stop: number): number
+    /**
+     * Interpolate between 2 values using a periodic function.
+     *
+     * @param from - the lower bound
+     * @param to - the higher bound
+     * @param t - the amount
+     * @param fn - the periodic function (which default to `Math.sin`)
+     */
+    function wave(
+        from: number,
+        to: number,
+        t: number,
+        fn?: (n: number) => number
+    ): number
     /**
      * Returns the sine of a number in radians
      */
@@ -212,13 +224,13 @@ declare global {
      */
     function randi(min?: number, max?: number): number
     /**
-     * If a value is passed, initializes the random number generator with an explicit seed value.
-     * Otherwise, returns the current seed state.
+     * Initializes the random number generator with an explicit seed value.
+     *
+     * Note: The seed should be a integer number greater than or equal to zero.
      *
-     * @param [value]
-     * @returns the seed state
+     * @param value
      */
-    function seed(value?: number): number
+    function rseed(value: number): void
 
     /** BASIC GRAPHICS API */
     /**
@@ -348,7 +360,7 @@ declare global {
      *
      * @param size
      */
-    function textsize(size: string): void
+    function textsize(size: number): void
     /**
      * Sets the alignment used when drawing texts
      *
@@ -357,7 +369,10 @@ declare global {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign
      */
-    function textalign(align: string, baseline: string): void
+    function textalign(
+        align: CanvasTextAlign,
+        baseline: CanvasTextBaseline
+    ): void
 
     /** IMAGE GRAPHICS API */
     /**
@@ -387,7 +402,7 @@ declare global {
         drawing: string[] | drawCallback,
         options?: {
             scale?: number
-            canvas?: HTMLCanvasElement | OffscreenCanvas
+            canvas?: OffscreenCanvas
         }
     ): ImageBitmap
 
@@ -399,7 +414,9 @@ declare global {
      * @returns the current canvas context
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D
      */
-    function ctx(context?: CanvasRenderingContext2D): CanvasRenderingContext2D
+    function ctx(
+        context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D
+    ): CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D
     /**
      * saves the current drawing style settings and transformations
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/save
@@ -543,19 +560,18 @@ declare global {
         arg4?: any
     ): void
     /**
-     * Get the color value
+     * Set or reset the color palette
      *
-     * @param index The color number
-     * @returns the color value
+     * @param [colors]
      */
-    function getcolor(index: number): string
+    function pal(colors?: string[]): void
     /**
-     * Create or update a instance variable
+     * Define or update a instance property
      *
      * @param key
      * @param value
      */
-    function setvar(key: string, value: any): void
+    function def(key: string, value: any): void
     /**
      * The scale of the game's delta time (dt).
      * Values higher than 1 increase the speed of time, while values smaller than 1 decrease it.
@@ -565,9 +581,32 @@ declare global {
      */
     function timescale(value: number): void
     /**
-     * Set the target FPS at runtime.
+     * Set the target FPS (frames per second).
      *
      * @param fps
      */
-    function setfps(fps: number): void
+    function framerate(fps: number): void
+    /**
+     * Returns information about that engine instance.
+     *
+     * n = 0: the settings passed to that instance
+     * n = 1: returns true if the "init" event has already been emitted
+     * n = 2: the current ID returned by last requestAnimationFrame
+     * n = 3: the current canvas element scale (not the context 2D scale)
+     * n = 4: the attached event callbacks
+     * n = 5: the current color palette
+     * n = 6: the default sound used by `sfx()`
+     * n = 7: the current time scale
+     * n = 8: the current volume used by ZzFX
+     * n = 9: the current RNG state
+     *
+     * n = any other value: returns undefined
+     *
+     * @param n
+     */
+    function stat(n: number): any
+    /**
+     * Stops the litecanvas instance and remove all event listeners.
+     */
+    function quit(): void
 }

package/types/types.d.ts

@@ -1,22 +1,20 @@
 type LitecanvasInstance = {
-    /** The game screen width */
-    WIDTH: number
-    /** The game screen height */
-    HEIGHT: number
     /** The game canvas HTML element */
     CANVAS: HTMLCanvasElement
+    /** The game screen width */
+    W: number
+    /** The game screen height */
+    H: number
     /** the amount of time (in seconds) since the game started */
-    ELAPSED: number
+    T: number
     /** the center X of the game screen */
-    CENTERX: number
+    CX: number
     /** the center Y of the game screen */
-    CENTERY: number
+    CY: number
     /** The current mouse's horizontal (X) position or -1 (if the mouse was not used or detected) */
-    MOUSEX: number
+    MX: number
     /** The current mouse's vertical (Y) position or -1 (if the mouse was not used or detected) */
-    MOUSEY: number
-    /** the default `sfx()` sound */
-    DEFAULT_SFX: number[]
+    MY: number
 
     /** MATH API */
     /**
@@ -117,6 +115,20 @@ type LitecanvasInstance = {
      * @returns the normalized number.
      */
     norm(value: number, start: number, stop: number): number
+    /**
+     * Interpolate between 2 values using a periodic function.
+     *
+     * @param from - the lower bound
+     * @param to - the higher bound
+     * @param t - the amount
+     * @param fn - the periodic function (which default to `Math.sin`)
+     */
+    wave(
+        from: number,
+        to: number,
+        t: number,
+        fn?: (n: number) => number
+    ): number
     /**
      * Returns the sine of a number in radians
      */
@@ -201,13 +213,13 @@ type LitecanvasInstance = {
      */
     randi(min?: number, max?: number): number
     /**
-     * If a value is passed, initializes the random number generator with an explicit seed value.
-     * Otherwise, returns the current seed state.
+     * Initializes the random number generator with an explicit seed value.
+     *
+     * Note: The seed should be a integer number greater than or equal to zero.
      *
-     * @param [value]
-     * @returns the seed state
+     * @param value
      */
-    seed(value?: number): number
+    rseed(value: number): void
 
     /** BASIC GRAPHICS API */
     /**
@@ -326,7 +338,7 @@ type LitecanvasInstance = {
      *
      * @param size
      */
-    textsize(size: string): void
+    textsize(size: number): void
     /**
      * Sets the alignment used when drawing texts
      *
@@ -335,7 +347,7 @@ type LitecanvasInstance = {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign
      */
-    textalign(align: string, baseline: string): void
+    textalign(align: CanvasTextAlign, baseline: CanvasTextBaseline): void
 
     /** IMAGE GRAPHICS API */
     /**
@@ -365,7 +377,7 @@ type LitecanvasInstance = {
         drawing: string[] | drawCallback,
         options?: {
             scale?: number
-            canvas?: HTMLCanvasElement | OffscreenCanvas
+            canvas?: OffscreenCanvas
         }
     ): ImageBitmap
 
@@ -377,7 +389,9 @@ type LitecanvasInstance = {
      * @returns the current canvas context
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D
      */
-    ctx(context?: CanvasRenderingContext2D): CanvasRenderingContext2D
+    ctx(
+        context?: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D
+    ): CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D
     /**
      * saves the current drawing style settings and transformations
      * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/save
@@ -515,19 +529,18 @@ type LitecanvasInstance = {
      */
     emit(event: string, arg1?: any, arg2?: any, arg3?: any, arg4?: any): void
     /**
-     * Get the color value
+     * Define or update a instance property
      *
-     * @param index The color number
-     * @returns the color value
+     * @param key
+     * @param value
      */
-    getcolor(index: number): string
+    def(key: string, value: any): void
     /**
-     * Create or update a instance variable
+     * Set or reset the color palette
      *
-     * @param key
-     * @param value
+     * @param [colors]
      */
-    setvar(key: string, value: any): void
+    pal(colors?: string[]): void
     /**
      * The scale of the game's delta time (dt).
      * Values higher than 1 increase the speed of time, while values smaller than 1 decrease it.
@@ -537,11 +550,34 @@ type LitecanvasInstance = {
      */
     timescale(value: number): void
     /**
-     * Set the target FPS at runtime.
+     * Set the target FPS (frames per second).
      *
      * @param fps
      */
-    setfps(fps: number): void
+    framerate(fps: number): void
+    /**
+     * Returns information about that engine instance.
+     *
+     * n = 0: the settings passed to that instance
+     * n = 1: returns true if the "init" event has already been emitted
+     * n = 2: the current ID returned by last requestAnimationFrame
+     * n = 3: the current canvas element scale (not the context 2D scale)
+     * n = 4: the attached event callbacks
+     * n = 5: the current color palette
+     * n = 6: the default sound used by `sfx()`
+     * n = 7: the current time scale
+     * n = 8: the current volume used by ZzFX
+     * n = 9: the current RNG state
+     *
+     * n = any other value: returns undefined
+     *
+     * @param n
+     */
+    stat(n: number): any
+    /**
+     * Stops the litecanvas instance and remove all event listeners.
+     */
+    quit(): void
 }
 
 type LitecanvasOptions = {
@@ -631,19 +667,4 @@ type drawCallback = (
     context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D
 ) => void
 
-type LitecanvasPluginHelpers = {
-    /**
-     * The instance color palette (writable)
-     */
-    colors: string[]
-    /**
-     * Litecanvas instance settings (read-only)
-     */
-    settings: LitecanvasOptions
-}
-
-type pluginCallback = (
-    instance: LitecanvasInstance,
-    helpers: LitecanvasPluginHelpers,
-    config?: any
-) => any
+type pluginCallback = (instance: LitecanvasInstance, config?: any) => any

package/src/types.js

@@ -1,55 +0,0 @@
-/**
- * @typedef LitecanvasOptions
- * @type {object}
- * @property {number} [width]
- * @property {number} [height]
- * @property {boolean} [pauseOnBlur=true]
- * @property {boolean} [autoscale=true]
- * @property {boolean} [pixelart=false]
- * @property {boolean} [antialias=false]
- * @property {string} [canvas]
- * @property {boolean} [global=true]
- * @property {boolean} [tapEvents=true]
- * @property {boolean} [keyboardEvents=true]
- * @property {boolean} [animate=true]
- * @property {LitecanvasGameLoop} [loop]
- */
-
-/**
- * @typedef LitecanvasInstance
- * @type {object}
- */
-
-/**
- * @typedef LitecanvasGameLoop
- * @type {object}
- * @property {() => void} [init]
- * @property {(dt: number) => void} [update]
- * @property {() => void} [draw]
- * @property {() => void} [resized]
- * @property {(tapX: number, tapY: number, tapId: number) => void} [tap]
- * @property {(tapX: number, tapY: number, tapId: number) => void} [untap]
- * @property {(tapX: number, tapY: number, tapId: number) => void} [tapping]
- * @property {(tapX: number, tapY: number, tapId: number) => void} [tapped]
- */
-
-/**
- * @callback drawCallback
- * @param {CanvasRenderingContext2D|OffscreenCanvasRenderingContext2D} context
- * @returns {void}
- */
-
-/**
- * @typedef LitecanvasPluginHelpers
- * @type {object}
- * @property {string[]} colors The instance color palette
- * @property {LitecanvasOptions} settings Litecanvas instance settings (read-only)
- */
-
-/**
- * @callback pluginCallback
- * @param {LitecanvasInstance} instance The litecanvas instance
- * @param {LitecanvasPluginHelpers} helpers
- * @param {any?} [config] - option plugin configuration
- * @returns
- */