melonjs 14.2.0 → 14.4.0

package/dist/melonjs.mjs/level/tiled/TMXObject.js

@@ -1,9 +1,9 @@
 /*!
- * melonJS Game Engine - v14.2.0
+ * melonJS Game Engine - v14.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
- * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ * @copyright (C) 2011 - 2023 Olivier Biot (AltByte Pte Ltd)
  */
 import pool from '../../system/pooling.js';
 import { applyTMXProperties } from './TMXUtils.js';
@@ -22,185 +22,125 @@ class TMXObject {
 
         /**
          * point list in JSON format
-         * @public
          * @type {object[]}
-         * @name points
-         * @memberof TMXObject
          */
         this.points = undefined;
 
         /**
          * object name
-         * @public
          * @type {string}
-         * @name name
-         * @memberof TMXObject
          */
         this.name = settings.name;
 
         /**
          * object x position
-         * @public
          * @type {number}
-         * @name x
-         * @memberof TMXObject
          */
         this.x = +settings.x;
 
         /**
          * object y position
-         * @public
          * @type {number}
-         * @name y
-         * @memberof TMXObject
          */
         this.y = +settings.y;
 
         /**
          * object z order
-         * @public
          * @type {number}
-         * @name z
-         * @memberof TMXObject
          */
         this.z = +z;
 
         /**
          * object width
-         * @public
          * @type {number}
-         * @name width
-         * @memberof TMXObject
          */
         this.width = +settings.width || 0;
 
         /**
          * object height
-         * @public
          * @type {number}
-         * @name height
-         * @memberof TMXObject
          */
         this.height = +settings.height || 0;
 
         /**
          * object gid value
          * when defined the object is a tiled object
-         * @public
          * @type {number}
-         * @name gid
-         * @memberof TMXObject
          */
         this.gid = +settings.gid || null;
 
         /**
          * tint color
-         * @public
          * @type {string}
-         * @name tintcolor
-         * @memberof TMXObject
          */
         this.tintcolor = settings.tintcolor;
 
         /**
          * object type
-         * @public
          * @type {string}
          * @deprecated since Tiled 1.9
          * @see https://docs.mapeditor.org/en/stable/reference/tmx-changelog/#tiled-1-9
-         * @name type
-         * @memberof TMXObject
          */
         this.type = settings.type;
 
         /**
          * the object class
-         * @public
          * @type {string}
-         * @name class
-         * @memberof TMXObject
          */
         this.class = typeof settings.class !== "undefined" ? settings.class : settings.type;
 
         /**
          * object text
-         * @public
          * @type {object}
          * @see http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#text
-         * @name text
-         * @memberof TMXObject
          */
         this.text = undefined;
 
         /**
          * The rotation of the object in radians clockwise (defaults to 0)
-         * @public
          * @type {number}
-         * @name rotation
-         * @memberof TMXObject
          */
         this.rotation = degToRad(+settings.rotation || 0);
 
         /**
          * object unique identifier per level (Tiled 0.11.x+)
-         * @public
          * @type {number}
-         * @name id
-         * @memberof TMXObject
          */
         this.id = +settings.id || undefined;
 
         /**
          * object orientation (orthogonal or isometric)
-         * @public
          * @type {string}
-         * @name orientation
-         * @memberof TMXObject
          */
         this.orientation = map.orientation;
 
         /**
          * the collision shapes defined for this object
-         * @public
          * @type {object[]}
-         * @name shapes
-         * @memberof TMXObject
          */
         this.shapes = undefined;
 
         /**
          * if true, the object is an Ellipse
-         * @public
          * @type {boolean}
-         * @name isEllipse
-         * @memberof TMXObject
          */
         this.isEllipse = false;
 
         /**
          * if true, the object is a Point
-         * @public
          * @type {boolean}
-         * @name isPoint
-         * @memberof TMXObject
          */
         this.isPoint = false;
 
         /**
          * if true, the object is a Polygon
-         * @public
          * @type {boolean}
-         * @name isPolygon
-         * @memberof TMXObject
          */
         this.isPolygon = false;
 
         /**
          * if true, the object is a PolyLine
-         * @public
          * @type {boolean}
-         * @name isPolyLine
-         * @memberof TMXObject
          */
         this.isPolyLine = false;
 
@@ -272,8 +212,6 @@ class TMXObject {
 
     /**
      * parses the TMX shape definition and returns a corresponding array of me.Shape object
-     * @name parseTMXShapes
-     * @memberof TMXObject
      * @private
      * @returns {Polygon[]|Line[]|Ellipse[]} an array of shape objects
      */

package/dist/melonjs.mjs/level/tiled/TMXTile.js

@@ -1,19 +1,14 @@
 /*!
- * melonJS Game Engine - v14.2.0
+ * melonJS Game Engine - v14.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
- * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ * @copyright (C) 2011 - 2023 Olivier Biot (AltByte Pte Ltd)
  */
 import Matrix2d from '../../math/matrix2.js';
 import Sprite from '../../renderable/sprite.js';
 import Bounds from '../../physics/bounds.js';
-
-// bitmask constants to check for flipped & rotated tiles
-const TMX_FLIP_H          = 0x80000000,
-      TMX_FLIP_V          = 0x40000000,
-      TMX_FLIP_AD         = 0x20000000,
-      TMX_CLEAR_BIT_MASK  = ~(0x80000000 | 0x40000000 | 0x20000000);
+import { TMX_CLEAR_BIT_MASK, TMX_FLIP_H, TMX_FLIP_V, TMX_FLIP_AD } from './constants.js';
 
 /**
  * @classdesc
@@ -47,9 +42,7 @@ const TMX_FLIP_H          = 0x80000000,
 
         /**
          * tileset
-         * @public
          * @type {TMXTileset}
-         * @name Tile#tileset
          */
         this.tileset = tileset;
 
@@ -65,38 +58,31 @@ const TMX_FLIP_H          = 0x80000000,
 
         /**
          * tileId
-         * @public
          * @type {number}
-         * @name Tile#tileId
          */
         this.tileId = gid;
+
         /**
-         * True if the tile is flipped horizontally<br>
-         * @public
+         * True if the tile is flipped horizontally
          * @type {boolean}
-         * @name Tile#flipX
          */
         this.flippedX  = (this.tileId & TMX_FLIP_H) !== 0;
+
         /**
-         * True if the tile is flipped vertically<br>
-         * @public
+         * True if the tile is flipped vertically
          * @type {boolean}
-         * @name Tile#flippedY
          */
         this.flippedY  = (this.tileId & TMX_FLIP_V) !== 0;
+
         /**
-         * True if the tile is flipped anti-diagonally<br>
-         * @public
+         * True if the tile is flipped anti-diagonally
          * @type {boolean}
-         * @name Tile#flippedAD
          */
         this.flippedAD = (this.tileId & TMX_FLIP_AD) !== 0;
 
         /**
-         * Global flag that indicates if the tile is flipped<br>
-         * @public
+         * Global flag that indicates if the tile is flipped
          * @type {boolean}
-         * @name Tile#flipped
          */
         this.flipped = this.flippedX || this.flippedY || this.flippedAD;
 
@@ -137,8 +123,6 @@ const TMX_FLIP_H          = 0x80000000,
 
     /**
      * return a renderable object for this Tile object
-     * @name Tile#getRenderable
-     * @public
      * @param {object} [settings] - see {@link Sprite}
      * @returns {Renderable} a me.Sprite object
      */

package/dist/melonjs.mjs/level/tiled/TMXTileMap.js

@@ -1,53 +1,25 @@
 /*!
- * melonJS Game Engine - v14.2.0
+ * melonJS Game Engine - v14.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
- * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ * @copyright (C) 2011 - 2023 Olivier Biot (AltByte Pte Ltd)
  */
 import pool from '../../system/pooling.js';
 import { off, on, VIEWPORT_ONRESIZE } from '../../system/event.js';
-import game from '../../game.js';
+import { game } from '../../index.js';
+import utils from '../../utils/utils.js';
 import collision from '../../physics/collision.js';
 import Body from '../../physics/body.js';
-import TMXOrthogonalRenderer from './renderer/TMXOrthogonalRenderer.js';
-import TMXIsometricRenderer from './renderer/TMXIsometricRenderer.js';
-import TMXHexagonalRenderer from './renderer/TMXHexagonalRenderer.js';
-import TMXStaggeredRenderer from './renderer/TMXStaggeredRenderer.js';
 import TMXTileset from './TMXTileset.js';
 import TMXTilesetGroup from './TMXTilesetGroup.js';
 import TMXGroup from './TMXGroup.js';
 import TMXLayer from './TMXLayer.js';
 import { applyTMXProperties } from './TMXUtils.js';
 import Container from '../../renderable/container.js';
-
-// constant to identify the collision object layer
-const COLLISION_GROUP = "collision";
-
-/**
- * set a compatible renderer object
- * for the specified map
- * @ignore
- */
-function getNewDefaultRenderer(map) {
-    switch (map.orientation) {
-        case "orthogonal":
-            return new TMXOrthogonalRenderer(map);
-
-        case "isometric":
-            return new TMXIsometricRenderer(map);
-
-        case "hexagonal":
-            return new TMXHexagonalRenderer(map);
-
-        case "staggered":
-            return new TMXStaggeredRenderer(map);
-
-        // if none found, throw an exception
-        default:
-            throw new Error(map.orientation + " type TMX Tile Map not supported!");
-    }
-}
+import { COLLISION_GROUP } from './constants.js';
+import { getNewTMXRenderer } from './renderer/autodetect.js';
+import { warning } from '../../lang/console.js';
 
 /**
  * read the layer Data
@@ -129,96 +101,73 @@ function readObjectGroup(map, data, z) {
 
         /**
          * name of the tilemap
-         * @public
          * @type {string}
-         * @name TMXTileMap#name
          */
         this.name = levelId;
 
         /**
          * width of the tilemap in tiles
-         * @public
          * @type {number}
-         * @name TMXTileMap#cols
          */
         this.cols = +data.width;
+
         /**
          * height of the tilemap in tiles
-         * @public
          * @type {number}
-         * @name TMXTileMap#rows
          */
         this.rows = +data.height;
 
         /**
          * Tile width
-         * @public
          * @type {number}
-         * @name TMXTileMap#tilewidth
          */
         this.tilewidth = +data.tilewidth;
 
         /**
          * Tile height
-         * @public
          * @type {number}
-         * @name TMXTileMap#tileheight
          */
         this.tileheight = +data.tileheight;
 
         /**
          * is the map an infinite map
-         * @public
          * @type {number}
          * @default 0
-         * @name TMXTileMap#infinite
          */
-        this.infinite = +data.infinite;
+        this.infinite = +data.infinite || 0;
 
         /**
          * the map orientation type. melonJS supports “orthogonal”, “isometric”, “staggered” and “hexagonal”.
-         * @public
          * @type {string}
          * @default "orthogonal"
-         * @name TMXTileMap#orientation
          */
         this.orientation = data.orientation;
 
         /**
          * the order in which tiles on orthogonal tile layers are rendered.
          * (valid values are "left-down", "left-up", "right-down", "right-up")
-         * @public
          * @type {string}
          * @default "right-down"
-         * @name TMXTileMap#renderorder
          */
         this.renderorder = data.renderorder || "right-down";
 
         /**
          * the TMX format version
-         * @public
          * @type {string}
-         * @name TMXTileMap#version
          */
-        this.version = data.version;
+        this.version = "" + data.version;
 
         /**
          * The Tiled version used to save the file (since Tiled 1.0.1).
-         * @public
          * @type {string}
-         * @name TMXTileMap#tiledversion
          */
-        this.tiledversion = data.tiledversion;
-
+        this.tiledversion = "" + data.tiledversion;
 
         /**
          * The map class.
-         * @public
          * @type {string}
-         * @name TMXTileMap#class
          */
-         this.class = data.class;
-
+        this.class = data.class;
 
         // tilesets for this map
         this.tilesets = null;
@@ -235,7 +184,6 @@ function readObjectGroup(map, data, z) {
         // Check if map is from melon editor
         this.isEditor = data.editor === "melon-editor";
 
-
         // object id
         this.nextobjectid = +data.nextobjectid || undefined;
 
@@ -254,37 +202,31 @@ function readObjectGroup(map, data, z) {
         // background color
         this.backgroundcolor = data.backgroundcolor;
 
+        // deprecation warning if map tiled version is older than 1.5
+        if (utils.checkVersion(this.version, "1.5") < 0) {
+            warning("("+this.name+") Tiled Map format version 1.4 and below", "Tiled 1.5 or higher", "10.4.4");
+        }
+
         // set additional map properties (if any)
         applyTMXProperties(this, data);
 
         // internal flag
         this.initialized = false;
-
-        if (this.infinite === 1) {
-            // #956 Support for Infinite map
-            // see as well in me.TMXUtils
-            throw new Error("Tiled Infinite Map not supported!");
-        }
     }
 
     /**
      * Return the map default renderer
-     * @name getRenderer
-     * @memberof TMXTileMap
-     * @public
      * @returns {TMXRenderer} a TMX renderer
      */
     getRenderer() {
         if ((typeof(this.renderer) === "undefined") || (!this.renderer.canRender(this))) {
-            this.renderer = getNewDefaultRenderer(this);
+            this.renderer = getNewTMXRenderer(this);
         }
         return this.renderer;
     }
 
     /**
      * return the map bounding rect
-     * @name TMXRenderer#getBounds
-     * @public
      * @returns {Bounds}
      */
     getBounds() {
@@ -362,8 +304,6 @@ function readObjectGroup(map, data, z) {
     /**
      * add all the map layers and objects to the given container.
      * note : this will not automatically update the camera viewport
-     * @name TMXTileMap#addTo
-     * @public
      * @param {Container} container - target container
      * @param {boolean} [flatten=true] - if true, flatten all objects into the given container, else a `me.Container` object will be created for each corresponding groups
      * @param {boolean} [setViewportBounds=false] - if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.
@@ -438,8 +378,6 @@ function readObjectGroup(map, data, z) {
 
     /**
      * return an Array of instantiated objects, based on the map object definition
-     * @name TMXTileMap#getObjects
-     * @public
      * @param {boolean} [flatten=true] - if true, flatten all objects into the returned array.
      * when false, a `me.Container` object will be created for each corresponding groups
      * @returns {Renderable[]} Array of Objects
@@ -610,8 +548,6 @@ function readObjectGroup(map, data, z) {
 
     /**
      * return all the existing layers
-     * @name TMXTileMap#getLayers
-     * @public
      * @returns {TMXLayer[]} Array of Layers
      */
     getLayers() {
@@ -622,8 +558,6 @@ function readObjectGroup(map, data, z) {
 
     /**
      * destroy function, clean all allocated objects
-     * @name TMXTileMap#destroy
-     * @public
      */
     destroy() {
         this.tilesets = undefined;

package/dist/melonjs.mjs/level/tiled/TMXTileset.js

@@ -1,9 +1,9 @@
 /*!
- * melonJS Game Engine - v14.2.0
+ * melonJS Game Engine - v14.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
- * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ * @copyright (C) 2011 - 2023 Olivier Biot (AltByte Pte Ltd)
  */
 import Vector2d from '../../math/vector2.js';
 import { renderer } from '../../video/video.js';
@@ -55,25 +55,19 @@ import loader from '../../loader/loader.js';
 
         /**
          * Tileset contains animated tiles
-         * @public
          * @type {boolean}
-         * @name TMXTileset#isAnimated
          */
         this.isAnimated = false;
 
         /**
          * true if the tileset is a "Collection of Image" Tileset
-         * @public
          * @type {boolean}
-         * @name TMXTileset#isCollection
          */
         this.isCollection = false;
 
         /**
          * the tileset class
-         * @public
          * @type {boolean}
-         * @name TMXTileset#class
          */
         this.class = tileset.class;
 
@@ -179,8 +173,6 @@ import loader from '../../loader/loader.js';
 
     /**
      * return the tile image from a "Collection of Image" tileset
-     * @name TMXTileset#getTileImage
-     * @public
      * @param {number} gid
      * @returns {Image} corresponding image or undefined
      */
@@ -200,8 +192,6 @@ import loader from '../../loader/loader.js';
 
     /**
      * return true if the gid belongs to the tileset
-     * @name TMXTileset#contains
-     * @public
      * @param {number} gid
      * @returns {boolean}
      */
@@ -211,8 +201,6 @@ import loader from '../../loader/loader.js';
 
     /**
      * Get the view (local) tile ID from a GID, with animations applied
-     * @name TMXTileset#getViewTileId
-     * @public
      * @param {number} gid - Global tile ID
      * @returns {number} View tile ID
      */
@@ -229,8 +217,6 @@ import loader from '../../loader/loader.js';
 
     /**
      * return the properties of the specified tile
-     * @name TMXTileset#getTileProperties
-     * @public
      * @param {number} tileId
      * @returns {object}
      */

package/dist/melonjs.mjs/level/tiled/TMXTilesetGroup.js

@@ -1,12 +1,11 @@
 /*!
- * melonJS Game Engine - v14.2.0
+ * melonJS Game Engine - v14.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
- * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ * @copyright (C) 2011 - 2023 Olivier Biot (AltByte Pte Ltd)
  */
-// bitmask constants to check for flipped & rotated tiles
-const TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
+import { TMX_CLEAR_BIT_MASK } from './constants.js';
 
 /**
  * @classdesc
@@ -21,8 +20,6 @@ const TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
 
     /**
      * add a tileset to the tileset group
-     * @name TMXTilesetGroup#add
-     * @public
      * @param {TMXTileset} tileset
      */
     add(tileset) {
@@ -32,8 +29,6 @@ const TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
 
     /**
      * return the tileset at the specified index
-     * @name TMXTilesetGroup#getTilesetByIndex
-     * @public
      * @param {number} i
      * @returns {TMXTileset} corresponding tileset
      */
@@ -44,8 +39,6 @@ const TMX_CLEAR_BIT_MASK = ~(0x80000000 | 0x40000000 | 0x20000000);
     /**
      * return the tileset corresponding to the specified id <br>
      * will throw an exception if no matching tileset is found
-     * @name TMXTilesetGroup#getTilesetByGid
-     * @public
      * @param {number} gid
      * @returns {TMXTileset} corresponding tileset
      */