melonjs 15.1.6 → 15.2.1

package/dist/types/index.d.ts

@@ -40,9 +40,9 @@ import * as loader from "./loader/loader.js";
 import level from "./level/level.js";
 import * as input from "./input/input.js";
 import * as Math from "./math/math.js";
-import { plugin } from "./plugin/plugin.js";
-import { plugins } from "./plugin/plugin.js";
-import utils from "./utils/utils.js";
+import * as plugin from "./plugin/plugin.js";
+import { cache as plugins } from "./plugin/plugin.js";
+import * as utils from "./utils/utils.js";
 import save from "./system/save.js";
 import timer from "./system/timer.js";
 import pool from "./system/pooling.js";
@@ -100,6 +100,7 @@ import TMXTileset from "./level/tiled/TMXTileset.js";
 import TMXTilesetGroup from "./level/tiled/TMXTilesetGroup.js";
 import TMXTileMap from "./level/tiled/TMXTileMap.js";
 import TMXLayer from "./level/tiled/TMXLayer.js";
+import * as TMXUtils from "./level/tiled/TMXUtils.js";
 import Pointer from "./input/pointer.js";
 import Stage from "./state/stage.js";
 import Camera2d from "./camera/camera2d.js";
@@ -110,4 +111,4 @@ import ParticleEmitterSettings from "./particles/settings.js";
 import Particle from "./particles/particle.js";
 import Entity from "./entity/entity.js";
 import Application from "./application/application.js";
-export { audio, collision, device, event, loader, level, input, Math, plugin, plugins, utils, save, timer, pool, state, video, Color, Vector2d, Vector3d, ObservableVector2d, ObservableVector3d, Matrix2d, Matrix3d, Polygon, Line, Ellipse, Point, Rect, RoundRect, Tween, QuadTree, GLShader, Compositor, PrimitiveCompositor, QuadCompositor, Renderer, WebGLRenderer, CanvasRenderer, CanvasTexture, TextureAtlas, Renderable, Body, Bounds, Text, BitmapText, BitmapTextData, ColorLayer, ImageLayer, Sprite, NineSliceSprite, UIBaseElement, UITextButton, UISpriteElement, Collectable, Trigger, Light2d, Draggable, DropTarget, TMXRenderer, TMXOrthogonalRenderer, TMXIsometricRenderer, TMXHexagonalRenderer, TMXStaggeredRenderer, Tile, TMXTileset, TMXTilesetGroup, TMXTileMap, TMXLayer, Pointer, Stage, Camera2d, Container, World, ParticleEmitter, ParticleEmitterSettings, Particle, Entity, Application };
+export { audio, collision, device, event, loader, level, input, Math, plugin, plugins, utils, save, timer, pool, state, video, Color, Vector2d, Vector3d, ObservableVector2d, ObservableVector3d, Matrix2d, Matrix3d, Polygon, Line, Ellipse, Point, Rect, RoundRect, Tween, QuadTree, GLShader, Compositor, PrimitiveCompositor, QuadCompositor, Renderer, WebGLRenderer, CanvasRenderer, CanvasTexture, TextureAtlas, Renderable, Body, Bounds, Text, BitmapText, BitmapTextData, ColorLayer, ImageLayer, Sprite, NineSliceSprite, UIBaseElement, UITextButton, UISpriteElement, Collectable, Trigger, Light2d, Draggable, DropTarget, TMXRenderer, TMXOrthogonalRenderer, TMXIsometricRenderer, TMXHexagonalRenderer, TMXStaggeredRenderer, Tile, TMXTileset, TMXTilesetGroup, TMXTileMap, TMXLayer, TMXUtils, Pointer, Stage, Camera2d, Container, World, ParticleEmitter, ParticleEmitterSettings, Particle, Entity, Application };

package/dist/types/level/tiled/TMXUtils.d.ts

@@ -1,48 +1,31 @@
 /**
- * decompress and decode zlib/gzip data
- * @ignore
- * @name decompress
- * @param {string} input - Base64 encoded and compressed data
- * @param {string} format - compressed data format ("gzip","zlib", "zstd")
- * @returns {Uint32Array} Decoded and decompress data
+ * set the function used to inflate gzip/zlib data
+ * @param {Func} fn - inflate function
  */
-export function decompress(data: any, format: string): Uint32Array;
+export function setInflateFunction(fn: Func): void;
 /**
- * Decode a CSV encoded array into a binary array
- * @ignore
+ * Decode a encoded array into a binary array
  * @name decodeCSV
- * @param  {string} input- -  CSV formatted data (only numbers, everything else will be converted to NaN)
+ * @memberOf TMXUtils
+ * @param {string} data - data to be decoded
+ * @param {string} [encoding="none"] - data encoding ("csv", "base64", "xml")
  * @returns {number[]} Decoded data
  */
-export function decodeCSV(input: any): number[];
-/**
- * Decode a base64 encoded string into a byte array
- * @ignore
- * @name decodeBase64AsArray
- * @param {string} input - Base64 encoded data
- * @param {number} [bytes] - number of bytes per array entry
- * @returns {Uint32Array} Decoded data
- */
-export function decodeBase64AsArray(input: string, bytes?: number | undefined): Uint32Array;
-/**
- * Decode the given data
- * @ignore
- */
-export function decode(data: any, encoding: any, compression: any): any;
-/**
- * Normalize TMX format to Tiled JSON format
- * @ignore
- */
-export function normalize(obj: any, item: any): void;
+export function decode(data: string, encoding?: string | undefined, compression: any): number[];
 /**
  * Parse a XML TMX object and returns the corresponding javascript object
- * @ignore
+ * @name parse
+ * @memberOf TMXUtils
+ * @param {Document} xml - XML TMX object
+ * @returns {object} Javascript object
  */
-export function parse(xml: any): {
-    text: string;
-};
+export function parse(xml: Document): object;
 /**
  * Apply TMX Properties to the given object
- * @ignore
+ * @name applyTMXProperties
+ * @memberOf TMXUtils
+ * @param {object} obj - object to apply the properties to
+ * @param {object} data - TMX data object
+ * @returns {object} obj
  */
-export function applyTMXProperties(obj: any, data: any): void;
+export function applyTMXProperties(obj: object, data: object): object;

package/dist/types/plugin/plugin.d.ts

@@ -1,10 +1,65 @@
 /**
- * This namespace is a container for all registered plugins.
- * @see plugin.register
- * @namespace plugins
+ * patch a melonJS function
+ * @name patch
+ * @memberof plugin
+ * @param {object} proto - target object
+ * @param {string} name - target function
+ * @param {Function} fn - replacement function
+ * @example
+ * // redefine the me.game.update function with a new one
+ * me.plugin.patch(me.game, "update", function () {
+ *   // display something in the console
+ *   console.log("duh");
+ *   // call the original me.game.update function
+ *   this._patched();
+ * });
  */
-export let plugins: {};
+export function patch(proto: object, name: string, fn: Function): void;
+/**
+ * Register a plugin.
+ * @name register
+ * @memberof plugin
+ * @param {plugin.BasePlugin} plugin - Plugin object to instantiate and register
+ * @param {string} [name=plugin.constructor.name] - a unique name for this plugin
+ * @param {object} [...arguments] - all extra parameters will be passed to the plugin constructor
+ * @example
+ * // register a new plugin
+ * me.plugin.register(TestPlugin, "testPlugin");
+ * // the plugin then also become available
+ * // under then me.plugins namespace
+ * me.plugins.testPlugin.myfunction ();
+ */
+export function register(plugin: plugin.BasePlugin, name?: string | undefined, ...args: any[]): void;
+/**
+ * Contains all registered plugins.
+ * @name cache
+ * @memberof plugin
+ */
+export let cache: {};
 /**
  * @namespace plugin
  */
-export let plugin: any;
+/**
+ * a base Object class for plugin
+ * (plugin must be installed using the register function)
+ * @class
+ * @name BasePlugin
+ * @memberof plugin
+ */
+export class BasePlugin {
+    /**
+     * define the minimum required version of melonJS<br>
+     * this can be overridden by the plugin
+     * @type {string}
+     * @default "__VERSION__"
+     */
+    version: string;
+}
+/**
+ * @class
+ * @name Base
+ * @memberof plugin
+ * @deprecated since 15.1.6, see {@link plugin.BasePlugin}
+ */
+export class Base extends BasePlugin {
+}

package/dist/types/utils/utils.d.ts

@@ -1,17 +1,56 @@
-export default utils;
-declare namespace utils {
-    export { agentUtils as agent };
-    export { arrayUtils as array };
-    export { fileUtils as file };
-    export { stringUtils as string };
-    export { fnUtils as function };
-    export function checkVersion(first: string, second: string): number;
-    export function getUriFragment(url?: string | undefined): object;
-    export function resetGUID(base: any, index?: number): void;
-    export function createGUID(index?: number): string;
-}
-import * as agentUtils from "./agent.js";
-import * as arrayUtils from "./array.js";
-import * as fileUtils from "./file.js";
-import * as stringUtils from "./string.js";
-import * as fnUtils from "./function.js";
+/**
+ * Compare two version strings
+ * @public
+ * @memberof utils
+ * @name checkVersion
+ * @param {string} first - First version string to compare
+ * @param {string} second - second version string to compare
+ * @returns {number} comparison result <br>&lt; 0 : first &lt; second<br>
+ * 0 : first == second<br>
+ * &gt; 0 : first &gt; second
+ * @example
+ * if (me.utils.checkVersion("7.0.0") > 0) {
+ *     console.error(
+ *         "melonJS is too old. Expected: 7.0.0, Got: 6.3.0"
+ *     );
+ * }
+ */
+export function checkVersion(first: string, second: string): number;
+/**
+ * parse the fragment (hash) from a URL and returns them into
+ * @public
+ * @memberof utils
+ * @name getUriFragment
+ * @param {string} [url=document.location] - an optional params string or URL containing fragment (hash) params to be parsed
+ * @returns {object} an object representing the deserialized params string.
+ * @property {boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
+ * @property {boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
+ * @property {boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
+ * @property {boolean} [webgl=false] force the renderer to WebGL
+ * @property {boolean} [debug=false] display the debug panel (if preloaded)
+ * @property {string} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
+ * @example
+ * // http://www.example.com/index.html#debug&hitbox=true&mytag=value
+ * let UriFragment = me.utils.getUriFragment();
+ * console.log(UriFragment["mytag"]); //> "value"
+ */
+export function getUriFragment(url?: string | undefined): object;
+/**
+ * reset the GUID Base Name
+ * the idea here being to have a unique ID
+ * per level / object
+ * @ignore
+ */
+export function resetGUID(base: any, index?: number): void;
+/**
+ * create and return a very simple GUID
+ * Game Unique ID
+ * @ignore
+ */
+export function createGUID(index?: number): string;
+export * as agent from "./agent.js";
+export * as array from "./array.js";
+export * as file from "./file.js";
+export * as string from "./string.js";
+export * as _function from "./function.js";
+export { _function as function };

package/dist/types/video/video.d.ts

@@ -64,30 +64,10 @@ export function createCanvas(width: number, height: number, returnOffscreenCanva
  * @returns {HTMLElement}
  */
 export function getParent(): HTMLElement;
-/**
- * @namespace video
- */
-/**
- * Select the HTML5 Canvas renderer
- * @memberof video
- * @static
- */
-export const CANVAS: number;
-/**
- * Select the WebGL renderer
- * @memberof video
- * @static
- */
-export const WEBGL: number;
-/**
- * Auto-select the renderer (Attempt WebGL first, with fallback to Canvas)
- * @memberof video
- * @static
- */
-export const AUTO: number;
 /**
  * A reference to the active Canvas or WebGL active renderer renderer
  * @memberof video
  * @type {CanvasRenderer|WebGLRenderer}
  */
 export let renderer: CanvasRenderer | WebGLRenderer;
+export { CANVAS, WEBGL, AUTO } from "../const";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "15.1.6",
+  "version": "15.2.1",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "type": "module",
@@ -63,7 +63,7 @@
     "@babel/plugin-syntax-import-assertions": "^7.20.0",
     "@fastify/static": "^6.10.1",
     "@melonjs/webdoc-theme": "^1.1.1",
-    "@rollup/plugin-commonjs": "^24.1.0",
+    "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-image": "^3.0.2",
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-replace": "^5.0.2",
@@ -72,14 +72,14 @@
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
     "eslint": "^8.40.0",
-    "eslint-plugin-jsdoc": "^44.1.0",
+    "eslint-plugin-jsdoc": "^44.2.3",
     "expect": "^29.5.0",
     "expect-mocha-image-snapshot": "^3.0.13",
     "fastify": "^4.17.0",
     "mocha": "^10.2.0",
     "npm-self-link": "^1.1.7",
-    "puppeteer": "^20.1.2",
-    "rollup": "^3.21.6",
+    "puppeteer": "^20.2.0",
+    "rollup": "^3.21.7",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
     "terser": "^5.17.3",

package/src/application/application.js

@@ -2,7 +2,7 @@ import { autoDetectRenderer } from "../video/utils/autodetect.js";
 import CanvasRenderer from "./../video/canvas/canvas_renderer.js";
 import * as device from "./../system/device.js";
 import * as event from "./../system/event.js";
-import utils from "./../utils/utils.js";
+import { getUriFragment } from "./../utils/utils.js";
 import timer from "./../system/timer.js";
 import state from "./../state/state.js";
 import World from "./../physics/world.js";
@@ -149,7 +149,7 @@ import { CANVAS, WEBGL, AUTO } from "../const.js";
         }
 
         // override renderer settings if &webgl or &canvas is defined in the URL
-        let uriFragment = utils.getUriFragment();
+        let uriFragment = getUriFragment();
         if (uriFragment.webgl === true || uriFragment.webgl1 === true || uriFragment.webgl2 === true) {
             this.settings.renderer = WEBGL;
             if (uriFragment.webgl1 === true) {

package/src/index.js

@@ -54,6 +54,7 @@ import TMXTileset from "./level/tiled/TMXTileset.js";
 import TMXTilesetGroup from "./level/tiled/TMXTilesetGroup.js";
 import TMXTileMap from "./level/tiled/TMXTileMap.js";
 import TMXLayer from "./level/tiled/TMXLayer.js";
+import * as TMXUtils from "./level/tiled/TMXUtils.js";
 import Pointer from "./input/pointer.js";
 import Stage from "./state/stage.js";
 import Camera2d from "./camera/camera2d.js";
@@ -72,9 +73,10 @@ import * as event from "./system/event.js";
 import * as device from "./system/device.js";
 import * as loader from "./loader/loader.js";
 import * as Math from "./math/math.js";
-import utils from "./utils/utils.js";
+import * as utils from "./utils/utils.js";
 import * as input from "./input/input.js";
-import { plugin, plugins } from "./plugin/plugin.js";
+import * as plugin from "./plugin/plugin.js";
+import { cache as plugins } from "./plugin/plugin.js";
 import * as video from "./video/video.js";
 import save from "./system/save.js";
 import timer from "./system/timer.js";
@@ -166,6 +168,7 @@ export {
     TMXTilesetGroup,
     TMXTileMap,
     TMXLayer,
+    TMXUtils,
     Pointer,
     Stage,
     Camera2d,

package/src/level/level.js

@@ -1,4 +1,5 @@
-import utils from "./../utils/utils.js";
+import { resetGUID } from "./../utils/utils.js";
+import { defer } from "../utils/function.js";
 import * as event from "./../system/event.js";
 import state from "./../state/state.js";
 import { getTMX } from "./../loader/loader.js";
@@ -62,7 +63,7 @@ function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
 
     // reset the GUID generator
     // and pass the level id as parameter
-    utils.resetGUID(levelId, level.nextobjectid);
+    resetGUID(levelId, level.nextobjectid);
 
     // Tiled use 0,0 anchor coordinates
     container.anchorPoint.set(0, 0);
@@ -178,7 +179,7 @@ let level = {
                 // some silly side effects
                 state.stop();
 
-                utils.function.defer(safeLoadLevel, this, levelId, options, true);
+                defer(safeLoadLevel, this, levelId, options, true);
             }
             else {
                 safeLoadLevel(levelId, options);

package/src/level/tiled/TMXTileMap.js

@@ -1,7 +1,7 @@
 import pool from "./../../system/pooling.js";
 import * as event from "./../../system/event.js";
 import { game } from "../../index.js";
-import utils from "./../../utils/utils.js";
+import { checkVersion } from "./../../utils/utils.js";
 import collision from "./../../physics/collision.js";
 import Body from "./../../physics/body.js";
 import TMXTileset from "./TMXTileset.js";
@@ -198,7 +198,7 @@ function readObjectGroup(map, data, z) {
         // if version is undefined or empty it usually means the map was not created with Tiled
         if (this.version !== "undefined" && this.version !== "") {
             // deprecation warning if map tiled version is older than 1.5
-            if (utils.checkVersion(this.version, "1.5") < 0) {
+            if (checkVersion(this.version, "1.5") < 0) {
                 warning("("+this.name+") Tiled Map format version 1.4 and below", "format 1.5 or higher", "10.4.4");
             }
         }

package/src/level/tiled/TMXUtils.js

@@ -1,4 +1,16 @@
-import utils from "../../utils/utils.js";
+import { isBoolean, isNumeric } from "../../utils/string.js";
+
+/**
+ * a collection of utility functions for parsing TMX maps
+ * @namespace TMXUtils
+ */
+
+
+/**
+ * the function used to decompress zlib/gzip data
+ * @ignore
+ */
+let inflateFunction;
 
 /**
  * set and interpret a TMX property value
@@ -25,11 +37,11 @@ function setTMXValue(name, type, value) {
 
         default :
             // try to parse it anyway
-            if (!value || utils.string.isBoolean(value)) {
+            if (!value || isBoolean(value)) {
                 // if value not defined or boolean
                 value = value ? (value === "true") : true;
             }
-            else if (utils.string.isNumeric(value)) {
+            else if (isNumeric(value)) {
                 // check if numeric
                 value = Number(value);
             }
@@ -95,99 +107,11 @@ function parseAttributes(obj, elt) {
     }
 }
 
-/**
- * decompress and decode zlib/gzip data
- * @ignore
- * @name decompress
- * @param {string} input - Base64 encoded and compressed data
- * @param {string} format - compressed data format ("gzip","zlib", "zstd")
- * @returns {Uint32Array} Decoded and decompress data
- */
-export function decompress(data, format) {
-    if (typeof utils.inflateb64 === "function") {
-        return utils.inflateb64(data, format);
-    } else {
-        throw new Error("GZIP/ZLIB compressed TMX Tile Map not supported!");
-    }
-}
-
-/**
- * Decode a CSV encoded array into a binary array
- * @ignore
- * @name decodeCSV
- * @param  {string} input- -  CSV formatted data (only numbers, everything else will be converted to NaN)
- * @returns {number[]} Decoded data
- */
-export function decodeCSV(input) {
-    let entries = input.replace("\n", "").trim().split(",");
-
-    let result = [];
-    for (let i = 0; i < entries.length; i++) {
-        result.push(+entries[i]);
-    }
-    return result;
-}
-
-/**
- * Decode a base64 encoded string into a byte array
- * @ignore
- * @name decodeBase64AsArray
- * @param {string} input - Base64 encoded data
- * @param {number} [bytes] - number of bytes per array entry
- * @returns {Uint32Array} Decoded data
- */
-export function decodeBase64AsArray(input, bytes) {
-    bytes = bytes || 1;
-
-    let i, j, len;
-    let dec = globalThis.atob(input.replace(/[^A-Za-z0-9\+\/\=]/g, ""));
-    let ar = new Uint32Array(dec.length / bytes);
-
-    for (i = 0, len = dec.length / bytes; i < len; i++) {
-        ar[i] = 0;
-        for (j = bytes - 1; j >= 0; --j) {
-            ar[i] += dec.charCodeAt((i * bytes) + j) << (j << 3);
-        }
-    }
-    return ar;
-}
-
-/**
- * Decode the given data
- * @ignore
- */
-export function decode(data, encoding, compression) {
-    compression = compression || "none";
-    encoding = encoding || "none";
-
-    switch (encoding) {
-        case "csv":
-            return decodeCSV(data);
-
-        case "base64":
-            if (compression !== "none") {
-                data = decompress(data, compression);
-            } else {
-                data = decodeBase64AsArray(data, 4);
-            }
-            return data;
-
-        case "none":
-            return data;
-
-        case "xml":
-            throw new Error("XML encoding is deprecated, use base64 instead");
-
-        default:
-            throw new Error("Unknown layer encoding: " + encoding);
-    }
-}
-
 /**
  * Normalize TMX format to Tiled JSON format
  * @ignore
  */
-export function normalize(obj, item) {
+function normalize(obj, item) {
     let nodeName = item.nodeName;
 
     switch (nodeName) {
@@ -315,9 +239,113 @@ export function normalize(obj, item) {
     }
 }
 
+
+/**
+ * decompress and decode zlib/gzip data
+ * @name decompress
+ * @memberOf TMXUtils
+ * @param {string} input - Base64 encoded and compressed data
+ * @param {string} format - compressed data format ("gzip","zlib", "zstd")
+ * @returns {Uint32Array} Decoded and decompress data
+ */
+function decompress(data, format) {
+    if (typeof inflateFunction === "function") {
+        return inflateFunction(data, format);
+    } else {
+        throw new Error("GZIP/ZLIB compressed TMX Tile Map not supported!");
+    }
+}
+
+/**
+ * Decode a CSV encoded array into a binary array
+ * @name decodeCSV
+ * @memberOf TMXUtils
+ * @param  {string} input- -  CSV formatted data (only numbers, everything else will be converted to NaN)
+ * @returns {number[]} Decoded data
+ */
+function decodeCSV(input) {
+    let entries = input.replace("\n", "").trim().split(",");
+
+    let result = [];
+    for (let i = 0; i < entries.length; i++) {
+        result.push(+entries[i]);
+    }
+    return result;
+}
+
+/**
+ * Decode a base64 encoded string into a byte array
+ * @name decodeBase64AsArray
+ * @memberOf TMXUtils
+ * @param {string} input - Base64 encoded data
+ * @param {number} [bytes] - number of bytes per array entry
+ * @returns {Uint32Array} Decoded data
+ */
+function decodeBase64AsArray(input, bytes) {
+    bytes = bytes || 1;
+
+    let i, j, len;
+    let dec = globalThis.atob(input.replace(/[^A-Za-z0-9\+\/\=]/g, ""));
+    let ar = new Uint32Array(dec.length / bytes);
+
+    for (i = 0, len = dec.length / bytes; i < len; i++) {
+        ar[i] = 0;
+        for (j = bytes - 1; j >= 0; --j) {
+            ar[i] += dec.charCodeAt((i * bytes) + j) << (j << 3);
+        }
+    }
+    return ar;
+}
+
+/**
+ * set the function used to inflate gzip/zlib data
+ * @param {Func} fn - inflate function
+ */
+export function setInflateFunction(fn) {
+    inflateFunction = fn;
+}
+
+/**
+ * Decode a encoded array into a binary array
+ * @name decodeCSV
+ * @memberOf TMXUtils
+ * @param {string} data - data to be decoded
+ * @param {string} [encoding="none"] - data encoding ("csv", "base64", "xml")
+ * @returns {number[]} Decoded data
+ */
+export function decode(data, encoding, compression) {
+    compression = compression || "none";
+    encoding = encoding || "none";
+
+    switch (encoding) {
+        case "csv":
+            return decodeCSV(data);
+
+        case "base64":
+            if (compression !== "none") {
+                data = decompress(data, compression);
+            } else {
+                data = decodeBase64AsArray(data, 4);
+            }
+            return data;
+
+        case "none":
+            return data;
+
+        case "xml":
+            throw new Error("XML encoding is deprecated, use base64 instead");
+
+        default:
+            throw new Error("Unknown layer encoding: " + encoding);
+    }
+}
+
 /**
  * Parse a XML TMX object and returns the corresponding javascript object
- * @ignore
+ * @name parse
+ * @memberOf TMXUtils
+ * @param {Document} xml - XML TMX object
+ * @returns {object} Javascript object
  */
 export function parse(xml) {
     // Create the return object
@@ -355,7 +383,11 @@ export function parse(xml) {
 
 /**
  * Apply TMX Properties to the given object
- * @ignore
+ * @name applyTMXProperties
+ * @memberOf TMXUtils
+ * @param {object} obj - object to apply the properties to
+ * @param {object} data - TMX data object
+ * @returns {object} obj
  */
 export function applyTMXProperties(obj, data) {
     let properties = data.properties;