melonjs 17.3.0 → 18.0.0

package/src/lang/console.js

@@ -1,36 +0,0 @@
-
-/**
- * display a deprecation warning in the console
- * @param {string} deprecated - deprecated class,function or property name
- * @param {string} replacement - the replacement class, function, or property name
- * @param {string} version - the version since when the lass,function or property is deprecated
- */
-export function warning(deprecated, replacement, version) {
-    const msg = "melonJS: %s is deprecated since version %s, please use %s";
-    let stack = new Error().stack;
-
-    if (console.groupCollapsed) {
-        console.groupCollapsed(
-            "%c" + msg,
-            "font-weight:normal;color:yellow;",
-            deprecated,
-            version,
-            replacement
-        );
-    } else {
-        console.warn(
-            msg,
-            deprecated,
-            version,
-            replacement
-        );
-    }
-
-    if (typeof stack !== "undefined") {
-        console.warn(stack);
-    }
-
-    if (console.groupCollapsed) {
-        console.groupEnd();
-    }
-}

package/src/lang/deprecated.js

@@ -1,192 +0,0 @@
-import { TextureAtlas } from "./../video/texture/atlas.js";
-import Renderer from "./../video/renderer.js";
-import { Draggable } from "./../renderable/draggable.js";
-import { DropTarget } from "./../renderable/dragndrop.js";
-import UISpriteElement from "./../renderable/ui/uispriteelement.js";
-import { warning } from "./console.js";
-import CanvasRenderTarget from "../video/rendertarget/canvasrendertarget.js";
-import CanvasRenderer from "../video/canvas/canvas_renderer.js";
-import WebGLRenderer from "../video/webgl/webgl_renderer.js";
-
-/*
- * placeholder for all deprecated classes and corresponding alias for backward compatibility
- */
-
-/**
- * Alias of {@link TextureAtlas}
- * @public
- * @name Texture
- * @class
- * @memberof Renderer#
- * @deprecated since 10.4.0
- * @see TextureAtlas
- */
-Object.defineProperty(Renderer.prototype, "Texture", {
-    /**
-     * @ignore
-     */
-    get : function () {
-        warning("me.video.renderer.Texture", "me.TextureAtlas", "10.4.0");
-        return TextureAtlas;
-    }
-});
-
-/**
- * @classdesc
- * Used to make a game entity draggable
- * @augments Entity
- * @deprecated since 10.5.0
- * @see Draggable
- */
-export class DraggableEntity extends Draggable {
-    /**
-     * @param {number} x - the x coordinates of the draggable object
-     * @param {number} y - the y coordinates of the draggable object
-     * @param {object} settings - Entity properties (see {@link Entity})
-     */
-    constructor(x, y, settings) {
-        warning("DraggableEntity", "Draggable", "10.5.0");
-        super(x, y, settings.width, settings.height);
-    }
-}
-
-/**
- * @classdesc
- * Used to make a game entity a droptarget
- * @augments Entity
- * @deprecated since 10.5.0
- * @see DropTarget
- */
-export class DroptargetEntity extends DropTarget {
-    /**
-     * @param {number} x - the x coordinates of the draggable object
-     * @param {number} y - the y coordinates of the draggable object
-     * @param {object} settings - Entity properties (see {@link Entity})
-     */
-    constructor(x, y, settings) {
-        warning("DroptargetEntity", "DropTarget", "10.5.0");
-        super(x, y, settings.width, settings.height);
-    }
-}
-
-/**
- * return a reference to the screen canvas
- * @name getScreenCanvas
- * @memberof Renderer
- * @returns {HTMLCanvasElement}
- * @deprecated since 13.1.0
- * @see getCanvas();
- */
-Renderer.prototype.getScreenCanvas = function() {
-    warning("getScreenCanvas", "getCanvas", "13.1.0");
-    return this.getCanvas();
-};
-
-/**
- * return a reference to the screen canvas corresponding 2d Context<br>
- * (will return buffered context if double buffering is enabled, or a reference to the Screen Context)
- * @name getScreenContext
- * @memberof Renderer
- * @returns {CanvasRenderingContext2D}
- * @deprecated since 13.1.0
- * @see getContext();
- */
-Renderer.prototype.getScreenContext = function()  {
-    warning("getScreenContext", "getContext", "13.1.0");
-    return this.getContext();
-};
-
-/**
- * @classdesc
- * A very basic object to manage GUI elements
- * @augments Sprite
- * @deprecated since 14.0.0
- * @see UISpriteElement
- */
-export class GUI_Object extends UISpriteElement {
-    /**
-     * @param {number} x - the x coordinate of the GUI Object
-     * @param {number} y - the y coordinate of the GUI Object
-     * @param {object} settings - See {@link Sprite}
-     */
-    constructor(x, y, settings) {
-        warning("GUI_Object", "UISpriteElement or UITextButton", "14.0.0");
-        super(x, y, settings);
-    }
-}
-
-
-/**
- * return the width of the system Canvas
- * @public
- * @name getWidth
- * @class
- * @memberof Renderer#
- * @deprecated since 15.12.0
- * @see width
- */
-Renderer.prototype.getWidth = function()  {
-    warning("getWidth", "width", "15.12.0");
-    return this.width;
-};
-
-/**
- * return the height of the system Canvas
- * @public
- * @name getHeight
- * @memberof Renderer#
- * @deprecated since 15.12.0
- * @see height
- */
-Renderer.prototype.getHeight = function()  {
-    warning("getHeight", "height", "15.12.0");
-    return this.height;
-};
-
-/**
- * @classdesc
- * @deprecated since 17.1.0
- * @see CanvasRenderTarget
- */
-export class CanvasTexture extends CanvasRenderTarget {
-    /**
-     * @param {number} width - the desired width of the canvas
-     * @param {number} height - the desired height of the canvas
-     * @param {object} attributes - The attributes to create both the canvas and context
-     * @param {boolean} [attributes.context="2d"] - the context type to be created ("2d", "webgl", "webgl2")
-     * @param {boolean} [attributes.offscreenCanvas=false] - will create an offscreenCanvas if true instead of a standard canvas
-     * @param {boolean} [attributes.willReadFrequently=false] - Indicates whether or not a lot of read-back operations are planned
-     * @param {boolean} [attributes.antiAlias=false] - Whether to enable anti-aliasing, use false (default) for a pixelated effect.
-     */
-    constructor(width, height, attributes) {
-        warning("CanvasTexture", "CanvasRenderTarget", "17.1.0");
-        super(width, height, attributes);
-    }
-}
-
-/**
- * return the height of the system Canvas
- * @public
- * @name setLineWidth
- * @memberof CanvasRenderer#
- * @deprecated since 17.3.0
- * @see lineWidth
- */
-CanvasRenderer.prototype.setLineWidth = function(width)  {
-    warning("setLineWidth", "lineWidth", "17.3.0");
-    this.lineWidth = width;
-};
-
-/**
- * return the height of the system Canvas
- * @public
- * @name setLineWidth
- * @memberof WebGLRenderer#
- * @deprecated since 17.3.0
- * @see lineWidth
- */
-WebGLRenderer.prototype.setLineWidth = function(width)  {
-    warning("setLineWidth", "lineWidth", "17.3.0");
-    this.lineWidth = width;
-};
-

package/src/level/level.js

@@ -1,290 +0,0 @@
-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";
-import { game } from "../index.js";
-import TMXTileMap from "./tiled/TMXTileMap.js";
-
-
-// our levels
-let levels = {};
-// level index table
-let levelIdx = [];
-// current level index
-let currentLevelIdx = 0;
-
-/**
- * @ignore
- */
-function safeLoadLevel(levelId, options, restart) {
-    // clean the destination container
-    options.container.reset();
-
-    // reset the renderer
-    game.reset();
-
-    // clean the current (previous) level
-    if (levels[level.getCurrentLevelId()]) {
-        levels[level.getCurrentLevelId()].destroy();
-    }
-
-    // update current level index
-    currentLevelIdx = levelIdx.indexOf(levelId);
-
-    // add the specified level to the game world
-    loadTMXLevel(levelId, options.container, options.flatten, options.setViewportBounds);
-
-    // publish the corresponding message
-    event.emit(event.LEVEL_LOADED, levelId);
-
-    // fire the callback
-    options.onLoaded(levelId);
-
-    if (restart) {
-        // resume the game loop if it was previously running
-        state.restart();
-    }
-}
-
-/**
- * Load a TMX level
- * @name loadTMXLevel
- * @memberof level
- * @private
- * @param {string} levelId - level id
- * @param {Container} container - target container
- * @param {boolean} [flatten=true] - if true, flatten all objects into the given container
- * @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.
- * @ignore
- */
-function loadTMXLevel(levelId, container, flatten, setViewportBounds) {
-    let level = levels[levelId];
-
-    // reset the GUID generator
-    // and pass the level id as parameter
-    resetGUID(levelId, level.nextobjectid);
-
-    // Tiled use 0,0 anchor coordinates
-    container.anchorPoint.set(0, 0);
-
-    // add all level elements to the target container
-    level.addTo(container, flatten, setViewportBounds);
-}
-
-
-/**
- * a level manager. once ressources loaded, the level manager contains all references of defined levels.
- * @namespace level
- */
-
-let level = {
-
-    /**
-     * add a level into the game manager (usually called by the preloader)
-     * @name add
-     * @memberof level
-     * @public
-     * @param {string} format - level format (only "tmx" supported)
-     * @param {string} levelId - the level id (or name)
-     * @param {Function} [callback] - a function to be called once the level is loaded
-     * @returns {boolean} true if the level was loaded
-     */
-    add(format, levelId, callback) {
-        switch (format) {
-            case "tmx" :
-                // just load the level with the XML stuff
-                if (levels[levelId] == null) {
-                    //console.log("loading "+ levelId);
-                    levels[levelId] = new TMXTileMap(levelId, getTMX(levelId));
-                    // level index
-                    levelIdx.push(levelId);
-                }
-                else {
-                    //console.log("level %s already loaded", levelId);
-                    return false;
-                }
-
-                // call the callback if defined
-                if (callback) {
-                    callback();
-                }
-                // true if level loaded
-                return true;
-
-            default :
-                throw new Error("no level loader defined for format " + format);
-        }
-    },
-
-    /**
-     * load a level into the game manager<br>
-     * (will also create all level defined entities, etc..)
-     * @name load
-     * @memberof level
-     * @public
-     * @param {string} levelId - level id
-     * @param {object} [options] - additional optional parameters
-     * @param {Container} [options.container=game.world] - container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
-     * @param {boolean} [options.setViewportBounds=true] - if true, set the viewport bounds to the map size
-     * @returns {boolean} true if the level was successfully loaded
-     * @example
-     * // the game assets to be be preloaded
-     * // TMX maps
-     * let resources = [
-     *     {name: "a4_level1",   type: "tmx",   src: "data/level/a4_level1.tmx"},
-     *     {name: "a4_level2",   type: "tmx",   src: "data/level/a4_level2.tmx"},
-     *     {name: "a4_level3",   type: "tmx",   src: "data/level/a4_level3.tmx"},
-     *     // ...
-     * ];
-     *
-     * // ...
-     *
-     * // load a level into the game world
-     * me.level.load("a4_level1");
-     * ...
-     * ...
-     * // load a level into a specific container
-     * let levelContainer = new me.Container();
-     * me.level.load("a4_level2", {container:levelContainer});
-     * // add a simple transformation
-     * levelContainer.currentTransform.translate(levelContainer.width / 2, levelContainer.height / 2 );
-     * levelContainer.currentTransform.rotate(0.05);
-     * levelContainer.currentTransform.translate(-levelContainer.width / 2, -levelContainer.height / 2 );
-     * // add it to the game world
-     * me.game.world.addChild(levelContainer);
-     */
-    load(levelId, options) {
-        options = Object.assign({
-            "container"         : game.world,
-            "onLoaded"          : game.onLevelLoaded,
-            "flatten"           : game.mergeGroup,
-            "setViewportBounds" : true
-        }, options || {});
-
-        // throw an exception if not existing
-        if (typeof(levels[levelId]) === "undefined") {
-            throw new Error("level " + levelId + " not found");
-        }
-
-        if (levels[levelId] instanceof TMXTileMap) {
-
-            // check the status of the state mngr
-            let wasRunning = state.isRunning();
-
-            if (wasRunning) {
-                // stop the game loop to avoid
-                // some silly side effects
-                state.stop();
-
-                defer(safeLoadLevel, this, levelId, options, true);
-            }
-            else {
-                safeLoadLevel(levelId, options);
-            }
-        }
-        else {
-            throw new Error("no level loader defined");
-        }
-        return true;
-    },
-
-    /**
-     * return the current level id<br>
-     * @name getCurrentLevelId
-     * @memberof level
-     * @public
-     * @returns {string}
-     */
-    getCurrentLevelId() {
-        return levelIdx[currentLevelIdx];
-    },
-
-    /**
-     * return the current level definition.
-     * for a reference to the live instantiated level,
-     * rather use the container in which it was loaded (e.g. me.game.world)
-     * @name getCurrentLevel
-     * @memberof level
-     * @public
-     * @returns {TMXTileMap}
-     */
-    getCurrentLevel() {
-        return levels[this.getCurrentLevelId()];
-    },
-
-    /**
-     * reload the current level
-     * @name reload
-     * @memberof level
-     * @public
-     * @param {object} [options] - additional optional parameters
-     * @param {Container} [options.container=game.world] - container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
-     * @returns {object} the current level
-     */
-    reload(options) {
-        // reset the level to initial state
-        //levels[currentLevel].reset();
-        return this.load(this.getCurrentLevelId(), options);
-    },
-
-    /**
-     * load the next level
-     * @name next
-     * @memberof level
-     * @public
-     * @param {object} [options] - additional optional parameters
-     * @param {Container} [options.container=game.world] - container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
-     * @returns {boolean} true if the next level was successfully loaded
-     */
-    next(options) {
-        //go to the next level
-        if (currentLevelIdx + 1 < levelIdx.length) {
-            return this.load(levelIdx[currentLevelIdx + 1], options);
-        }
-        else {
-            return false;
-        }
-    },
-
-    /**
-     * load the previous level<br>
-     * @name previous
-     * @memberof level
-     * @public
-     * @param {object} [options] - additional optional parameters
-     * @param {Container} [options.container=game.world] - container in which to load the specified level
-     * @param {Function} [options.onLoaded=game.onLevelLoaded] - callback for when the level is fully loaded
-     * @param {boolean} [options.flatten=game.mergeGroup] - if true, flatten all objects into the given container
-     * @returns {boolean} true if the previous level was successfully loaded
-     */
-    previous(options) {
-        // go to previous level
-        if (currentLevelIdx - 1 >= 0) {
-            return this.load(levelIdx[currentLevelIdx - 1], options);
-        }
-        else {
-            return false;
-        }
-    },
-
-    /**
-     * return the amount of level preloaded
-     * @name levelCount
-     * @memberof level
-     * @public
-     * @returns {number} the amount of level preloaded
-     */
-    levelCount() {
-        return levelIdx.length;
-    }
-
-};
-
-export default level;

package/src/level/tiled/TMXGroup.js

@@ -1,111 +0,0 @@
-import { applyTMXProperties } from "./TMXUtils.js";
-import TMXObject from "./TMXObject.js";
-import TMXLayer from "./TMXLayer.js";
-import { clamp } from "./../../math/math.js";
-
-/**
- * @classdesc
- * object group definition as defined in Tiled.
- * (group definition is translated into the virtual `me.game.world` using `me.Container`)
- * @ignore
- */
-export default class TMXGroup {
-
-    constructor(map, data, z) {
-
-        /**
-         * group name
-         * @type {string}
-         */
-        this.name = data.name;
-
-        /**
-         * group width
-         * @type {number}
-         */
-        this.width = data.width || 0;
-
-        /**
-         * group height
-         * @type {number}
-         */
-        this.height = data.height || 0;
-
-        /**
-         * tint color
-         * @type {string}
-         */
-        this.tintcolor = data.tintcolor;
-
-
-        /**
-         * the group class
-         * @type {string}
-         */
-        this.class = data.class;
-
-        /**
-         * group z order
-         * @type {number}
-         */
-        this.z = z;
-
-        /**
-         * group objects list definition
-         * @see TMXObject
-         * @type {object[]}
-         */
-        this.objects = [];
-
-        let visible = typeof(data.visible) !== "undefined" ? data.visible : true;
-        this.opacity = (visible === true) ? clamp(+data.opacity || 1.0, 0.0, 1.0) : 0;
-
-        // check if we have any user-defined properties
-        applyTMXProperties(this, data);
-
-        // parse all child objects/layers
-        if (data.objects) {
-            data.objects.forEach((object) => {
-                object.tintcolor = this.tintcolor;
-                this.objects.push(new TMXObject(map, object, z));
-            });
-        }
-
-        if (data.layers) {
-            data.layers.forEach((data) => {
-                let layer = new TMXLayer(map, data, map.tilewidth, map.tileheight, map.orientation, map.tilesets, z++);
-                // set a renderer
-                layer.setRenderer(map.getRenderer());
-                // resize container accordingly
-                this.width = Math.max(this.width, layer.width);
-                this.height = Math.max(this.height, layer.height);
-                this.objects.push(layer);
-            });
-        }
-    }
-
-    /**
-     * reset function
-     * @ignore
-     */
-    destroy() {
-        // clear all allocated objects
-        this.objects = null;
-    }
-
-    /**
-     * return the object count
-     * @ignore
-     */
-    getObjectCount() {
-        return this.objects.length;
-    }
-
-    /**
-     * returns the object at the specified index
-     * @ignore
-     */
-    getObjectByIndex(idx) {
-        return this.objects[idx];
-    }
-}