melonjs 15.3.0 → 15.4.0

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

@@ -1,32 +1,32 @@
 export default ParticleEmitterSettings;
 declare namespace ParticleEmitterSettings {
-    const width: number;
-    const height: number;
-    const image: HTMLCanvasElement;
-    const textureSize: number;
-    const tint: string;
-    const totalParticles: number;
-    const angle: number;
-    const angleVariation: number;
-    const minLife: number;
-    const maxLife: number;
-    const speed: number;
-    const speedVariation: number;
-    const minRotation: number;
-    const maxRotation: number;
-    const minStartScale: number;
-    const maxStartScale: number;
-    const minEndScale: number;
-    const maxEndScale: number;
-    const gravity: number;
-    const wind: number;
-    const followTrajectory: boolean;
-    const textureAdditive: boolean;
-    const blendMode: string;
-    const onlyInViewport: boolean;
-    const floating: boolean;
-    const maxParticles: number;
-    const frequency: number;
-    const duration: number;
-    const framesToSkip: number;
+    let width: number;
+    let height: number;
+    let image: HTMLCanvasElement;
+    let textureSize: number;
+    let tint: string;
+    let totalParticles: number;
+    let angle: number;
+    let angleVariation: number;
+    let minLife: number;
+    let maxLife: number;
+    let speed: number;
+    let speedVariation: number;
+    let minRotation: number;
+    let maxRotation: number;
+    let minStartScale: number;
+    let maxStartScale: number;
+    let minEndScale: number;
+    let maxEndScale: number;
+    let gravity: number;
+    let wind: number;
+    let followTrajectory: boolean;
+    let textureAdditive: boolean;
+    let blendMode: string;
+    let onlyInViewport: boolean;
+    let floating: boolean;
+    let maxParticles: number;
+    let frequency: number;
+    let duration: number;
+    let framesToSkip: number;
 }

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

@@ -272,15 +272,17 @@ export default class Body {
     forEach(callback: Function, thisArg?: object | undefined, ...args: any[]): void;
     /**
      * Returns true if the any of the shape composing the body contains the given point.
-     * @method Body#contains
-     * @param {Vector2d} point
-     * @returns {boolean} true if contains
-     */
-    /**
-     * Returns true if the any of the shape composing the body contains the given point.
-     * @param  {number} x -  x coordinate
-     * @param  {number} y -  y coordinate
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] -  y coordinate
      * @returns {boolean} true if contains
+     * @example
+     * if (mySprite.body.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (mySprite.body.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains(...args: any[]): boolean;
     /**

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

@@ -96,7 +96,7 @@ export default class Bounds {
      * @param {number} x - the x coordinate around which to center this bounds
      * @param {number} y - the y coordinate around which to center this bounds
      */
-    centerOn(x: number, y: number): Bounds;
+    centerOn(x: number, y: number): this;
     /**
      * Updates bounds using the given vertices
      * @param {Vector2d[]|Point[]} vertices - an array of Vector2d or Point
@@ -131,17 +131,17 @@ export default class Bounds {
     addFrame(x0: number, y0: number, x1: number, y1: number, m?: any): void;
     /**
      * Returns true if the bounds contains the given point.
-     * @name contains
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} point
-     * @returns {boolean} True if the bounds contain the point, otherwise false
-     */
-    /**
-     * Returns true if the bounds contains the given point.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to check
+     * @param {number} [y] - y coordinate
      * @returns {boolean} True if the bounds contain the point, otherwise false
+     * @example
+     * if (bounds.contains(10, 10)) {
+     *   // do something
+     * }
+     * // or
+     * if (bounds.contains(myVector2d)) {
+     *   // do something
+     * }
      */
     contains(...args: any[]): boolean;
     /**
@@ -156,29 +156,23 @@ export default class Bounds {
      */
     isFinite(): boolean;
     /**
-     * Translates the bounds by the given vector.
-     * @name translate
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} vector
-     */
-    /**
-     * Translates the bounds by x on the x axis, and y on the y axis
-     * @param {number} x
-     * @param {number} y
+     * Translates the bounds by the given point
+     * @param {number|Vector2d} x -  x coordinate or a vector point to translate by
+     * @param {number} [y]
+     * @example
+     * bounds.translate(10, 10);
+     * // or
+     * bounds.translate(myVector2d);
      */
     translate(...args: any[]): void;
-    /**
-     * Shifts the bounds to the given position vector.
-     * @name shift
-     * @memberof Bounds
-     * @method
-     * @param {Vector2d} position
-     */
     /**
      * Shifts the bounds to the given x, y position.
-     * @param {number} x
-     * @param {number} y
+     * @param {number|Vector2d} x -  x coordinate or a vector point to shift to
+     * @param {number} [y]
+     * @example
+     * bounds.shift(10, 10);
+     * // or
+     * bounds.shift(myVector2d);
      */
     shift(...args: any[]): void;
     /**

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

@@ -1,18 +1,18 @@
 export default collision;
 declare namespace collision {
-    const maxChildren: number;
-    const maxDepth: number;
+    let maxChildren: number;
+    let maxDepth: number;
     namespace types {
-        const NO_OBJECT: number;
-        const PLAYER_OBJECT: number;
-        const NPC_OBJECT: number;
-        const ENEMY_OBJECT: number;
-        const COLLECTABLE_OBJECT: number;
-        const ACTION_OBJECT: number;
-        const PROJECTILE_OBJECT: number;
-        const WORLD_SHAPE: number;
-        const USER: number;
-        const ALL_OBJECT: number;
+        let NO_OBJECT: number;
+        let PLAYER_OBJECT: number;
+        let NPC_OBJECT: number;
+        let ENEMY_OBJECT: number;
+        let COLLECTABLE_OBJECT: number;
+        let ACTION_OBJECT: number;
+        let PROJECTILE_OBJECT: number;
+        let WORLD_SHAPE: number;
+        let USER: number;
+        let ALL_OBJECT: number;
     }
     /**
      * Checks for object colliding with the given line

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

@@ -25,7 +25,7 @@ export default class Detector {
      * detect collision between two bodies.
      * @param {Body} bodyA - a reference to body A.
      * @param {Body} bodyB - a reference to body B.
-     * @returns {Boolean} true if colliding
+     * @returns {boolean} true if colliding
      */
     collides(bodyA: Body, bodyB: Body, response?: ResponseObject): boolean;
     /**

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

@@ -30,13 +30,10 @@ export default class World extends Container {
      */
     gravity: Vector2d;
     /**
-     * Specify the rendering method for tile layers. <br>
-     * if false visible part of the layers are rendered dynamically,<br>
-     * if true the entire layers are first rendered into an offscreen canvas.<br>
-     * the "best" rendering method depends of your game
-     * (amount of layer, layer size, amount of tiles per layer, etc.)<br>
-     * note : rendering method is also configurable per layer by adding this
-     * property to your layer (in Tiled).
+     * Enabled pre-rendering for all tile layers. <br>
+     * If false layers are rendered dynamically, if true layers are first fully rendered into an offscreen canvas.<br>
+     * the "best" rendering method depends of your game (amount of layer, layer size, amount of tiles per layer, etc.)<br>
+     * Note : rendering method is also configurable per layer by adding a boolean "preRender" property to your layer in Tiled ({@link https://doc.mapeditor.org/en/stable/manual/custom-properties/#adding-properties}).
      * @type {boolean}
      * @default false
      */

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

@@ -93,7 +93,7 @@ export default class Container extends Renderable {
      * will not be in any container. <br>
      * if the given child implements a onActivateEvent method, that method will be called
      * once the child is added to this container.
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be added
      * @param {number} [z] - forces the z index of the child to the specified value
      * @returns {Renderable} the added child
      */
@@ -101,8 +101,8 @@ export default class Container extends Renderable {
     /**
      * Add a child to the container at the specified index<br>
      * (the list won't be sorted after insertion)
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
-     * @param {number} index
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be added
+     * @param {number} index - The index at which to insert the child
      * @returns {Renderable} the added child
      */
     addChildAt(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, index: number): Renderable;
@@ -127,31 +127,31 @@ export default class Container extends Renderable {
     forEach(callback: Function, thisArg?: object | undefined, ...args: any[]): void;
     /**
      * Swaps the position (z-index) of 2 children
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child2
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be added
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child2 - Child to be added
      */
     swapChildren(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, child2: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): void;
     /**
      * Returns the Child at the specified index
-     * @param {number} index
+     * @param {number} index - The index of the child
      * @returns {Renderable} the child at the specified index
      */
     getChildAt(index: number): Renderable;
     /**
      * Returns the index of the given Child
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - The child object
      * @returns {number} index
      */
     getChildIndex(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): number;
     /**
      * Returns the next child within the container or undefined if none
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - The child object
      * @returns {Renderable} child
      */
     getNextChild(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): Renderable;
     /**
      * Returns true if contains the specified Child
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - The child object
      * @returns {boolean}
      */
     hasChild(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): boolean;
@@ -180,7 +180,7 @@ export default class Container extends Renderable {
     getChildByProp(prop: string, value: string | RegExp | number | boolean): Renderable[];
     /**
      * returns the list of childs with the specified class type
-     * @param {object} classType
+     * @param {object} classType - Class type
      * @returns {Renderable[]} Array of children
      */
     getChildByType(classType: object): Renderable[];
@@ -208,12 +208,12 @@ export default class Container extends Renderable {
     getChildren(): Renderable[];
     /**
      * Checks if this container is root or if it's attached to the root container.
-     * @returns {boolean}
+     * @returns {boolean} true if this container is root or if it's attached to the root container
      */
     isAttachedToRoot(): boolean;
     /**
      * Returns the instance of the root container (i.e. the current application World container).
-     * @returns {Container}
+     * @returns {Container} root container
      */
     getRootAncestor(): Container;
     /**
@@ -223,7 +223,7 @@ export default class Container extends Renderable {
     /**
      * Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has completed. <br>
      * if the given child implements a onDeactivateEvent() method, that method will be called once the child is removed from this container.
-     * @param {RendRenderable|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapTexterable} child
+     * @param {RendRenderable|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapTexterable} child - Child to be removed
      * @param {boolean} [keepalive=false] - true to prevent calling child.destroy()
      */
     removeChild(child: RendRenderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapTexterable, keepalive?: boolean | undefined): void;
@@ -231,7 +231,7 @@ export default class Container extends Renderable {
      * Removes (and optionally destroys) a child from the container.<br>
      * (removal is immediate and unconditional)<br>
      * Never use keepalive=true with objects from {@link pool}. Doing so will create a memory leak.
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be removed
      * @param {boolean} [keepalive=False] - True to prevent calling child.destroy()
      */
     removeChildNow(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText, keepalive?: boolean | undefined): void;
@@ -244,26 +244,26 @@ export default class Container extends Renderable {
     setChildsProperty(prop: string, value: object, recursive?: boolean | undefined): void;
     /**
      * Move the child in the group one step forward (z depth).
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child -  Child to be moved
      */
     moveUp(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): void;
     /**
      * Move the child in the group one step backward (z depth).
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be moved
      */
     moveDown(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): void;
     /**
      * Move the specified child to the top(z depth).
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be moved
      */
     moveToTop(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): void;
     /**
      * Move the specified child the bottom (z depth).
-     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child
+     * @param {Renderable|Entity|Sprite|Collectable|Trigger|Draggable|DropTarget|NineSliceSprite|ImageLayer|ColorLayer|Light2d|UIBaseElement|UISpriteElement|UITextButton|Text|BitmapText} child - Child to be moved
      */
     moveToBottom(child: Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText): void;
     /**
-     * Manually trigger the sort of all the childs in the container</p>
+     * Manually trigger the sort of all the childs in the container
      * @param {boolean} [recursive=false] - recursively sort all containers if true
      */
     sort(recursive?: boolean | undefined): void;

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

@@ -12,7 +12,7 @@ export default class ImageLayer {
      * @param {string} [settings.name="me.ImageLayer"] - layer name
      * @param {number} [settings.z=0] - z-index position
      * @param {number|Vector2d} [settings.ratio=1.0] - Scrolling ratio to be applied. See {@link ImageLayer#ratio}
-     * @param {string} [settings.repeat='repeat'] - define if and how an Image Layer should be repeated (accepted values are 'repeat', 'repeat-x', 'repeat-y', 'no-repeat'). See {@link ImageLayer#repeat}
+     * @param {"repeat"|"repeat-x"|"repeat-y"|"no-repeat"} [settings.repeat="repeat"] - define if and how an Image Layer should be repeated. See {@link ImageLayer#repeat}
      * @param {number|Vector2d} [settings.anchorPoint=0.0] - Image origin. See {@link ImageLayer#anchorPoint}
      * @example
      * // create a repetitive background pattern on the X axis using the citycloud image asset
@@ -26,7 +26,7 @@ export default class ImageLayer {
         name?: string | undefined;
         z?: number | undefined;
         ratio?: number | Vector2d;
-        repeat?: string | undefined;
+        repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | undefined;
         anchorPoint?: number | Vector2d;
     });
     floating: boolean;
@@ -83,10 +83,10 @@ export default class ImageLayer {
     updateLayer(vpos: any): void;
     isDirty: boolean | undefined;
     /**
-     * override the default predraw function
-     * as repeat and anchor are managed directly in the draw method
-     * @ignore
-     */
+    * override the default predraw function
+    * as repeat and anchor are managed directly in the draw method
+    * @ignore
+    */
     preDraw(renderer: any): void;
     /**
      * draw this ImageLayer (automatically called by melonJS)

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

@@ -8,13 +8,13 @@
  */
 export default class Light2d extends Renderable {
     /**
-     * @param {number} x - The horizontal position of the light.
-     * @param {number} y - The vertical position of the light.
-     * @param {number} radiusX - The horizontal radius of the light.
-     * @param {number} [radiusY=radiusX] - The vertical radius of the light.
-     * @param {Color|string} [color="#FFF"] - the color of the light
-     * @param {number} [intensity=0.7] - The intensity of the light.
-     */
+    * @param {number} x - The horizontal position of the light.
+    * @param {number} y - The vertical position of the light.
+    * @param {number} radiusX - The horizontal radius of the light.
+    * @param {number} [radiusY=radiusX] - The vertical radius of the light.
+    * @param {Color|string} [color="#FFF"] - the color of the light
+    * @param {number} [intensity=0.7] - The intensity of the light.
+    */
     constructor(x: number, y: number, radiusX: number, radiusY?: number | undefined, color?: Color | string, intensity?: number | undefined);
     /**
      * the color of the light

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

@@ -4,12 +4,6 @@
  * @augments Rect
  */
 export default class Renderable extends Rect {
-    /**
-     * Position of the Renderable relative to its parent container
-     * @public
-     * @type {ObservableVector3d}
-     */
-    public pos: ObservableVector3d;
     /**
      * The anchor point is used for attachment behavior, and/or when applying transformations.<br>
      * The coordinate system places the origin at the top left corner of the frame (0, 0) and (1, 1) means the bottom-right corner<br>
@@ -64,11 +58,11 @@ export default class Renderable extends Rect {
      */
     body: Body;
     /**
-     * (G)ame (U)nique (Id)entifier" <br>
-     * a GUID will be allocated for any renderable object added <br>
-     * to an object container (including the `me.game.world` container)
-     * @type {string}
-     */
+    * (G)ame (U)nique (Id)entifier" <br>
+    * a GUID will be allocated for any renderable object added <br>
+    * to an object container (including the `me.game.world` container)
+    * @type {string}
+    */
     GUID: string;
     /**
      * an event handler that is called when the renderable leave or enter a camera viewport
@@ -333,11 +327,11 @@ export default class Renderable extends Rect {
      * update the renderable's bounding rect (private)
      * @ignore
      */
-    updateBoundsPos(newX?: number, newY?: number): void;
+    updateBoundsPos(newX?: any, newY?: any): void;
     /**
-     * return the renderable absolute position in the game world
-     * @returns {Vector2d}
-     */
+      * return the renderable absolute position in the game world
+      * @returns {Vector2d}
+      */
     getAbsolutePosition(): Vector2d;
     _absPos: object | undefined;
     /**
@@ -409,5 +403,4 @@ export default class Renderable extends Rect {
     onDestroyEvent(): void;
 }
 import Rect from "./../geometries/rectangle.js";
-import ObservableVector3d from "./../math/observable_vector3.js";
 import ObservableVector2d from "./../math/observable_vector2.js";

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

@@ -0,0 +1,151 @@
+/**
+ * @classdesc
+ * a bitmap font object
+ * @augments Renderable
+ */
+export default class BitmapText extends Renderable {
+    /**
+     * @param {number} x - position of the text object
+     * @param {number} y - position of the text object
+     * @param {object} settings - the text configuration
+     * @param {string|Image} settings.font - a font name to identify the corresponing source image
+     * @param {string} [settings.fontData=settings.font] - the bitmap font data corresponding name, or the bitmap font data itself
+     * @param {number} [settings.size] - size a scaling ratio
+     * @param {Color|string} [settings.fillStyle] - a CSS color value used to tint the bitmapText (@see BitmapText.tint)
+     * @param {number} [settings.lineWidth=1] - line width, in pixels, when drawing stroke
+     * @param {string} [settings.textAlign="left"] - horizontal text alignment
+     * @param {string} [settings.textBaseline="top"] - the text baseline
+     * @param {number} [settings.lineHeight=1.0] - line spacing height
+     * @param {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] - anchor point to draw the text at
+     * @param {number} [settings.wordWrapWidth] - the maximum length in CSS pixel for a single segment of text
+     * @param {(string|string[])} [settings.text] - a string, or an array of strings
+     * @example
+     * // Use me.loader.preload or me.loader.load to load assets
+     * me.loader.preload([
+     *     { name: "arial", type: "binary" src: "data/font/arial.fnt" },
+     *     { name: "arial", type: "image" src: "data/font/arial.png" },
+     * ])
+     * // Then create an instance of your bitmap font:
+     * let myFont = new me.BitmapText(x, y, {font:"arial", text:"Hello"});
+     * // two possibilities for using "myFont"
+     * // either call the draw function from your Renderable draw function
+     * myFont.draw(renderer, "Hello!", 0, 0);
+     * // or just add it to the word container
+     * me.game.world.addChild(myFont);
+     */
+    constructor(x: number, y: number, settings: {
+        font: string | (new (width?: number | undefined, height?: number | undefined) => HTMLImageElement);
+        fontData?: string | undefined;
+        size?: number | undefined;
+        fillStyle?: string | Color | undefined;
+        lineWidth?: number | undefined;
+        textAlign?: string | undefined;
+        textBaseline?: string | undefined;
+        lineHeight?: number | undefined;
+        anchorPoint?: any;
+        wordWrapWidth?: number | undefined;
+        text?: string | string[] | undefined;
+    });
+    /**
+     * Set the default text alignment (or justification),<br>
+     * possible values are "left", "right", and "center".
+     * @public
+     * @type {string}
+     * @default "left"
+     */
+    public textAlign: string;
+    /**
+     * Set the text baseline (e.g. the Y-coordinate for the draw operation), <br>
+     * possible values are "top", "hanging, "middle, "alphabetic, "ideographic, "bottom"<br>
+     * @public
+     * @type {string}
+     * @default "top"
+     */
+    public textBaseline: string;
+    /**
+     * Set the line spacing height (when displaying multi-line strings). <br>
+     * Current font height will be multiplied with this value to set the line height.
+     * @public
+     * @type {number}
+     * @default 1.0
+     */
+    public lineHeight: number;
+    /**
+     * the maximum length in CSS pixel for a single segment of text.
+     * (use -1 to disable word wrapping)
+     * @public
+     * @type {number}
+     * @default -1
+     */
+    public wordWrapWidth: number;
+    /**
+     * the text to be displayed
+     * @private
+     */
+    private _text;
+    /**
+     * scaled font size
+     * @private
+     */
+    private fontScale;
+    /**
+     * font image
+     * @private
+     */
+    private fontImage;
+    /**
+     * font data
+     * @private
+     */
+    private fontData;
+    public set fillStyle(arg: Color);
+    /**
+     * defines the color used to tint the bitmap text
+     * @public
+     * @type {Color}
+     * @see Renderable#tint
+     */
+    public get fillStyle(): Color;
+    metrics: TextMetrics;
+    /**
+     * change the font settings
+     * @param {string} textAlign - ("left", "center", "right")
+     * @param {number} [scale]
+     * @returns {BitmapText} this object for chaining
+     */
+    set(textAlign: string, scale?: number | undefined): BitmapText;
+    /**
+     * change the text to be displayed
+     * @param {number|string|string[]} value - a string, or an array of strings
+     * @returns {BitmapText} this object for chaining
+     */
+    setText(value?: number | string | string[]): BitmapText;
+    /**
+     * change the font display size
+     * @param {number} scale - ratio
+     * @returns {BitmapText} this object for chaining
+     */
+    resize(scale: number): BitmapText;
+    /**
+     * measure the given text size in pixels
+     * @param {string} [text]
+     * @returns {TextMetrics} a TextMetrics object with two properties: `width` and `height`, defining the output dimensions
+     */
+    measureText(text?: string | undefined): TextMetrics;
+    /**
+     * draw the bitmap font
+     * @param {CanvasRenderer|WebGLRenderer} renderer - Reference to the destination renderer instance
+     * @param {string} [text]
+     * @param {number} [x]
+     * @param {number} [y]
+     */
+    draw(renderer: CanvasRenderer | WebGLRenderer, text?: string | undefined, x?: number | undefined, y?: number | undefined): void;
+    /**
+     * Destroy function
+     * @ignore
+     */
+    destroy(): void;
+}
+import Renderable from "../renderable.js";
+import Color from "../../math/color.js";
+import TextMetrics from "./textmetrics.js";

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

@@ -0,0 +1,35 @@
+/**
+ * Class for storing relevant data from the font file.
+ * @ignore
+ */
+export default class BitmapTextData {
+    /**
+    * @param {string} data - The bitmap font data pulled from the resource loader using me.loader.getBinary()
+    */
+    constructor(data: string);
+    /**
+     * @ignore
+     */
+    onResetEvent(data: any): void;
+    padTop: number | undefined;
+    padRight: number | undefined;
+    padBottom: number | undefined;
+    padLeft: number | undefined;
+    lineHeight: number | undefined;
+    capHeight: any;
+    descent: any;
+    /**
+     * The map of glyphs, each key is a char code.
+     * @name glyphs
+     * @type {object}
+     * @memberof BitmapTextData
+     */
+    glyphs: object | undefined;
+    /**
+     * This parses the font data text and builds a map of glyphs containing the data for each character
+     * @name parse
+     * @memberof BitmapTextData
+     * @param {string} fontData
+     */
+    parse(fontData: string): void;
+}