melonjs 17.4.0 → 18.0.0

package/src/renderable/trigger.js

@@ -1,154 +0,0 @@
-import Renderable from "./renderable.js";
-import collision from "./../physics/collision.js";
-import Body from "./../physics/body.js";
-import level from "./../level/level.js";
-import pool from "./../system/pooling.js";
-
-/**
- * additional import for TypeScript
- * @import ResponseObject from "./../physics/response.js";
- */
-
-/**
- * @classdesc
- * trigger an event when colliding with another object
- * @augments Renderable
- */
-export default class Trigger extends Renderable {
-    /**
-     * @param {number} x - the x coordinates of the trigger area
-     * @param {number} y - the y coordinates of the trigger area
-     * @param {number} [settings.width] - width of the trigger area
-     * @param {number} [settings.height] - height of the trigger area
-     * @param {Rect[]|Polygon[]|Line[]|Ellipse[]} [settings.shapes] - collision shape(s) that will trigger the event
-     * @param {string} [settings.duration] - Fade duration (in ms)
-     * @param {string|Color} [settings.color] - Fade color
-     * @param {string} [settings.event="level"] - the type of event to trigger (only "level" supported for now)
-     * @param {string} [settings.to] - level to load if level trigger
-     * @param {string|Container} [settings.container] - Target container. See {@link level.load}
-     * @param {Function} [settings.onLoaded] - Level loaded callback. See {@link level.load}
-     * @param {boolean} [settings.flatten] - Flatten all objects into the target container. See {@link level.load}
-     * @param {boolean} [settings.setViewportBounds] - Resize the viewport to match the level. See {@link level.load}
-     * @example
-     * world.addChild(new me.Trigger(
-     *     x, y, {
-     *         shapes: [new me.Rect(0, 0, 100, 100)],
-     *         "duration" : 250,
-     *         "color" : "#000",
-     *         "to" : "mymap2"
-     *     }
-     * ));
-     */
-    constructor(x, y, settings) {
-        // call the parent constructor
-        super(x, y, settings.width || 0, settings.height || 0);
-
-        // for backward compatibility
-        this.anchorPoint.set(0, 0);
-
-        this.fade = settings.fade;
-        this.duration = settings.duration;
-        this.fading = false;
-
-        // Tiled Settings
-        this.name = "Trigger";
-        this.type = settings.type;
-        this.id = settings.id;
-
-        // a temp variable
-        this.gotolevel = settings.to;
-
-        // Collect the defined trigger settings
-        this.triggerSettings = {
-            // the default (and only for now) action
-            event: "level"
-        };
-
-        [ "type", "container", "onLoaded", "flatten", "setViewportBounds", "to" ].forEach((property) => {
-            if (typeof settings[property] !== "undefined") {
-                this.triggerSettings[property] = settings[property];
-            }
-        });
-
-        // add and configure the physic body
-        let shape = settings.shapes;
-        if (typeof shape === "undefined") {
-            shape = pool.pull("Polygon", 0, 0, [
-                pool.pull("Vector2d", 0,          0),
-                pool.pull("Vector2d", this.width, 0),
-                pool.pull("Vector2d", this.width, this.height)
-            ]);
-        }
-        this.body = new Body(this, shape);
-        this.body.collisionType = collision.types.ACTION_OBJECT;
-        // by default only collides with PLAYER_OBJECT
-        this.body.setCollisionMask(collision.types.PLAYER_OBJECT);
-        this.body.setStatic(true);
-        this.resize(this.body.getBounds().width, this.body.getBounds().height);
-    }
-
-    /**
-     * @ignore
-     */
-    getTriggerSettings() {
-        let world = this.ancestor.getRootAncestor();
-        // Lookup for the container instance
-        if (typeof(this.triggerSettings.container) === "string") {
-            this.triggerSettings.container = world.getChildByName(this.triggerSettings.container)[0];
-        }
-        return this.triggerSettings;
-    }
-
-    /**
-     * @ignore
-     */
-    onFadeComplete() {
-        let world = this.ancestor.getRootAncestor();
-        level.load(this.gotolevel, this.getTriggerSettings());
-        world.app.viewport.fadeOut(this.fade, this.duration);
-    }
-
-    /**
-     * trigger this event
-     * @name triggerEvent
-     * @memberof Trigger
-     * @protected
-     */
-    triggerEvent() {
-        let triggerSettings = this.getTriggerSettings();
-        let world = this.ancestor.getRootAncestor();
-
-        if (triggerSettings.event === "level") {
-            this.gotolevel = triggerSettings.to;
-            // load a level
-            //console.log("going to : ", to);
-            if (this.fade && this.duration) {
-                if (!this.fading) {
-                    this.fading = true;
-                    world.app.viewport.fadeIn(this.fade, this.duration,
-                        () => this.onFadeComplete());
-                }
-            } else {
-                level.load(this.gotolevel, triggerSettings);
-            }
-        } else {
-            throw new Error("Trigger invalid type");
-        }
-    }
-
-    /**
-     * onCollision callback, triggered in case of collision with this trigger
-     * @name onCollision
-     * @memberof Trigger
-     * @param {ResponseObject} response - the collision response object
-     * @param {Renderable} other - the other renderable touching this one (a reference to response.a or response.b)
-     * @returns {boolean} true if the object should respond to the collision (its position and velocity will be corrected)
-     */
-    onCollision(response, other) { // eslint-disable-line no-unused-vars
-        if (this.name === "Trigger") {
-            this.triggerEvent.apply(this);
-        }
-        return false;
-    }
-
-}

package/src/renderable/ui/uibaseelement.js

@@ -1,276 +0,0 @@
-import Container from "../container.js";
-import timer from "../../system/timer.js";
-import { on, off, POINTERMOVE } from "../../system/event.js";
-import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js";
-import pool from "../../system/pooling.js";
-
-/**
- * @classdesc
- * This is a basic clickable and draggable container which you can use in your game UI.
- * Use this for example if you want to display a panel that contains text, images or other UI elements.
- * @augments Container
- */
-export default class UIBaseElement extends Container {
-    /**
-     *
-     * @param {number} x - The x position of the container
-     * @param {number} y - The y position of the container
-     * @param {number} w - width of the container
-     * @param {number} h - height of the container
-     */
-    constructor(x, y, w, h) {
-        super(x, y, w, h);
-        /**
-         * object can be clicked or not
-         * @type {boolean}
-         * @default true
-         */
-        this.isClickable = true;
-
-        /**
-         * object can be clicked or not
-         * @type {boolean}
-         * @default false
-         */
-        this.isDraggable = false;
-
-        /**
-         * Tap and hold threshold timeout in ms
-         * @type {number}
-         * @default 250
-         */
-        this.holdThreshold = 250;
-
-        /**
-         * object can be tap and hold
-         * @type {boolean}
-         * @default false
-         */
-        this.isHoldable = false;
-
-        /**
-         * true if the pointer is over the object
-         * @type {boolean}
-         * @default false
-         */
-        this.hover = false;
-
-        /**
-         * false if the pointer is down, or true when the pointer status is up
-         * @type {boolean}
-         * @default false
-         */
-        this.released = true;
-
-        /**
-         * UI base elements use screen coordinates by default
-         * (Note: any child elements added to a UIBaseElement should have their floating property to false)
-         * @see Renderable.floating
-         * @type {boolean}
-         * @default true
-         */
-        this.floating = true;
-
-        // object has been updated (clicked,etc..)
-        this.holdTimeout = -1;
-
-        // enable event detection
-        this.isKinematic = false;
-
-        // update container and children bounds automatically
-        this.enableChildBoundsUpdate = true;
-    }
-
-    /**
-     * function callback for the pointerdown event
-     * @ignore
-     */
-    clicked(event) {
-        // Check if left mouse button is pressed
-        if (event.button === 0 && this.isClickable) {
-            this.isDirty = true;
-            this.released = false;
-            if (this.isHoldable) {
-                timer.clearTimeout(this.holdTimeout);
-                this.holdTimeout = timer.setTimeout(
-                    () => this.hold(),
-                    this.holdThreshold,
-                    false
-                );
-                this.released = false;
-            }
-            if (this.isDraggable) {
-                this.grabOffset.set(event.gameX, event.gameY);
-                this.grabOffset.sub(this.pos);
-            }
-            return this.onClick(event);
-        }
-    }
-
-    /**
-     * function called when the object is pressed (to be extended)
-     * @param {Pointer} event - the event object
-     * @returns {boolean} return false if we need to stop propagating the event
-     */
-    onClick(event) { // eslint-disable-line no-unused-vars
-        return true;
-    }
-
-    /**
-     * function callback for the pointerEnter event
-     * @ignore
-     */
-    enter(event) {
-        this.hover = true;
-        this.isDirty = true;
-        if (this.isDraggable === true) {
-            on(POINTERMOVE, this.pointerMove, this);
-            // to memorize where we grab the object
-            this.grabOffset = pool.pull("Vector2d", 0, 0);
-        }
-        return this.onOver(event);
-    }
-
-    /**
-     * pointermove function
-     * @ignore
-     */
-    pointerMove(event) {
-        if (this.hover === true && this.released === false) {
-            // follow the pointer
-            this.pos.set(event.gameX, event.gameY, this.pos.z);
-            this.pos.sub(this.grabOffset);
-            // mark the container for redraw
-            this.isDirty = true;
-            return this.onMove(event);
-        }
-    }
-
-    /**
-     * function called when the pointer is moved over the object
-     * @param {Pointer} event - the event object
-     */
-    onMove(event) { // eslint-disable-line no-unused-vars
-        // to be extended
-    }
-
-    /**
-     * function called when the pointer is over the object
-     * @param {Pointer} event - the event object
-     */
-    onOver(event) { // eslint-disable-line no-unused-vars
-        // to be extended
-    }
-
-    /**
-     * function callback for the pointerLeave event
-     * @ignore
-     */
-    leave(event) {
-        this.hover = false;
-        this.isDirty = true;
-        if (this.isDraggable === true) {
-            // unregister on the global pointermove event
-            off(POINTERMOVE, this.pointerMove);
-            pool.push(this.grabOffset);
-            this.grabOffset = undefined;
-        }
-        this.release(event);
-        return this.onOut(event);
-    }
-
-    /**
-     * function called when the pointer is leaving the object area
-     * @param {Pointer} event - the event object
-     */
-    onOut(event) { // eslint-disable-line no-unused-vars
-        // to be extended
-    }
-
-    /**
-     * function callback for the pointerup event
-     * @ignore
-     */
-    release(event) {
-        if (this.released === false) {
-            this.released = true;
-            this.isDirty = true;
-            timer.clearTimeout(this.holdTimeout);
-            this.holdTimeout = -1;
-            return this.onRelease(event);
-        }
-    }
-
-    /**
-     * function called when the object is pressed and released (to be extended)
-     * @returns {boolean} return false if we need to stop propagating the event
-     */
-    onRelease() {
-        return true;
-    }
-
-    /**
-     * function callback for the tap and hold timer event
-     * @ignore
-     */
-    hold() {
-        timer.clearTimeout(this.holdTimeout);
-        this.holdTimeout = -1;
-        this.isDirty = true;
-        if (!this.released) {
-            this.onHold();
-        }
-    }
-
-    /**
-     * function called when the object is pressed and held<br>
-     * to be extended <br>
-     */
-    onHold() {}
-
-    /**
-     * function called when added to the game world or a container
-     * @ignore
-     */
-    onActivateEvent() {
-        // register pointer events
-        registerPointerEvent("pointerdown", this, (e) => this.clicked(e));
-        registerPointerEvent("pointerup", this, (e) => this.release(e));
-        registerPointerEvent("pointercancel", this, (e) => this.release(e));
-        registerPointerEvent("pointerenter", this, (e) => this.enter(e));
-        registerPointerEvent("pointerleave", this, (e) => this.leave(e));
-
-        // call the parent function
-        super.onActivateEvent();
-    }
-
-    /**
-     * function called when removed from the game world or a container
-     * @ignore
-     */
-    onDeactivateEvent() {
-        // release pointer events
-        releasePointerEvent("pointerdown", this);
-        releasePointerEvent("pointerup", this);
-        releasePointerEvent("pointercancel", this);
-        releasePointerEvent("pointerenter", this);
-        releasePointerEvent("pointerleave", this);
-        timer.clearTimeout(this.holdTimeout);
-        this.holdTimeout = -1;
-
-        // unregister on the global pointermove event
-        // note: this is just a precaution, in case
-        // the object is being remove from his parent
-        // container before the leave function is called
-        if (this.isDraggable === true) {
-            off(POINTERMOVE, this.pointerMove);
-            if (typeof this.grabOffset !== "undefined") {
-                pool.push(this.grabOffset);
-                this.grabOffset = undefined;
-            }
-        }
-
-        // call the parent function
-        super.onDeactivateEvent();
-    }
-}

package/src/renderable/ui/uispriteelement.js

@@ -1,223 +0,0 @@
-import timer from "./../../system/timer.js";
-import Sprite from "./../sprite.js";
-import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js";
-
-/**
- * @classdesc
- * This is a basic sprite based button which you can use in your Game UI.
- * @augments Sprite
- */
-export default class UISpriteElement extends Sprite {
-    /**
-     * @param {number} x - the x coordinate of the UISpriteElement Object
-     * @param {number} y - the y coordinate of the UISpriteElement Object
-     * @param {object} settings - See {@link Sprite}
-     * @example
-     * // create a basic GUI Object
-     * class myButton extends UISpriteElement {
-     *    constructor(x, y) {
-     *       // call the UISpriteElement parent constructor
-     *       super(x, y, {
-     *          image: "button",
-     *          framewidth: 100,
-     *          frameheight: 50
-     *       });
-     *    }
-     *
-     *    // output something in the console
-     *    // when the object is clicked
-     *    onClick(event) {
-     *       console.log("clicked!");
-     *       // don't propagate the event
-     *       return false;
-     *    }
-     * });
-     *
-     * // add the object at pos (10,10)
-     * world.addChild(new myButton(10,10));
-     */
-    constructor(x, y, settings) {
-
-        // call the parent constructor
-        super(x, y, settings);
-
-        /**
-         * object can be clicked or not
-         * @type {boolean}
-         * @default true
-         */
-        this.isClickable = true;
-
-        /**
-         * Tap and hold threshold timeout in ms
-         * @type {number}
-         * @default 250
-         */
-        this.holdThreshold = 250;
-
-        /**
-         * object can be tap and hold
-         * @type {boolean}
-         * @default false
-         */
-        this.isHoldable = false;
-
-        /**
-         * true if the pointer is over the object
-         * @type {boolean}
-         * @default false
-         */
-        this.hover = false;
-
-        // object has been updated (clicked,etc..)
-        this.holdTimeout = -1;
-        this.released = true;
-
-        /**
-         * if this UISpriteElement should use screen coordinates or local coordinates
-         * (Note: any UISpriteElement elements added to a floating parent container should have their floating property to false)
-         * @see Renderable.floating
-         * @type {boolean}
-         * @default true
-         */
-        this.floating = true;
-
-        // enable event detection
-        this.isKinematic = false;
-    }
-
-    /**
-     * function callback for the pointerdown event
-     * @ignore
-     */
-    clicked(event) {
-        // Check if left mouse button is pressed
-        if (event.button === 0 && this.isClickable) {
-            this.isDirty = true;
-            this.released = false;
-            if (this.isHoldable) {
-                timer.clearTimeout(this.holdTimeout);
-                this.holdTimeout = timer.setTimeout(() => this.hold(), this.holdThreshold, false);
-                this.released = false;
-            }
-            return this.onClick(event);
-        }
-    }
-
-    /**
-     * function called when the object is pressed (to be extended)
-     * @param {Pointer} event - the event object
-     * @returns {boolean} return false if we need to stop propagating the event
-     */
-    onClick(event) { // eslint-disable-line no-unused-vars
-        return false;
-    }
-
-    /**
-     * function callback for the pointerEnter event
-     * @ignore
-     */
-    enter(event) {
-        this.hover = true;
-        this.isDirty = true;
-        return this.onOver(event);
-    }
-
-    /**
-     * function called when the pointer is over the object
-     * @param {Pointer} event - the event object
-     */
-    onOver(event) { // eslint-disable-line no-unused-vars
-        // to be extended
-    }
-
-    /**
-     * function callback for the pointerLeave event
-     * @ignore
-     */
-    leave(event) {
-        this.hover = false;
-        this.isDirty = true;
-        this.release(event);
-        return this.onOut(event);
-    }
-
-    /**
-     * function called when the pointer is leaving the object area
-     * @param {Pointer} event - the event object
-     */
-    onOut(event) { // eslint-disable-line no-unused-vars
-        // to be extended
-    }
-
-    /**
-     * function callback for the pointerup event
-     * @ignore
-     */
-    release(event) {
-        if (this.released === false) {
-            this.released = true;
-            this.isDirty = true;
-            timer.clearTimeout(this.holdTimeout);
-            this.holdTimeout = -1;
-            return this.onRelease(event);
-        }
-    }
-
-    /**
-     * function called when the object is pressed and released (to be extended)
-     * @returns {boolean} return false if we need to stop propagating the event
-     */
-    onRelease() {
-        return false;
-    }
-
-    /**
-     * function callback for the tap and hold timer event
-     * @ignore
-     */
-    hold() {
-        timer.clearTimeout(this.holdTimeout);
-        this.holdTimeout = -1;
-        this.isDirty = true;
-        if (!this.released) {
-            this.onHold();
-        }
-    }
-
-    /**
-     * function called when the object is pressed and held<br>
-     * to be extended <br>
-     */
-    onHold() {
-    }
-
-    /**
-     * function called when added to the game world or a container
-     * @ignore
-     */
-    onActivateEvent() {
-        // register pointer events
-        registerPointerEvent("pointerdown", this, (e) => this.clicked(e));
-        registerPointerEvent("pointerup", this, (e) => this.release(e));
-        registerPointerEvent("pointercancel", this, (e) => this.release(e));
-        registerPointerEvent("pointerenter", this, (e) => this.enter(e));
-        registerPointerEvent("pointerleave", this, (e) => this.leave(e));
-    }
-
-    /**
-     * function called when removed from the game world or a container
-     * @ignore
-     */
-    onDeactivateEvent() {
-        // release pointer events
-        releasePointerEvent("pointerdown", this);
-        releasePointerEvent("pointerup", this);
-        releasePointerEvent("pointercancel", this);
-        releasePointerEvent("pointerenter", this);
-        releasePointerEvent("pointerleave", this);
-        timer.clearTimeout(this.holdTimeout);
-        this.holdTimeout = -1;
-    }
-}
-