melonjs 14.3.0 → 14.5.0

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;

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

@@ -0,0 +1,57 @@
+/**
+ * enable the nocache mechanism
+ * @ignore
+ */
+export function setNocache(enable?: boolean): 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/")
+ */
+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.
+ * 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>
+ * @type {string}
+ * @name crossOrigin
+ * @default undefined
+ * @memberof loader
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes
+ * @example
+ *  // allow for cross-origin texture loading in WebGL
+ * me.loader.crossOrigin = "anonymous";
+ *
+ * // set all ressources to be loaded
+ * me.loader.preload(game.resources, this.loaded.bind(this));
+ */
+export let crossOrigin: string;
+/**
+ * indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies,
+ * authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.
+ * @public
+ * @type {boolean}
+ * @name withCredentials
+ * @default false
+ * @memberof loader
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
+ * @example
+ *  // enable withCredentials
+ * me.loader.withCredentials = true;
+ *
+ * // set all ressources to be loaded
+ * me.loader.preload(game.resources, this.loaded.bind(this));
+ */
+export let withCredentials: boolean;

package/dist/types/particles/emitter.d.ts

@@ -168,18 +168,18 @@ export default class ParticleEmitter extends Container {
     isRunning(): boolean;
     /**
      * Launch particles from emitter constantly (e.g. for stream)
-     * @param {number} duration - [optional] time that the emitter releases particles in ms
+     * @param {number} [duration] - time that the emitter releases particles in ms
      */
-    streamParticles(duration: number): void;
+    streamParticles(duration?: number | undefined): void;
     /**
      * Stop the emitter from generating new particles (used only if emitter is Stream)
      */
     stopStream(): void;
     /**
      * Launch all particles from emitter and stop (e.g. for explosion)
-     * @param {number} total - [optional] number of particles to launch
+     * @param {number} [total] - number of particles to launch
      */
-    burstParticles(total: number): void;
+    burstParticles(total?: number | undefined): void;
     /**
      * @ignore
      */