melonjs 14.4.0 → 14.5.0

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

@@ -78,13 +78,13 @@ export default class Entity extends Renderable {
     /** @ignore */
     update(dt: any): boolean;
     /**
-     * update the bounds position when the body is modified
+     * update the bounds when the body is modified
      * @ignore
      * @name onBodyUpdate
      * @memberof Entity
      * @param {Body} body - the body whose bounds to update
      */
-    onBodyUpdate(body: Body): void;
+    onBodyUpdate(): void;
     preDraw(renderer: any): void;
     /**
      * onDeactivateEvent Notification function<br>

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

@@ -5,55 +5,39 @@
 export default class Path2D {
     /**
      * the points defining the current path
-     * @public
-     * @type {Vector2d[]}
-     * @name points
-     * @memberof Path2D#
+     * @type {Point[]}
      */
-    public points: Vector2d[];
+    points: Point[];
     /**
      * space between interpolated points for quadratic and bezier curve approx. in pixels.
-     * @public
      * @type {number}
-     * @name arcResolution
      * @default 5
-     * @memberof Path2D#
      */
-    public arcResolution: number;
+    arcResolution: number;
     vertices: any[];
     /**
      * begin a new path
-     * @name beginPath
-     * @memberof Path2D
      */
     beginPath(): void;
     /**
      * causes the point of the pen to move back to the start of the current path.
      * It tries to draw a straight line from the current point to the start.
      * If the shape has already been closed or has only one point, this function does nothing.
-     * @name closePath
-     * @memberof Path2D
      */
     closePath(): void;
     /**
      * triangulate the shape defined by this path into an array of triangles
-     * @name triangulatePath
-     * @memberof Path2D
-     * @returns {Vector2d[]}
+     * @returns {Point[]}
      */
-    triangulatePath(): Vector2d[];
+    triangulatePath(): Point[];
     /**
      * moves the starting point of the current path to the (x, y) coordinates.
-     * @name moveTo
-     * @memberof Path2D
      * @param {number} x - the x-axis (horizontal) coordinate of the point.
      * @param {number} y - the y-axis (vertical) coordinate of the point.
      */
     moveTo(x: number, y: number): void;
     /**
      * connects the last point in the current patch to the (x, y) coordinates with a straight line.
-     * @name lineTo
-     * @memberof Path2D
      * @param {number} x - the x-axis coordinate of the line's end point.
      * @param {number} y - the y-axis coordinate of the line's end point.
      */
@@ -61,8 +45,6 @@ export default class Path2D {
     /**
      * adds an arc to the current path which is centered at (x, y) position with the given radius,
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise (defaulting to clockwise).
-     * @name arc
-     * @memberof Path2D
      * @param {number} x - the horizontal coordinate of the arc's center.
      * @param {number} y - the vertical coordinate of the arc's center.
      * @param {number} radius - the arc's radius. Must be positive.
@@ -73,8 +55,6 @@ export default class Path2D {
     arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean | undefined): void;
     /**
      * adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight line.
-     * @name arcTo
-     * @memberof Path2D
      * @param {number} x1 - the x-axis coordinate of the first control point.
      * @param {number} y1 - the y-axis coordinate of the first control point.
      * @param {number} x2 - the x-axis coordinate of the second control point.
@@ -85,8 +65,6 @@ export default class Path2D {
     /**
      * adds an elliptical arc to the path which is centered at (x, y) position with the radii radiusX and radiusY
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise.
-     * @name ellipse
-     * @memberof Path2D
      * @param {number} x - the x-axis (horizontal) coordinate of the ellipse's center.
      * @param {number} y - the  y-axis (vertical) coordinate of the ellipse's center.
      * @param {number} radiusX - the ellipse's major-axis radius. Must be non-negative.
@@ -99,8 +77,6 @@ export default class Path2D {
     ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, anticlockwise?: boolean | undefined): void;
     /**
      * creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
-     * @name rect
-     * @memberof Path2D
      * @param {number} x - the x-axis coordinate of the rectangle's starting point.
      * @param {number} y - the y-axis coordinate of the rectangle's starting point.
      * @param {number} width - the rectangle's width. Positive values are to the right, and negative to the left.
@@ -109,8 +85,6 @@ export default class Path2D {
     rect(x: number, y: number, width: number, height: number): void;
     /**
      * adds an rounded rectangle to the current path.
-     * @name roundRect
-     * @memberof Path2D
      * @param {number} x - the x-axis coordinate of the rectangle's starting point.
      * @param {number} y - the y-axis coordinate of the rectangle's starting point.
      * @param {number} width - the rectangle's width. Positive values are to the right, and negative to the left.

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

@@ -6,18 +6,16 @@ export default class Point {
     constructor(x?: number, y?: number);
     /**
      * the position of the point on the horizontal axis
-     * @public
      * @type {Number}
      * @default 0
      */
-    public x: number;
+    x: number;
     /**
      * the position of the point on the vertical axis
-     * @public
      * @type {Number}
      * @default 0
      */
-    public y: number;
+    y: number;
     /** @ignore */
     onResetEvent(x?: number, y?: number): void;
     /**
@@ -37,8 +35,6 @@ export default class Point {
      */
     /**
      * return true if this point is equal to the given values
-     * @name equals
-     * @memberof Point
      * @param {number} x
      * @param {number} y
      * @returns {boolean}
@@ -46,7 +42,6 @@ export default class Point {
     equals(...args: any[]): boolean;
     /**
      * clone this Point
-     * @name clone
      * @returns {Point} new Point
      */
     clone(): Point;

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

@@ -205,7 +205,6 @@ export default class Polygon {
     _bounds: object | undefined;
     /**
      * update the bounding box for this shape.
-     * @ignore
      * @name updateBounds
      * @memberof Polygon
      * @returns {Bounds} this shape bounding box Rectangle object

package/dist/types/index.d.ts

@@ -36,7 +36,7 @@ import * as audio from "./audio/audio.js";
 import collision from "./physics/collision.js";
 import * as device from "./system/device.js";
 import * as event from "./system/event.js";
-import loader from "./loader/loader.js";
+import * as loader from "./loader/loader.js";
 import level from "./level/level.js";
 import * as input from "./input/input.js";
 import * as Math from "./math/math.js";
@@ -64,7 +64,7 @@ import RoundRect from "./geometries/roundrect.js";
 import Tween from "./tweens/tween.js";
 import QuadTree from "./physics/quadtree.js";
 import GLShader from "./video/webgl/glshader.js";
-import WebGLCompositor from "./video/webgl/webgl_compositor.js";
+import WebGLCompositor from "./video/webgl/compositors/webgl_compositor.js";
 import Renderer from "./video/renderer.js";
 import WebGLRenderer from "./video/webgl/webgl_renderer.js";
 import CanvasRenderer from "./video/canvas/canvas_renderer.js";

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

@@ -0,0 +1,7 @@
+/**
+ * where all preloaded content is cached
+ */
+export let imgList: {};
+export let tmxList: {};
+export let binList: {};
+export let jsonList: {};

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

@@ -1,181 +1,166 @@
-export default loader;
-declare namespace loader {
-    const nocache: string;
-    const onload: undefined;
-    const onProgress: undefined;
-    const crossOrigin: string;
-    const withCredentials: boolean;
-    /**
-     * just increment the number of already loaded resources
-     * @ignore
-     */
-    function onResourceLoaded(res: any): void;
-    /**
-     * on error callback for image loading
-     * @ignore
-     */
-    function onLoadingError(res: any): never;
-    /**
-     * enable the nocache mechanism
-     * @ignore
-     */
-    function setNocache(enable: any): void;
-    /**
-     * change the default baseURL for the given asset type.<br>
-     * (this will prepend the asset URL and must finish with a '/')
-     * @name setBaseURL
-     * @memberof loader
-     * @public
-     * @param {string} type  - "*", "audio", binary", "image", "json", "js", "tmx", "tsx"
-     * @param {string} [url="./"] - default base URL
-     * @example
-     * // change the base URL relative address for audio assets
-     * me.loader.setBaseURL("audio", "data/audio/");
-     * // change the base URL absolute address for all object types
-     * me.loader.setBaseURL("*", "http://myurl.com/")
-     */
-    function setBaseURL(type: string, url?: string | undefined): void;
-    /**
-     * set all the specified game resources to be preloaded.
-     * @name preload
-     * @memberof loader
-     * @public
-     * @param {object[]} res
-     * @param {string} res.name - internal name of the resource
-     * @param {string} res.type  - "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
-     * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
-     * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {Function} [onload=loader.onload] - function to be called when all resources are loaded
-     * @param {boolean} [switchToLoadState=true] - automatically switch to the loading screen
-     * @example
-     * game_resources = [
-     *   // PNG tileset
-     *   {name: "tileset-platformer", type: "image",  src: "data/map/tileset.png"},
-     *   // PNG packed texture
-     *   {name: "texture", type:"image", src: "data/gfx/texture.png"}
-     *   // PNG base64 encoded image
-     *   {name: "texture", type:"image", src: "data:image/png;base64,iVBORw0KAAAQAAAAEACA..."}
-     *   // TSX file
-     *   {name: "meta_tiles", type: "tsx", src: "data/map/meta_tiles.tsx"},
-     *   // TMX level (XML & JSON)
-     *   {name: "map1", type: "tmx", src: "data/map/map1.json"},
-     *   {name: "map2", type: "tmx", src: "data/map/map2.tmx"},
-     *   {name: "map3", type: "tmx", format: "json", data: {"height":15,"layers":[...],"tilewidth":32,"version":1,"width":20}},
-     *   {name: "map4", type: "tmx", format: "xml", data: {xml representation of tmx}},
-     *   // audio resources
-     *   {name: "bgmusic", type: "audio",  src: "data/audio/"},
-     *   {name: "cling",   type: "audio",  src: "data/audio/"},
-     *   // base64 encoded audio resources
-     *   {name: "band",   type: "audio",  src: "data:audio/wav;base64,..."},
-     *   // binary file
-     *   {name: "ymTrack", type: "binary", src: "data/audio/main.ym"},
-     *   // JSON file (used for texturePacker)
-     *   {name: "texture", type: "json", src: "data/gfx/texture.json"},
-     *   // JavaScript file
-     *   {name: "plugin", type: "js", src: "data/js/plugin.js"},
-     *   // Font Face
-     *   { name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')" }
-     * ];
-     * ...
-     * // set all resources to be loaded
-     * me.loader.preload(game.resources, this.loaded.bind(this));
-     */
-    function preload(res: {
-        name: string;
-        type: string;
-        src: string;
-        stream?: boolean | undefined;
-    }[], onload?: Function | undefined, switchToLoadState?: boolean | undefined): void;
-    /**
-     * Load a single resource (to be used if you need to load additional resource during the game)
-     * @name load
-     * @memberof loader
-     * @public
-     * @param {object} res
-     * @param {string} res.name - internal name of the resource
-     * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
-     * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
-     * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
-     * @param {Function} [onload] - function to be called when the resource is loaded
-     * @param {Function} [onerror] - function to be called in case of error
-     * @returns {number} the amount of corresponding resource to be preloaded
-     * @example
-     * // load an image asset
-     * me.loader.load({name: "avatar",  type:"image",  src: "data/avatar.png"}, this.onload.bind(this), this.onerror.bind(this));
-     * // load a base64 image asset
-     *  me.loader.load({name: "avatar", type:"image", src: "data:image/png;base64,iVBORw0KAAAQAAAAEACA..."};
-     * // start loading music
-     * me.loader.load({
-     *     name   : "bgmusic",
-     *     type   : "audio",
-     *     src    : "data/audio/"
-     * }, function () {
-     *     me.audio.play("bgmusic");
-     * });
-     */
-    function load(res: {
-        name: string;
-        type: string;
-        src: string;
-        stream?: boolean | undefined;
-    }, onload?: Function | undefined, onerror?: Function | undefined): number;
-    /**
-     * unload specified resource to free memory
-     * @name unload
-     * @memberof loader
-     * @public
-     * @param {object} res
-     * @param {string} res.name - internal name of the resource
-     * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
-     * @returns {boolean} true if unloaded
-     * @example me.loader.unload({name: "avatar",  type:"image"});
-     */
-    function unload(res: {
-        name: string;
-        type: string;
-    }): boolean;
-    /**
-     * unload all resources to free memory
-     * @name unloadAll
-     * @memberof loader
-     * @public
-     * @example me.loader.unloadAll();
-     */
-    function unloadAll(): void;
-    /**
-     * return the specified TMX/TSX object
-     * @name getTMX
-     * @memberof loader
-     * @public
-     * @param {string} elt - name of the tmx/tsx element ("map1");
-     * @returns {object} requested element or null if not found
-     */
-    function getTMX(elt: string): object;
-    /**
-     * return the specified Binary object
-     * @name getBinary
-     * @memberof loader
-     * @public
-     * @param {string} elt - name of the binary object ("ymTrack");
-     * @returns {object} requested element or null if not found
-     */
-    function getBinary(elt: string): object;
-    /**
-     * return the specified Image Object
-     * @name getImage
-     * @memberof loader
-     * @public
-     * @param {string} image - name of the Image element ("tileset-platformer");
-     * @returns {HTMLImageElement} requested element or null if not found
-     */
-    function getImage(image: string): HTMLImageElement;
-    /**
-     * return the specified JSON Object
-     * @name getJSON
-     * @memberof loader
-     * @public
-     * @param {string} elt - name of the json file to load
-     * @returns {object}
-     */
-    function getJSON(elt: string): object;
-}
+/**
+ * set all the specified game resources to be preloaded.
+ * @name preload
+ * @memberof loader
+ * @public
+ * @param {object[]} res
+ * @param {string} res.name - internal name of the resource
+ * @param {string} res.type  - "audio", binary", "image", "json","js", "tmx", "tsx", "fontface"
+ * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
+ * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+ * @param {Function} [onload=loader.onload] - function to be called when all resources are loaded
+ * @param {boolean} [switchToLoadState=true] - automatically switch to the loading screen
+ * @example
+ * game_resources = [
+ *   // PNG tileset
+ *   {name: "tileset-platformer", type: "image",  src: "data/map/tileset.png"},
+ *   // PNG packed texture
+ *   {name: "texture", type:"image", src: "data/gfx/texture.png"}
+ *   // PNG base64 encoded image
+ *   {name: "texture", type:"image", src: "data:image/png;base64,iVBORw0KAAAQAAAAEACA..."}
+ *   // TSX file
+ *   {name: "meta_tiles", type: "tsx", src: "data/map/meta_tiles.tsx"},
+ *   // TMX level (XML & JSON)
+ *   {name: "map1", type: "tmx", src: "data/map/map1.json"},
+ *   {name: "map2", type: "tmx", src: "data/map/map2.tmx"},
+ *   {name: "map3", type: "tmx", format: "json", data: {"height":15,"layers":[...],"tilewidth":32,"version":1,"width":20}},
+ *   {name: "map4", type: "tmx", format: "xml", data: {xml representation of tmx}},
+ *   // audio resources
+ *   {name: "bgmusic", type: "audio",  src: "data/audio/"},
+ *   {name: "cling",   type: "audio",  src: "data/audio/"},
+ *   // base64 encoded audio resources
+ *   {name: "band",   type: "audio",  src: "data:audio/wav;base64,..."},
+ *   // binary file
+ *   {name: "ymTrack", type: "binary", src: "data/audio/main.ym"},
+ *   // JSON file (used for texturePacker)
+ *   {name: "texture", type: "json", src: "data/gfx/texture.json"},
+ *   // JavaScript file
+ *   {name: "plugin", type: "js", src: "data/js/plugin.js"},
+ *   // Font Face
+ *   { name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')" }
+ * ];
+ * ...
+ * // set all resources to be loaded
+ * me.loader.preload(game.resources, this.loaded.bind(this));
+ */
+export function preload(res: {
+    name: string;
+    type: string;
+    src: string;
+    stream?: boolean;
+}, onloadcb: any, switchToLoadState?: boolean | undefined): void;
+/**
+ * Load a single resource (to be used if you need to load additional resource during the game)
+ * @name load
+ * @memberof loader
+ * @public
+ * @param {object} res
+ * @param {string} res.name - internal name of the resource
+ * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
+ * @param {string} res.src  - path and/or file name of the resource (for audio assets only the path is required)
+ * @param {boolean} [res.stream] - Set to true to force HTML5 Audio, which allows not to wait for large file to be downloaded before playing.
+ * @param {Function} [onload] - function to be called when the resource is loaded
+ * @param {Function} [onerror] - function to be called in case of error
+ * @returns {number} the amount of corresponding resource to be preloaded
+ * @example
+ * // load an image asset
+ * me.loader.load({name: "avatar",  type:"image",  src: "data/avatar.png"}, this.onload.bind(this), this.onerror.bind(this));
+ * // load a base64 image asset
+ *  me.loader.load({name: "avatar", type:"image", src: "data:image/png;base64,iVBORw0KAAAQAAAAEACA..."};
+ * // start loading music
+ * me.loader.load({
+ *     name   : "bgmusic",
+ *     type   : "audio",
+ *     src    : "data/audio/"
+ * }, function () {
+ *     me.audio.play("bgmusic");
+ * });
+ */
+export function load(res: {
+    name: string;
+    type: string;
+    src: string;
+    stream?: boolean | undefined;
+}, onload?: Function | undefined, onerror?: Function | undefined): number;
+/**
+ * unload specified resource to free memory
+ * @name unload
+ * @memberof loader
+ * @public
+ * @param {object} res
+ * @param {string} res.name - internal name of the resource
+ * @param {string} res.type  - "audio", binary", "image", "json", "tmx", "tsx"
+ * @returns {boolean} true if unloaded
+ * @example me.loader.unload({name: "avatar",  type:"image"});
+ */
+export function unload(res: {
+    name: string;
+    type: string;
+}): boolean;
+/**
+ * unload all resources to free memory
+ * @name unloadAll
+ * @memberof loader
+ * @public
+ * @example me.loader.unloadAll();
+ */
+export function unloadAll(): void;
+/**
+ * return the specified TMX/TSX object
+ * @name getTMX
+ * @memberof loader
+ * @public
+ * @param {string} elt - name of the tmx/tsx element ("map1");
+ * @returns {object} requested element or null if not found
+ */
+export function getTMX(elt: string): object;
+/**
+ * return the specified Binary object
+ * @name getBinary
+ * @memberof loader
+ * @public
+ * @param {string} elt - name of the binary object ("ymTrack");
+ * @returns {object} requested element or null if not found
+ */
+export function getBinary(elt: string): object;
+/**
+ * return the specified Image Object
+ * @name getImage
+ * @memberof loader
+ * @public
+ * @param {string} image - name of the Image element ("tileset-platformer");
+ * @returns {HTMLImageElement} requested element or null if not found
+ */
+export function getImage(image: string): HTMLImageElement;
+/**
+ * return the specified JSON Object
+ * @name getJSON
+ * @memberof loader
+ * @public
+ * @param {string} elt - name of the json file to load
+ * @returns {object}
+ */
+export function getJSON(elt: string): object;
+export * from "./settings.js";
+/**
+ * onload callback
+ * @name onload
+ * @default undefined
+ * @memberof loader
+ * @example
+ * // set a callback when everything is loaded
+ * me.loader.onload = this.loaded.bind(this);
+ */
+export let onload: any;
+/**
+ * onProgress callback<br>
+ * each time a resource is loaded, the loader will fire the specified function,
+ * giving the actual progress [0 ... 1], as argument, and an object describing the resource loaded
+ * @name onProgress
+ * @default undefined
+ * @memberof loader
+ * @example
+ * // set a callback for progress notification
+ * me.loader.onProgress = this.updateProgress.bind(this);
+ */
+export let onProgress: any;

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

@@ -0,0 +1,41 @@
+/**
+ * load Images
+ * @example
+ * preloadImages([
+ *     { name : 'image1', src : 'images/image1.png'},
+ *     { name : 'image2', src : 'images/image2.png'},
+ *     { name : 'image3', src : 'images/image3.png'},
+ *     { name : 'image4', src : 'images/image4.png'}
+ * ]);
+ * @ignore
+ */
+export function preloadImage(img: any, onload: any, onerror: any): void;
+/**
+ * load a font face
+ * @example
+ * preloadFontFace(
+ *     name: "'kenpixel'", type: "fontface",  src: "url('data/font/kenvector_future.woff2')"
+ * ]);
+ * @ignore
+ */
+export function preloadFontFace(data: any, onload: any, onerror: any): void;
+/**
+ * preload TMX files
+ * @ignore
+ */
+export function preloadTMX(tmxData: any, onload: any, onerror: any): void;
+/**
+ * preload JSON files
+ * @ignore
+ */
+export function preloadJSON(data: any, onload: any, onerror: any): void;
+/**
+ * preload Binary files
+ * @ignore
+ */
+export function preloadBinary(data: any, onload: any, onerror: any): void;
+/**
+ * preload Binary files
+ * @ignore
+ */
+export function preloadJavascript(data: any, onload: any, onerror: any): void;