Merge pull request #49 from nerochiaro/use_types

Use tiled-api npm package

Author: eleniums

.gitignore

@@ -49,3 +49,9 @@ Desktop.ini
 *.log*
 
 /.idea/
+
+######################
+# NPM
+######################
+
+/node_modules/

README.md

@@ -2,9 +2,9 @@
 
 Tiled plugins for exporting Tilemaps and Tilesets in Godot 3.2 format
 
- - export_to_godot_tilemap.js
- - export_to_godot_tileset.js
- - utils.js
+ - export_to_godot_tilemap.mjs
+ - export_to_godot_tileset.mjs
+ - utils.mjs
 
 The plugin requires Tiled version 1.3.4 or newer.
 
@@ -232,7 +232,7 @@ If you are using the plugins and have any problems, feature requests or have fou
 
 #### Customizing or contributing tips
 
-If you want to debug something you can use the utils.js
+If you want to debug something you can use the utils.mjs
 There are three useful functions:
  - log() - shortcut for the console.log (infinite parameters)
  - logf() - logs with flattening circular objects (single parameter)

export_to_godot_tilemap.mjs

@@ -4,6 +4,11 @@ import { getResPath, stringifyKeyValue, stringifyNode, splitCommaSeparated, getT
 class GodotTilemapExporter {
 
     // noinspection DuplicatedCode
+    /**
+     * Constructs a new instance of the tilemap exporter
+     * @param {TileMap} map the tilemap to export
+     * @param {string} fileName path of the file the tilemap should be exported to
+     */
     constructor(map, fileName) {
         this.map = map;
         this.fileName = fileName;
@@ -62,11 +67,8 @@ class GodotTilemapExporter {
 
     /**
      * Generate a string with all tilesets in the map.
-     * Godot allows only one tileset per tilemap so if you use more than one tileset per layer it's not going to work.
      * Godot supports several image textures per tileset but Tiled Editor doesn't.
-     * Tiled editor supports only one tile
-     * sprite image per tileset.
-     * @returns {string}
+     * Tiled editor supports only one tile sprite image per tileset.
      */
     setTilesetsString() {
 
@@ -98,6 +100,12 @@ class GodotTilemapExporter {
         }
     }
 
+    /**
+     * Handle exporting a single layer
+     * @param {Layer} layer the target layer
+     * @param {number} mode the layer mode
+     * @param {string} layer_parent path of the parent of the layer
+     */
     handleLayer(layer, mode, layer_parent) {
         // noinspection JSUnresolvedVariable
         if (layer.isTileLayer) {
@@ -246,6 +254,12 @@ class GodotTilemapExporter {
         }
     }
 
+    /**
+     * Prepare properties for a Godot node
+     * @param {TiledObjectProperties} object_props Properties from the layer
+     * @param {TiledObjectProperties} set_props The base properties for the node
+     * @returns {TiledObjectProperties} the merged property set for the node
+     */
     merge_properties(object_props, set_props){
         for (const [key, value] of Object.entries(object_props)) {
             if(key.startsWith("godot:node:")){
@@ -255,7 +269,12 @@ class GodotTilemapExporter {
 
         return set_props;
     }
-    
+
+    /**
+     * Prepare the meta properties for a Godot node
+     * @param {TiledObjectProperties} object_props
+     * @returns {object} the meta properties
+     */
     meta_properties(object_props){
         let results = {};
         for (const [key, value] of Object.entries(object_props)) {
@@ -276,11 +295,23 @@ class GodotTilemapExporter {
     }
 
     /**
-     * Creates all the tiles coordinate for the current layer and picks the first tileset which is used.
-     * It's important to not use more than one tileset for a layer.
-     * Otherwise the tiles from the second layer are going to be displayed incorrectly as tiles form the first
-     * or with a wrong index leading to crash on export.
-     * @returns {{tilesetID: *, poolIntArrayString: string, layerName: *}}
+     * @typedef {{
+     *      tileset: Tileset,
+     *      tilesetID: number?,
+     *      tilesetColumns: number,
+     *      layer: Layer,
+     *      isEmpty: boolean,
+     *      poolIntArrayString: string,
+     *      parent: string
+     * }} LayerData
+     */
+
+    /**
+     * Creates all the tiles coordinates for a layer.
+     * Each element in the retuned array corresponds to the tile coordinates for each of
+     * the tilesets used in the layer.
+     * @param {TileLayer} layer the target layer
+     * @returns {LayerData[]} the data about the tilesets used in the target layer
      */
     getLayerData(layer) {
         // noinspection JSUnresolvedVariable
@@ -370,10 +401,20 @@ class GodotTilemapExporter {
         return tilesetList;
     }
 
+    /**
+     * Find the id of a tileset by its name
+     * @param {Tileset} tileset The tileset to find the id of
+     * @returns {string|undefined} the id of the tileset if found, undefined otherwise
+     */
     getTilesetIDByTileset(tileset) {
         return this.tilesetsIndex.get(tileset.name);
     }
 
+    /**
+     * Calculate the second parameter for the given cell
+     * @param {cell} cell the target cell
+     * @returns {number} the second parameter
+     */
     getSecondParam(cell) {
         /**
          * no rotation or flips
@@ -523,6 +564,12 @@ ${this.tileMapsString}
 
     /**
      * Template for a tilemap node
+     * @param {string} tileMapName
+     * @param {number} mode
+     * @param {number} tilesetID
+     * @param {string} poolIntArrayString
+     * @param {Layer} layer
+     * @param {string} parent
      * @returns {string}
      */
     getTileMapTemplate(tileMapName, mode, tilesetID, poolIntArrayString, layer, parent = ".") {
@@ -563,9 +610,16 @@ const customTileMapFormat = {
     name: "Godot Tilemap format",
     extension: "tscn",
 
+    /**
+     * Map exporter function
+     * @param {TileMap} map the map to export
+     * @param {string} fileName path of the file where to export the map
+     * @returns {undefined}
+     */
     write: function (map, fileName) {
         const exporter = new GodotTilemapExporter(map, fileName);
         exporter.write();
+        return undefined;
     }
 };
 

export_to_godot_tileset.mjs

@@ -4,6 +4,11 @@ import { getResPath, getTilesetColumns } from './utils.mjs';
 class GodotTilesetExporter {
 
     // noinspection DuplicatedCode
+    /**
+     * Constructs a new instance of the tileset exporter
+     * @param {Tileset} tileset the tileset to export
+     * @param {string} fileName path of the file the tileset should be exported to
+     */
     constructor(tileset, fileName) {
         this.tileset = tileset;
         this.fileName = fileName;
@@ -89,6 +94,12 @@ class GodotTilesetExporter {
         this.shapes = this.shapes.replace(/,\s*$/, "");
     }
 
+    /**
+     * Exports the collision shape for an object
+     * @param {MapObject} object the object to export collision shape from
+     * @param {Tile} tile the tile the object is part of
+     * @param {point} autotileCoordinates autotile coordinates for the tile
+     */
     exportCollisions(object, tile, autotileCoordinates) {
         // noinspection JSUnresolvedVariable
         if (object.polygon.length > 0) {
@@ -100,6 +111,12 @@ class GodotTilesetExporter {
         }
     }
 
+    /**
+     * Exports the navigation shapes for an object
+     * @param {MapObject} object the object to export navigation shapes from
+     * @param {number} id the navigation shape id
+     * @param {point} autotileCoordinates autotile coordinates for the tile
+     */
     exportNavigations(object, id, autotileCoordinates) {
         if (object.polygon.length > 0) {
             this.shapesResources += this.getNavigationShapePolygon(id, object);
@@ -110,6 +127,11 @@ class GodotTilesetExporter {
         }
     }
 
+    /**
+     * Exports the shape resources for a tile
+     * @param {Tile} tile the target tile
+     * @param {point} autotileCoordinates autotile coordinates for the tile
+     */
     exportShapes(tile, autotileCoordinates) {
         if (this.firstShapeID === "") {
             this.firstShapeID = 'SubResource( ' + tile.id + ' )';
@@ -121,6 +143,11 @@ class GodotTilesetExporter {
         );
     }
 
+    /**
+     * Export a single navigation shape
+     * @param {number} id id of the shape
+     * @param {point} autotileCoordinates autotile coordinates for the tile
+     */
     exportNavigationShape(id, autotileCoordinates) {
         this.navpolyMap.push(`Vector2( ${autotileCoordinates.x}, ${autotileCoordinates.y} )`)
         this.navpolyMap.push(`SubResource( ${id} )`)
@@ -236,9 +263,16 @@ const customTilesetFormat = {
     name: "Godot Tileset format",
     extension: "tres",
 
+    /**
+     * Tileset exporter function
+     * @param {Tileset} tileset the tileset to export
+     * @param {string} fileName path of the file where to export the tileset
+     * @returns {undefined}
+     */
     write: function (tileset, fileName) {
         const exporter = new GodotTilesetExporter(tileset, fileName);
         exporter.write();
+        return undefined;
     }
 };
 

package-lock.json

@@ -0,0 +1,19 @@
+{
+  "name": "tiled-to-godot-export",
+  "version": "1.8.0",
+  "description": "Tiled plugins for exporting Tilemaps and Tilesets in Godot 3.x format",
+  "main": "export_to_godot_tilemap.mjs",
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:mapeditor/tiled-to-godot-export.git"
+  },
+  "author": "Mihail Ilinov <[email protected]>",
+  "license": "GPL-2.0-or-later",
+  "bugs": {
+    "url": "https://github.com/mapeditor/tiled-to-godot-export/issues"
+  },
+  "homepage": "https://github.com/mapeditor/tiled-to-godot-export",
+  "devDependencies": {
+    "@mapeditor/tiled-api": "^1.8.2"
+  }
+}

package.json

@@ -153,8 +153,10 @@ export function stringifyNode(nodeProperties, contentProperties = {}, metaProper
  *
  * @param {string} key
  * @param {string|array} value
- * @param {bool} quote
- * @param {bool} spaces
+ * @param {boolean} quoteKey
+ * @param {boolean} quoteValue
+ * @param {boolean} spaces
+ * @param {string} separator
  */
 export function stringifyKeyValue(key, value, quoteKey, quoteValue, spaces, separator = "=") {
   // flatten arrays