melonjs 15.15.0 → 16.1.0

package/dist/types/application/application.d.ts

@@ -102,7 +102,7 @@ export default class Application {
      * destroy all current objects
      */
     reset(): void;
-    set sortOn(arg: string);
+    set sortOn(value: string);
     /**
      * Specify the property to be used when sorting renderables for this application game world.
      * Accepted values : "x", "y", "z", "depth"

package/dist/types/application/settings.d.ts

@@ -17,6 +17,7 @@ export namespace defaultSettings {
     let verbose: boolean;
     let consoleHeader: boolean;
     let legacy: boolean;
+    let canvas: undefined;
 }
 /**
  * Application & Renderer Settings definition.
@@ -26,6 +27,10 @@ export type Settings = {
      * - the DOM parent element to hold the canvas in the HTML file
      */
     parent?: string | HTMLElement | undefined;
+    /**
+     * - an existing canvas element to use as the renderer target (by default melonJS will create its own canvas based on given parameters)
+     */
+    canvas?: HTMLCanvasElement | undefined;
     /**
      * - renderer to use (CANVAS, WEBGL, AUTO), or a custom renderer class
      */

package/dist/types/geometries/path2d.d.ts

@@ -3,6 +3,7 @@
  * a simplified path2d implementation, supporting only one path
  */
 export default class Path2D {
+    constructor(svgPath: any);
     /**
      * the points defining the current path
      * @type {Point[]}
@@ -17,6 +18,11 @@ export default class Path2D {
     vertices: any[];
     startPoint: object;
     isDirty: boolean;
+    /**
+     * Parses an SVG path string and adds the points to the current path.
+     * @param {string} svgPath - The SVG path string to parse.
+     */
+    parseSVGPath(svgPath: string): void;
     /**
      * begin a new path
      */
@@ -77,6 +83,24 @@ export default class Path2D {
      * @param {boolean} [anticlockwise=false] - an optional boolean value which, if true, draws the ellipse counterclockwise (anticlockwise).
      */
     ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, anticlockwise?: boolean | undefined): void;
+    /**
+     * Adds a quadratic Bézier curve to the path.
+     * @param {number} cpX - The x-coordinate of the control point.
+     * @param {number} cpY - The y-coordinate of the control point.
+     * @param {number} x - The x-coordinate of the end point of the curve.
+     * @param {number} y - The y-coordinate of the end point of the curve.
+     */
+    quadraticCurveTo(cpX: number, cpY: number, x: number, y: number): void;
+    /**
+     * Adds a cubic Bézier curve to the path.
+     * @param {number} cp1X - The x-coordinate of the first control point.
+     * @param {number} cp1Y - The y-coordinate of the first control point.
+     * @param {number} cp2X - The x-coordinate of the second control point.
+     * @param {number} cp2Y - The y-coordinate of the second control point.
+     * @param {number} x - The x-coordinate of the end point of the curve.
+     * @param {number} y - The y-coordinate of the end point of the curve.
+     */
+    bezierCurveTo(cp1X: number, cp1Y: number, cp2X: number, cp2Y: number, x: number, y: number): void;
     /**
      * creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
      * @param {number} x - the x-axis coordinate of the rectangle's starting point.

package/dist/types/geometries/rectangle.d.ts

@@ -42,25 +42,25 @@ export default class Rect extends Polygon {
      * @type {number}
      */
     get bottom(): number;
-    set width(arg: number);
+    set width(value: number);
     /**
      * width of the Rectangle
      * @type {number}
      */
     get width(): number;
-    set height(arg: number);
+    set height(value: number);
     /**
      * height of the Rectangle
      * @type {number}
      */
     get height(): number;
-    set centerX(arg: number);
+    set centerX(value: number);
     /**
      * absolute center of this rectangle on the horizontal axis
      * @type {number}
      */
     get centerX(): number;
-    set centerY(arg: number);
+    set centerY(value: number);
     /**
      * absolute center of this rectangle on the vertical axis
      * @type {number}

package/dist/types/geometries/roundrect.d.ts

@@ -12,7 +12,7 @@ export default class RoundRect extends Rect {
      * @param {number} [radius=20] - the radius of the rounded corner
      */
     constructor(x: number, y: number, width: number, height: number, radius?: number | undefined);
-    set radius(arg: number);
+    set radius(value: number);
     /**
      * the radius of the rounded corner
      * @type {number}

package/dist/types/geometries/toarccanvas.d.ts

@@ -0,0 +1,10 @@
+export function endpointToCenterParameterization(x1: any, y1: any, x2: any, y2: any, largeArcFlag: any, sweepFlag: any, srx: any, sry: any, xAxisRotationDeg: any): {
+    cx: any;
+    cy: any;
+    rx: number;
+    ry: number;
+    startAngle: number;
+    endAngle: number;
+    xAxisRotation: number;
+    anticlockwise: boolean;
+};

package/dist/types/loader/cache.d.ts

@@ -5,3 +5,4 @@ export let imgList: {};
 export let tmxList: {};
 export let binList: {};
 export let jsonList: {};
+export let videoList: {};

package/dist/types/loader/loader.d.ts

@@ -2,10 +2,12 @@
  * an asset definition to be used with the loader
  * @typedef {object} loader.Asset
  * @property {string} name - name of the asset
- * @property {string} type  - the type of the asset ("audio"|"binary"|"image"|"json"|"js"|"tmx"|"tmj"|"tsx"|"tsj"|"fontface")
+ * @property {string} type  - the type of the asset ("audio"|"binary"|"image"|"json"|"js"|"tmx"|"tmj"|"tsx"|"tsj"|"fontface"|"video")
  * @property {string} [src]  - path and/or file name of the resource (for audio assets only the path is required)
  * @property {string} [data]  - TMX data if not provided through a src url
- * @property {boolean} [stream=false] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+ * @property {boolean} [stream=false] - Set to true to not to wait for large audio or video file to be downloaded before playing.
+ * @property {boolean} [autoplay=false] - Set to true to automatically start playing audio or video when loaded or added to a scene (using autoplay might require user iteraction to enable it)
+ * @property {boolean} [loop=false] - Set to true to automatically loop the audio or video when playing
  * @see loader.preload
  * @see loader.load
  * @example
@@ -35,6 +37,8 @@
  *   {name: "plugin", type: "js", src: "data/js/plugin.js"}
  *   // Font Face
  *   { name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')" }
+ *   // video resources
+ *   {name: "intro", type: "video",  src: "data/video/"}
  */
 /**
  * specify a parser/preload function for the given asset type
@@ -91,7 +95,11 @@ export function setParser(type: string, parserFn: Function): void;
  *   // JavaScript file
  *   {name: "plugin", type: "js", src: "data/js/plugin.js"},
  *   // Font Face
- *   { name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')" }
+ *   {name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')"},
+ *   // video resources
+ *   {name: "intro", type: "video",  src: "data/video/"},
+ *   // base64 encoded video asset
+ *   me.loader.load({name: "avatar", type:"video", src: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDEAAAAIZnJlZ..."};
  * ];
  * ...
  * // set all resources to be loaded
@@ -127,6 +135,12 @@ export function reload(src: string): void;
  * me.loader.load({name: "avatar",  type:"image",  src: "data/avatar.png"}, () => this.onload(), () => this.onerror());
  * // load a base64 image asset
  *  me.loader.load({name: "avatar", type:"image", src: "data:image/png;base64,iVBORw0KAAAQAAAAEACA..."};
+ *  // load a base64 video asset
+ *  me.loader.load({
+ *     name: "avatar",
+ *     type:"video",
+ *     src: "data:video/mp4;base64,AAAAIGZ0eXBpc29tAAACAGlzb21pc28yYXZjMW1wNDEAAAAIZnJlZ.."
+ *  };
  * // start loading music
  * me.loader.load({
  *     name   : "bgmusic",
@@ -175,10 +189,17 @@ export function getImage(image: string): HTMLImageElement;
 /**
  * return the specified JSON Object
  * @memberof loader
- * @param {string} elt - name of the json file to load
- * @returns {object}
+ * @param {string} elt - name of the json file
+ * @returns {JSON}
+ */
+export function getJSON(elt: string): JSON;
+/**
+ * return the specified Video Object
+ * @memberof loader
+ * @param {string} elt - name of the video file
+ * @returns {HTMLVideoElement}
  */
-export function getJSON(elt: string): object;
+export function getVideo(elt: string): HTMLVideoElement;
 export * from "./settings.js";
 /**
  * onload callback
@@ -223,7 +244,7 @@ export namespace loader {
          */
         name: string;
         /**
-         * - the type of the asset ("audio"|"binary"|"image"|"json"|"js"|"tmx"|"tmj"|"tsx"|"tsj"|"fontface")
+         * - the type of the asset ("audio"|"binary"|"image"|"json"|"js"|"tmx"|"tmj"|"tsx"|"tsj"|"fontface"|"video")
          */
         type: string;
         /**
@@ -235,8 +256,16 @@ export namespace loader {
          */
         data?: string | undefined;
         /**
-         * - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+         * - Set to true to not to wait for large audio or video file to be downloaded before playing.
          */
         stream?: boolean | undefined;
+        /**
+         * - Set to true to automatically start playing audio or video when loaded or added to a scene (using autoplay might require user iteraction to enable it)
+         */
+        autoplay?: boolean | undefined;
+        /**
+         * - Set to true to automatically loop the audio or video when playing
+         */
+        loop?: boolean | undefined;
     };
 }

package/dist/types/loader/parsers/binary.d.ts

@@ -7,11 +7,3 @@
  * @ignore
  */
 export function preloadBinary(data: loader.Asset, onload?: Function | undefined, onerror?: Function | undefined): number;
-/**
- * parse/preload a Javascript files
- * @param {loader.Asset} data - asset data
- * @param {Function} [onload] - function to be called when the asset is loaded
- * @param {Function} [onerror] - function to be called in case of error
- * @ignore
- */
-export function preloadJavascript(data: loader.Asset, onload?: Function | undefined, onerror?: Function | undefined): number;

package/dist/types/loader/parsers/fetchdata.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Fetches data from the specified URL.
+ * @param {string} url - The URL to fetch the data from.
+ * @param {string} responseType - The type of response expected ('json', 'text', 'blob', 'arrayBuffer').
+ * @returns {Promise} A promise that resolves with the fetched data or rejects with an error.
+ * @example
+ * fetchData('https://api.example.com/data', 'json')
+ *     .then(data => {
+ *         // Handle the fetched JSON data
+ *     })
+ *     .catch(error => {
+ *         // Handle the error
+ *     });
+ */
+export function fetchData(url: string, responseType: string): Promise<any>;

package/dist/types/loader/parsers/tmx.d.ts

@@ -3,6 +3,7 @@
  * @param {loader.Asset} data - asset data
  * @param {Function} [onload] - function to be called when the asset is loaded
  * @param {Function} [onerror] - function to be called in case of error
+ * @param {Function} [fetchData] - function to use instead of default window.fetch, has some error handling and things
  * @returns {number} the amount of corresponding resource parsed/preloaded
  * @ignore
  */

package/dist/types/loader/parsers/video.d.ts

@@ -0,0 +1,9 @@
+/**
+ * parse/preload a Video file
+ * @param {loader.Asset} data - asset data
+ * @param {Function} [onload] - function to be called when the asset is loaded
+ * @param {Function} [onerror] - function to be called in case of error
+ * @returns {number} the amount of corresponding resource parsed/preloaded
+ * @ignore
+ */
+export function preloadVideo(data: loader.Asset, onload?: Function | undefined, onerror?: Function | undefined): number;

package/dist/types/loader/settings.d.ts

@@ -9,7 +9,7 @@ export function setNocache(enable?: boolean): void;
  * @name setBaseURL
  * @memberof loader
  * @public
- * @param {string} type  - "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
+ * @param {string} type  - "*", "audio", "video", "binary", "image", "json", "js", "tmx", "tsx"
  * @param {string} [url="./"] - default base URL
  * @example
  * // change the base URL relative address for audio assets
@@ -21,7 +21,7 @@ export function setBaseURL(type: string, url?: string | undefined): void;
 export let nocache: string;
 export let baseURL: {};
 /**
- * crossOrigin attribute to configure the CORS requests for Image data element.
+ * crossOrigin attribute to configure the CORS requests for Image and Video data element.
  * By default (that is, when the attribute is not specified), CORS is not used at all.
  * The "anonymous" keyword means that there will be no exchange of user credentials via cookies,
  * client-side SSL certificates or HTTP authentication as described in the Terminology section of the CORS specification.<br>
@@ -31,7 +31,7 @@ export let baseURL: {};
  * @memberof loader
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes
  * @example
- *  // allow for cross-origin texture loading in WebGL
+ *  // allow for cross-origin texture loading
  * me.loader.crossOrigin = "anonymous";
  *
  * // set all ressources to be loaded

package/dist/types/math/color.d.ts

@@ -15,25 +15,25 @@ export default class Color {
      */
     onResetEvent(r?: number, g?: number, b?: number, alpha?: number): void;
     glArray: Float32Array | undefined;
-    set r(arg: number);
+    set r(value: number);
     /**
      * Color Red Component [0 .. 255]
      * @type {number}
      */
     get r(): number;
-    set g(arg: number);
+    set g(value: number);
     /**
      * Color Green Component [0 .. 255]
      * @type {number}
      */
     get g(): number;
-    set b(arg: number);
+    set b(value: number);
     /**
      * Color Blue Component [0 .. 255]
      * @type {number}
      */
     get b(): number;
-    set alpha(arg: number);
+    set alpha(value: number);
     /**
      * Color Alpha Component [0.0 .. 1.0]
      * @type {number}

package/dist/types/math/math.d.ts

@@ -119,6 +119,12 @@ export function round(num: number, dec?: number | undefined): number;
  * }
  */
 export function toBeCloseTo(expected: number, actual: number, precision?: number | undefined): boolean;
+/**
+ * Calculates the power of a number.
+ * @param {number} n - The number to be raised to the power of 2.
+ * @returns {number} The result of raising the number to the power of 2.
+ */
+export function pow(n: number): number;
 /**
  * a collection of math utility functions
  * @namespace Math

package/dist/types/math/observable_vector2.d.ts

@@ -19,7 +19,7 @@ export default class ObservableVector2d extends Vector2d {
      * @ignore
      */
     onResetEvent(x: number | undefined, y: number | undefined, settings: any): void;
-    public set x(arg: number);
+    public set x(value: number);
     /**
      * x value of the vector
      * @public
@@ -29,7 +29,7 @@ export default class ObservableVector2d extends Vector2d {
      */
     public get x(): number;
     _x: any;
-    public set y(arg: number);
+    public set y(value: number);
     /**
      * y value of the vector
      * @public

package/dist/types/math/observable_vector3.d.ts

@@ -20,7 +20,7 @@ export default class ObservableVector3d extends Vector3d {
      * @ignore
      */
     onResetEvent(x: number | undefined, y: number | undefined, z: number | undefined, settings: any): this;
-    public set x(arg: number);
+    public set x(value: number);
     /**
      * x value of the vector
      * @public
@@ -30,7 +30,7 @@ export default class ObservableVector3d extends Vector3d {
      */
     public get x(): number;
     _x: any;
-    public set y(arg: number);
+    public set y(value: number);
     /**
      * y value of the vector
      * @public
@@ -40,7 +40,7 @@ export default class ObservableVector3d extends Vector3d {
      */
     public get y(): number;
     _y: any;
-    public set z(arg: number);
+    public set z(value: number);
     /**
      * z value of the vector
      * @public

package/dist/types/physics/bounds.d.ts

@@ -38,25 +38,25 @@ export default class Bounds {
      * @param {number} maxY
      */
     setMinMax(minX: number, minY: number, maxX: number, maxY: number): void;
-    set x(arg: number);
+    set x(value: number);
     /**
      * x position of the bound
      * @type {number}
      */
     get x(): number;
-    set y(arg: number);
+    set y(value: number);
     /**
      * y position of the bounds
      * @type {number}
      */
     get y(): number;
-    set width(arg: number);
+    set width(value: number);
     /**
      * width of the bounds
      * @type {number}
      */
     get width(): number;
-    set height(arg: number);
+    set height(value: number);
     /**
      * width of the bounds
      * @type {number}

package/dist/types/renderable/entity/entity.d.ts

@@ -39,7 +39,7 @@ export default class Entity extends Renderable {
      * @ignore
      */
     children: any[];
-    set renderable(arg: Renderable);
+    set renderable(value: Renderable);
     /**
      * The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
      * @type {Renderable}

package/dist/types/renderable/imagelayer.d.ts

@@ -40,7 +40,7 @@ export default class ImageLayer extends Sprite {
      * @default <1.0,1.0>
      */
     ratio: Vector2d;
-    set repeat(arg: string);
+    set repeat(value: string);
     /**
      * Define if and how an Image Layer should be repeated.<br>
      * By default, an Image Layer is repeated both vertically and horizontally.<br>

package/dist/types/renderable/nineslicesprite.d.ts

@@ -47,6 +47,18 @@ export default class NineSliceSprite extends Sprite {
         flipY?: number | undefined;
         anchorPoint?: any;
     });
+    set width(value: number);
+    /**
+     * width of the NineSliceSprite
+     * @type {number}
+     */
+    get width(): number;
+    set height(value: number);
+    /**
+     * height of the NineSliceSprite
+     * @type {number}
+     */
+    get height(): number;
     nss_width: number;
     nss_height: number;
     insetx: number | undefined;

package/dist/types/renderable/renderable.d.ts

@@ -212,7 +212,7 @@ export default class Renderable extends Rect {
      * @type {boolean}
      */
     get isFloating(): boolean;
-    set tint(arg: Color);
+    set tint(value: Color);
     /**
      * define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
      * @type {Color}
@@ -224,13 +224,13 @@ export default class Renderable extends Rect {
      * this.tint.setColor(255, 255, 255);
      */
     get tint(): Color;
-    set depth(arg: number);
+    set depth(value: number);
     /**
      * the depth of this renderable on the z axis
      * @type {number}
      */
     get depth(): number;
-    set inViewport(arg: boolean);
+    set inViewport(value: boolean);
     /**
      * Whether the renderable object is visible and within the viewport
      * @type {boolean}