melonjs 17.4.0 → 18.0.0

package/{dist/types → build}/application/application.d.ts

@@ -4,9 +4,8 @@
  * @import Camera2d from "./../camera/camera2d.js";
  */
 /**
- * @classdesc
  * An Application represents a single melonJS game, and is responsible for updating (each frame) all the related object status and draw them.
- * @see game
+ * @see {@link game}
  */
 export default class Application {
     /**
@@ -15,7 +14,7 @@ export default class Application {
      * @param {ApplicationSettings} [options] - The optional parameters for the application and default renderer
      * @throws Will throw an exception if it fails to instantiate a renderer
      */
-    constructor(width: number, height: number, options?: ApplicationSettings | undefined);
+    constructor(width: number, height: number, options?: ApplicationSettings);
     /**
      * the parent HTML element holding the main canvas of this application
      * @type {HTMLElement}
@@ -101,7 +100,7 @@ export default class Application {
      * @param {number} height - The height of the canvas viewport
      * @param {ApplicationSettings} [options] - The optional parameters for the application and default renderer
      */
-    init(width: number, height: number, options?: ApplicationSettings | undefined): void;
+    init(width: number, height: number, options?: ApplicationSettings): void;
     /**
      * reset the game Object manager
      * destroy all current objects
@@ -112,7 +111,7 @@ export default class Application {
      * Specify the property to be used when sorting renderables for this application game world.
      * Accepted values : "x", "y", "z", "depth"
      * @type {string}
-     * @see World.sortOn
+     * @see {@link World.sortOn}
      */
     get sortOn(): string;
     /**
@@ -125,8 +124,8 @@ export default class Application {
     onLevelLoaded(): void;
     /**
      * Update the renderer framerate using the system config variables.
-     * @see timer.maxfps
-     * @see World.fps
+     * @see {@link timer.maxfps}
+     * @see {@link World.fps}
      */
     updateFrameRate(): void;
     /**
@@ -148,8 +147,8 @@ export default class Application {
      */
     draw(): void;
 }
-import CanvasRenderer from "./../video/canvas/canvas_renderer.js";
+import CanvasRenderer from "../video/canvas/canvas_renderer.js";
 import type WebGLRenderer from "./../video/webgl/webgl_renderer.js";
 import type Camera2d from "./../camera/camera2d.js";
-import World from "./../physics/world.js";
-import { ApplicationSettings } from "./settings.js";
+import World from "../physics/world.js";
+//# sourceMappingURL=application.d.ts.map

package/build/application/application.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/application/application.js"],"names":[],"mappings":"AAgCA;;;;GAIG;AAEH;;;GAGG;AACH;IACC;;;;;OAKG;IACH,mBALW,MAAM,UACN,MAAM,YACN,mBAAmB,EA8G7B;IA1GA;;;OAGG;IACH,eAFU,WAAW,CAES;IAE9B;;;OAGG;IACH,UAFU,cAAc,GAAC,aAAa,CAEb;IAEzB;;;OAGG;IACH,UAFU,QAAQ,CAEO;IAEzB;;;;OAIG;IACH,OAFU,KAAK,CAEO;IAEtB;;;;;OAKG;IACH,YAHU,OAAO,CAGK;IAEtB;;;;;;OAMG;IACH,YAFU,mBAAmB,CAEV;IAEnB;;;;OAIG;IACH,eAHU,OAAO,CAGS;IAE1B;;;OAGG;IACH,UAFU,mBAAmB,CAEJ;IAEzB;;;;;;;OAOG;IACH,aANU,OAAO,CAMM;IAEvB;;;;OAIG;IACH,eAHU,OAAO,CAGQ;IAEzB;;;;OAIG;IACH,YAHU,OAAO,CAGM;IAGvB,iBAAmB;IAGnB,uBAA0B;IAI1B,qBAAqB;IACrB,kBAAkB;IAGlB,oBAAsB;IACtB,uBAAyB;IACzB,+BAA+B;IAG/B,iBAAyB;IACzB,oBAAoB;IACpB,+BAA2B;IAC3B,2BAA2B;IAS5B;;;;;OAKG;IACH,YAJW,MAAM,UACN,MAAM,YACN,mBAAmB,QA6J7B;IAED;;;OAGG;IACH,cAYC;IAWD,kBANU,MAAM,EAQf;IAXD;;;;;OAKG;IACH,cAHU,MAAM,CAKf;IAKD;;;;;;OAMG;IACH,sBAAkB;IAElB;;;;OAIG;IACH,wBAaC;IAED;;;OAGG;IACH,oBAFa,WAAW,CAIvB;IAED;;OAEG;IACH,gBAEC;IAED;;;OAGG;IACH,aAFW,MAAM,QA8ChB;IAED;;OAEG;IACH,aAuBC;CACD;2BAhc0B,oCAAoC;+BASjC,oCAAoC;0BACzC,yBAAyB;kBAlChC,qBAAqB"}

package/build/application/defaultApplicationSettings.d.ts

@@ -0,0 +1,18 @@
+export declare const defaultApplicationSettings: {
+    renderer: 2;
+    scale: number;
+    scaleMethod: "manual";
+    preferWebGL1: false;
+    depthTest: "sorting";
+    powerPreference: "default";
+    transparent: false;
+    antiAlias: false;
+    consoleHeader: boolean;
+    blendMode: "normal";
+    physic: "builtin";
+    failIfMajorPerformanceCaveat: true;
+    subPixel: false;
+    verbose: false;
+    legacy: false;
+};
+//# sourceMappingURL=defaultApplicationSettings.d.ts.map

package/build/application/defaultApplicationSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultApplicationSettings.d.ts","sourceRoot":"","sources":["../../src/application/defaultApplicationSettings.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;CAgBC,CAAC"}

package/{dist/types → build}/application/header.d.ts

@@ -8,3 +8,4 @@
  */
 export function consoleHeader(app: Application): void;
 import type Application from "./application.js";
+//# sourceMappingURL=header.d.ts.map

package/build/application/header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../src/application/header.js"],"names":[],"mappings":"AAEA;;;GAGG;AAEH;;;GAGG;AACH,mCAFW,WAAW,QAgDrB;6BArD2B,kBAAkB"}

package/{dist/types → build}/application/resize.d.ts

@@ -5,3 +5,4 @@
  */
 export function onresize(game: Application): void;
 import type Application from "./application.js";
+//# sourceMappingURL=resize.d.ts.map

package/build/application/resize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resize.d.ts","sourceRoot":"","sources":["../../src/application/resize.js"],"names":[],"mappings":"AAyCA;;;;GAIG;AACH,+BAFW,WAAW,QA8ErB;6BAtH2B,kBAAkB"}

package/build/application/scaleMethods.d.ts

@@ -0,0 +1,44 @@
+export declare const ScaleMethods: {
+    /**
+     * Manual; no scaling is performed
+     * <img src="images/scale-fit.png"/>
+     */
+    readonly Manual: "manual";
+    /**
+     * Letterboxed; content is scaled to design aspect ratio
+     * <img src="images/scale-fit.png"/>
+     */
+    readonly Fit: "fit";
+    /**
+     * Canvas is resized to fit minimum design resolution; content is scaled to design aspect ratio
+     * <img src="images/scale-fill-min.png"/>
+     */
+    readonly FillMin: "fill-min";
+    /**
+     * Canvas is resized to fit maximum design resolution; content is scaled to design aspect ratio
+     * <img src="images/scale-fill-max.png"/>
+     */
+    readonly FillMax: "fill-max";
+    /**
+     * Canvas width & height is resized to fit; content is scaled to design aspect ratio
+     * <img src="images/scale-flex.png"/>
+     */
+    readonly Flex: "flex";
+    /**
+     * Canvas width is resized to fit; content is scaled to design aspect ratio
+     * <img src="images/scale-flex-width.png"/>
+     */
+    readonly FlexWidth: "flex-width";
+    /**
+     * Canvas height is resized to fit; content is scaled to design aspect ratio
+     * <img src="images/scale-flex-height.png"/>
+     */
+    readonly FlexHeight: "flex-height";
+    /**
+     * Canvas is resized to fit; content is scaled to screen aspect ratio
+     * <img src="images/scale-stretch.png"/>
+     */
+    readonly Stretch: "stretch";
+};
+export type ScaleMethod = (typeof ScaleMethods)[keyof typeof ScaleMethods];
+//# sourceMappingURL=scaleMethods.d.ts.map

package/build/application/scaleMethods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaleMethods.d.ts","sourceRoot":"","sources":["../../src/application/scaleMethods.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;IACxB;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;CAEM,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC"}

package/build/application/settings.d.ts

@@ -0,0 +1,85 @@
+/**
+ * additional import for TypeScript
+ * @import Renderer from "./../video/renderer.js";
+ */
+import { RendererType } from "../const";
+import Renderer from "../video/renderer";
+import Compositor from "../video/webgl/compositors/compositor";
+import { ScaleMethod } from "./scaleMethods";
+type BlendMode = "normal" | "multiply" | "lighter" | "additive" | "screen";
+type PhysicsType = "builtin" | "none";
+type PowerPreference = "default" | "low-power";
+type DepthTest = "sorting" | "z-buffer";
+export type ApplicationSettings = {
+    /**
+     * renderer to use (CANVAS, WEBGL, AUTO), or a custom renderer class
+     * @default AUTO
+     */
+    renderer: RendererType | Renderer;
+    /**
+     * enable scaling of the canvas ('auto' for automatic scaling)
+     * @default 1
+     */
+    scale: number | "auto";
+    /**
+     * screen scaling modes
+     * @default fit
+     */
+    scaleMethod: ScaleMethod;
+    /**
+     * the HTML Element to be used as the reference target when using automatic scaling (by default melonJS will use the parent container of the div element containing the canvas)
+     */
+    scaleTarget: HTMLElement;
+    /**
+     * if true the renderer will only use WebGL 1
+     * @default false
+     */
+    preferWebGL1: boolean;
+    /**
+     * ~Experimental~ the default method to sort object on the z axis in WebGL
+     * @default sorting
+     */
+    depthTest: DepthTest;
+    /**
+     * a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context. To be noted that Safari and Chrome (since version 80) both default to "low-power" to save battery life and improve the user experience on these dual-GPU machines.
+     * @default default
+     */
+    powerPreference: PowerPreference;
+    /**
+     * whether to allow transparent pixels in the front buffer (screen).
+     * @default false
+     */
+    transparent: boolean;
+    /**
+     * whether to enable or not video scaling interpolation
+     * @default false
+     */
+    antiAlias: boolean;
+    /**
+     * whether to display melonJS version and basic device information in the console
+     * @default true
+     */
+    consoleHeader: boolean;
+    blendMode: BlendMode;
+    /**
+     * the physic system to use (default: "builtin", or "none" to disable builtin physic)
+     * @default "builtin"
+     */
+    physic: PhysicsType;
+    failIfMajorPerformanceCaveat: boolean;
+    subPixel: boolean;
+    verbose: boolean;
+    legacy: boolean;
+    /**
+     * a custom compositor class (WebGL only)
+     */
+    compositor?: Compositor | undefined;
+} & ({
+    parent: HTMLElement;
+    canvas?: never;
+} | {
+    parent?: never;
+    canvas: HTMLCanvasElement;
+});
+export {};
+//# sourceMappingURL=settings.d.ts.map

package/build/application/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/application/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,UAAU,MAAM,uCAAuC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,KAAK,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE3E,KAAK,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;AAEtC,KAAK,eAAe,GAAG,SAAS,GAAG,WAAW,CAAC;AAE/C,KAAK,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG;IACjC;;;OAGG;IACH,QAAQ,EAAE,YAAY,GAAG,QAAQ,CAAC;IAElC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB,4BAA4B,EAAE,OAAO,CAAC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACpC,GAAG,CACD;IAEA,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACA,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf,MAAM,EAAE,iBAAiB,CAAC;CACzB,CACH,CAAC"}

package/{dist/types → build}/audio/audio.d.ts

@@ -5,7 +5,6 @@
  * webm has nearly full browser coverage with a great combination of compression and quality, and mp3 will fallback gracefully for other browsers.
  * It is important to remember that melonJS selects the first compatible sound based on the list of extensions and given order passed here.
  * So if you want webm to be used before mp3, you need to put the audio format in that order.
- * @memberof audio
  * @param {string} [format="mp3"] - audio format to prioritize ("mp3"|"mpeg"|"opus"|"ogg"|"oga"|"wav"|"aac"|"caf"|"m4a"|"m4b"|"mp4"|"weba"|"webm"|"dolby"|"flac")
  * @returns {boolean} Indicates whether audio initialization was successful
  * @example
@@ -15,45 +14,39 @@
  *     return;
  * }
  */
-export function init(format?: string | undefined): boolean;
+export function init(format?: string): boolean;
 /**
  * check if the given audio format is supported
- * @memberof audio
  * @param {"mp3"|"mpeg"|"opus"|"ogg"|"oga"|"wav"|"aac"|"caf"|"m4a"|"m4b"|"mp4"|"weba"|"webm"|"dolby"|"flac"} codec - the audio format to check for support
  * @returns {boolean} return true if the given audio format is supported
  */
 export function hasFormat(codec: "mp3" | "mpeg" | "opus" | "ogg" | "oga" | "wav" | "aac" | "caf" | "m4a" | "m4b" | "mp4" | "weba" | "webm" | "dolby" | "flac"): boolean;
 /**
  * check if audio (HTML5 or WebAudio) is supported
- * @memberof audio
  * @returns {boolean} return true if audio (HTML5 or WebAudio) is supported
  */
 export function hasAudio(): boolean;
 /**
  * enable audio output <br>
  * only useful if audio supported and previously disabled through
- * @memberof audio
- * @see audio.disable
+ * @see {@link disable}
  */
 export function enable(): void;
 /**
  * disable audio output
- * @memberof audio
  */
 export function disable(): void;
 /**
  * Load an audio file
- * @memberof audio
  * @param {Asset} sound
  * @param {Function} [onloadcb] - function to be called when the resource is loaded
  * @param {Function} [onerrorcb] - function to be called in case of error
  * @param {Object} [settings] - custom settings to apply to the request (@link https://developer.mozilla.org/en-US/docs/Web/API/fetch#options)
  * @returns {number} the amount of asset loaded (always 1 if successfull)
  */
-export function load(sound: Asset, onloadcb?: Function | undefined, onerrorcb?: Function | undefined, settings?: Object | undefined): number;
+export function load(sound: Asset, onloadcb?: Function, onerrorcb?: Function, settings?: Object): number;
 /**
  * play the specified sound
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {boolean} [loop=false] - loop audio
  * @param {Function} [onend] - Function to call when sound instance ends playing.
@@ -69,20 +62,18 @@ export function load(sound: Asset, onloadcb?: Function | undefined, onerrorcb?:
  * // play the "gameover_sfx" audio clip with a lower volume level
  * me.audio.play("gameover_sfx", false, null, 0.5);
  */
-export function play(sound_name: string, loop?: boolean | undefined, onend?: Function | undefined, volume?: number | undefined): number;
+export function play(sound_name: string, loop?: boolean, onend?: Function, volume?: number): number;
 /**
  * Fade a currently playing sound between two volumee.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} from - Volume to fade from (0.0 to 1.0).
  * @param {number} to - Volume to fade to (0.0 to 1.0).
  * @param {number} duration - Time in milliseconds to fade.
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will fade.
  */
-export function fade(sound_name: string, from: number, to: number, duration: number, id?: number | undefined): void;
+export function fade(sound_name: string, from: number, to: number, duration: number, id?: number): void;
 /**
  * get/set the position of playback for a sound.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [seek] - the position to move current playback to (in seconds).
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will changed.
@@ -96,7 +87,6 @@ export function fade(sound_name: string, from: number, to: number, duration: num
 export function seek(sound_name: string, ...args: any[]): number;
 /**
  * get or set the rate of playback for a sound.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [rate] - playback rate : 0.5 to 4.0, with 1.0 being normal speed.
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
@@ -110,7 +100,6 @@ export function seek(sound_name: string, ...args: any[]): number;
 export function rate(sound_name: string, ...args: any[]): number;
 /**
  * get or set the stereo panning for the specified sound.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [pan] - the panning value - A value of -1.0 is all the way left and 1.0 is all the way right.
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
@@ -118,10 +107,9 @@ export function rate(sound_name: string, ...args: any[]): number;
  * @example
  * me.audio.stereo("cling", -1);
  */
-export function stereo(sound_name: string, pan?: number | undefined, id?: number | undefined): number;
+export function stereo(sound_name: string, pan?: number, id?: number): number;
 /**
  * get or set the 3D spatial position for the specified sound.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param  {Number} x - the x-position of the audio source.
  * @param  {Number} y - the y-position of the audio source.
@@ -129,11 +117,10 @@ export function stereo(sound_name: string, pan?: number | undefined, id?: number
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
  * @return {Array} the current 3D spatial position: [x, y, z]
  */
-export function position(sound_name: string, x: number, y: number, z: number, id?: number | undefined): any[];
+export function position(sound_name: string, x: number, y: number, z: number, id?: number): any[];
 /**
  * Get/set the direction the audio source is pointing in the 3D cartesian coordinate space.
  * Depending on how direction the sound is, based on the `cone` attributes, a sound pointing away from the listener can be quiet or silent.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param  {Number} x - the x-orientation of the audio source.
  * @param  {Number} y - the y-orientation of the audio source.
@@ -141,21 +128,20 @@ export function position(sound_name: string, x: number, y: number, z: number, id
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
  * @return {Array} the current 3D spatial orientation: [x, y, z]
  */
-export function orientation(sound_name: string, x: number, y: number, z: number, id?: number | undefined): any[];
+export function orientation(sound_name: string, x: number, y: number, z: number, id?: number): any[];
 /**
  * get or set the panner node's attributes for a sound or group of sounds.
  * See {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics#creating_a_panner_node}
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
- * @param {object} [attribute] - the panner attributes to set
- * @param {string} [settings.coneInnerAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, inside of which there will be no volume reduction.
- * @param {string} [settings.coneOuterAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, outside of which the volume will be reduced to a constant value of `coneOuterGain`.
- * @param {string} [settings.coneOuterGain=0] - A parameter for directional audio sources, this is the gain outside of the `coneOuterAngle`. It is a linear value in the range `[0, 1]`.
- * @param {string} [settings.distanceModel="inverse"] - Determines algorithm used to reduce volume as audio moves away from listener. Can be `linear`, `inverse` or `exponential.
- * @param {string} [settings.maxDistance=10000] - The maximum distance between source and listener, after which the volume will not be reduced any further.
- * @param {string} [settings.refDistance=1] - A reference distance for reducing volume as source moves further from the listener. This is simply a variable of the distance model and has a different effect depending on which model is used and the scale of your coordinates. Generally, volume will be equal to 1 at this distance.
- * @param {string} [settings.rolloffFactor=1] - How quickly the volume reduces as source moves from listener. This is simply a variable of the distance model and can be in the range of `[0, 1]` with `linear` and `[0, ∞]` with `inverse` and `exponential`.
- * @param {string} [settings.panningModel="HRTF"] - Determines which spatialization algorithm is used to position audio. Can be `HRTF` or `equalpower`.
+ * @param {Object} [attributes] - the panner attributes to set
+ * @param {string} [attributes.coneInnerAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, inside of which there will be no volume reduction.
+ * @param {string} [attributes.coneOuterAngle=360] - A parameter for directional audio sources, this is an angle, in degrees, outside of which the volume will be reduced to a constant value of `coneOuterGain`.
+ * @param {string} [attributes.coneOuterGain=0] - A parameter for directional audio sources, this is the gain outside of the `coneOuterAngle`. It is a linear value in the range `[0, 1]`.
+ * @param {string} [attributes.distanceModel="inverse"] - Determines algorithm used to reduce volume as audio moves away from listener. Can be `linear`, `inverse` or `exponential.
+ * @param {string} [attributes.maxDistance=10000] - The maximum distance between source and listener, after which the volume will not be reduced any further.
+ * @param {string} [attributes.refDistance=1] - A reference distance for reducing volume as source moves further from the listener. This is simply a variable of the distance model and has a different effect depending on which model is used and the scale of your coordinates. Generally, volume will be equal to 1 at this distance.
+ * @param {string} [attributes.rolloffFactor=1] - How quickly the volume reduces as source moves from listener. This is simply a variable of the distance model and can be in the range of `[0, 1]` with `linear` and `[0, ∞]` with `inverse` and `exponential`.
+ * @param {string} [attributes.panningModel="HRTF"] - Determines which spatialization algorithm is used to position audio. Can be `HRTF` or `equalpower`.
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
  * @return {Object} current panner attributes.
  * @example
@@ -166,29 +152,35 @@ export function orientation(sound_name: string, x: number, y: number, z: number,
  *    distanceModel: 'exponential'
  * });
  */
-export function panner(sound_name: string, attributes: any, id?: number | undefined): Object;
+export function panner(sound_name: string, attributes?: {
+    coneInnerAngle?: string | undefined;
+    coneOuterAngle?: string | undefined;
+    coneOuterGain?: string | undefined;
+    distanceModel?: string | undefined;
+    maxDistance?: string | undefined;
+    refDistance?: string | undefined;
+    rolloffFactor?: string | undefined;
+    panningModel?: string | undefined;
+}, id?: number): Object;
 /**
  * stop the specified sound on all channels
- * @memberof audio
  * @param {string} [sound_name] - audio clip name (case sensitive). If none is passed, all sounds are stopped.
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will stop.
  * @example
  * me.audio.stop("cling");
  */
-export function stop(sound_name?: string | undefined, id?: number | undefined): void;
+export function stop(sound_name?: string, id?: number): void;
 /**
  * pause the specified sound on all channels<br>
  * this function does not reset the currentTime property
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will pause.
  * @example
  * me.audio.pause("cling");
  */
-export function pause(sound_name: string, id?: number | undefined): void;
+export function pause(sound_name: string, id?: number): void;
 /**
  * resume the specified sound on all channels<br>
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will resume.
  * @example
@@ -201,23 +193,21 @@ export function pause(sound_name: string, id?: number | undefined): void;
  * // resume
  * me.audio.resume("myClip", id);
  */
-export function resume(sound_name: string, id?: number | undefined): void;
+export function resume(sound_name: string, id?: number): void;
 /**
  * play the specified audio track<br>
  * this function automatically set the loop property to true<br>
  * and keep track of the current sound being played.
- * @memberof audio
  * @param {string} sound_name - audio track name - case sensitive
  * @param {number} [volume=default] - Float specifying volume (0.0 - 1.0 values accepted).
  * @returns {number} the sound instance ID.
  * @example
  * me.audio.playTrack("awesome_music");
  */
-export function playTrack(sound_name: string, volume?: number | undefined): number;
+export function playTrack(sound_name: string, volume?: number): number;
 /**
  * stop the current audio track
- * @memberof audio
- * @see audio.playTrack
+ * @see {@link playTrack}
  * @example
  * // play a awesome music
  * me.audio.playTrack("awesome_music");
@@ -227,14 +217,12 @@ export function playTrack(sound_name: string, volume?: number | undefined): numb
 export function stopTrack(): void;
 /**
  * pause the current audio track
- * @memberof audio
  * @example
  * me.audio.pauseTrack();
  */
 export function pauseTrack(): void;
 /**
  * resume the previously paused audio track
- * @memberof audio
  * @example
  * // play an awesome music
  * me.audio.playTrack("awesome_music");
@@ -246,25 +234,21 @@ export function pauseTrack(): void;
 export function resumeTrack(): void;
 /**
  * returns the current track Id
- * @memberof audio
  * @returns {string} audio track name
  */
 export function getCurrentTrack(): string;
 /**
  * set the default global volume
- * @memberof audio
  * @param {number} volume - Float specifying volume (0.0 - 1.0 values accepted).
  */
 export function setVolume(volume: number): void;
 /**
  * get the default global volume
- * @memberof audio
  * @returns {number} current volume value in Float [0.0 - 1.0] .
  */
 export function getVolume(): number;
 /**
  * mute or unmute the specified sound, but does not pause the playback.
- * @memberof audio
  * @param {string} sound_name - audio clip name - case sensitive
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will mute.
  * @param {boolean} [mute=true] - True to mute and false to unmute
@@ -272,33 +256,28 @@ export function getVolume(): number;
  * // mute the background music
  * me.audio.mute("awesome_music");
  */
-export function mute(sound_name: string, id?: number | undefined, mute?: boolean | undefined): void;
+export function mute(sound_name: string, id?: number, mute?: boolean): void;
 /**
  * unmute the specified sound
- * @memberof audio
  * @param {string} sound_name - audio clip name
  * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will unmute.
  */
-export function unmute(sound_name: string, id?: number | undefined): void;
+export function unmute(sound_name: string, id?: number): void;
 /**
  * mute all audio
- * @memberof audio
  */
 export function muteAll(): void;
 /**
  * unmute all audio
- * @memberof audio
  */
 export function unmuteAll(): void;
 /**
  * Returns true if audio is muted globally.
- * @memberof audio
  * @returns {boolean} true if audio is muted globally
  */
 export function muted(): boolean;
 /**
  * unload specified audio track to free memory
- * @memberof audio
  * @param {string} sound_name - audio track name - case sensitive
  * @returns {boolean} true if unloaded
  * @example
@@ -307,7 +286,6 @@ export function muted(): boolean;
 export function unload(sound_name: string): boolean;
 /**
  * unload all audio to free memory
- * @memberof audio
  * @example
  * me.audio.unloadAll();
  */
@@ -317,9 +295,8 @@ export function unloadAll(): void;
  * if true, melonJS will throw an exception and stop loading<br>
  * if false, melonJS will disable sounds and output a warning message
  * in the console<br>
- * @type {boolean}
  * @default true
- * @memberof audio
  */
 export let stopOnAudioError: boolean;
 import type { Asset } from "./../loader/loader.js";
+//# sourceMappingURL=audio.d.ts.map

package/build/audio/audio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio.d.ts","sourceRoot":"","sources":["../../src/audio/audio.js"],"names":[],"mappings":"AAsEA;;;;;;;;;;;;;;;GAeG;AACH,8BATW,MAAM,GACJ,OAAO,CAanB;AAED;;;;GAIG;AACH,iCAHW,KAAK,GAAC,MAAM,GAAC,MAAM,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,KAAK,GAAC,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,MAAM,GAC9F,OAAO,CAInB;AAED;;;GAGG;AACH,4BAFa,OAAO,CAInB;AAED;;;;GAIG;AACH,+BAEC;AAED;;GAEG;AACH,gCAEC;AAED;;;;;;;GAOG;AACH,4BANW,KAAK,wDAGL,MAAM,GACJ,MAAM,CAoClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,iCAfW,MAAM,SACN,OAAO,6BAEP,MAAM,GACJ,MAAM,CAkClB;AAED;;;;;;;GAOG;AACH,iCANW,MAAM,QACN,MAAM,MACN,MAAM,YACN,MAAM,OACN,MAAM,QAShB;AAED;;;;;;;;;;;GAWG;AACH,iCAVW,MAAM,mBAGJ,MAAM,CAclB;AAED;;;;;;;;;;;GAWG;AACH,iCAVW,MAAM,mBAGJ,MAAM,CAclB;AAED;;;;;;;;GAQG;AACH,mCAPW,MAAM,QACN,MAAM,OACN,MAAM,GACL,MAAM,CAWjB;AAED;;;;;;;;GAQG;AACH,qCAPW,MAAM,wCAIN,MAAM,SAUhB;AAED;;;;;;;;;GASG;AACH,wCAPW,MAAM,wCAIN,MAAM,SAUhB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,mCApBW,MAAM,eAEd;IAA4B,cAAc;IACd,cAAc;IACd,aAAa;IACb,aAAa;IACb,WAAW;IACX,WAAW;IACX,aAAa;IACb,YAAY;CACxC,OAAQ,MAAM,GACL,MAAM,CAgBjB;AAED;;;;;;GAMG;AACH,kCALW,MAAM,OACN,MAAM,QAiBhB;AAED;;;;;;;GAOG;AACH,kCALW,MAAM,OACN,MAAM,QAWhB;AAED;;;;;;;;;;;;;GAaG;AACH,mCAZW,MAAM,OACN,MAAM,QAkBhB;AAED;;;;;;;;;GASG;AACH,sCANW,MAAM,WACN,MAAM,GACJ,MAAM,CAOlB;AAED;;;;;;;;GAQG;AACH,kCAKC;AAED;;;;GAIG;AACH,mCAIC;AAED;;;;;;;;;GASG;AACH,oCAIC;AAED;;;GAGG;AACH,mCAFa,MAAM,CAIlB;AAED;;;GAGG;AACH,kCAFW,MAAM,QAIhB;AAED;;;GAGG;AACH,6BAFa,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,iCAPW,MAAM,OACN,MAAM,SACN,OAAO,QAYjB;AAED;;;;GAIG;AACH,mCAHW,MAAM,OACN,MAAM,QAIhB;AAED;;GAEG;AACH,gCAEC;AAED;;GAEG;AACH,kCAEC;AAED;;;GAGG;AACH,yBAFa,OAAO,CAInB;AAED;;;;;;GAMG;AACH,mCALW,MAAM,GACJ,OAAO,CAanB;AAED;;;;GAIG;AACH,kCAMC;AAvgBD;;;;;;GAMG;AACH,qCAAmC;2BA7DT,uBAAuB"}