Merge branch 'master' of https://github.com/photonstorm/phaser

Author: photonstorm

CHANGELOG.md

@@ -18,6 +18,15 @@
 * `InputManager.onMouseWheel` is a new internal method that handles processing the wheel event.
 * `InputManager.processWheelEvent` is a new internal method that handles processing the wheel event sent by the Input Manager.
 
+#### Button Released Support
+
+* `Pointer.button` is a new property that indicates which button was pressed, or released, on the pointer during the most recent event. It is only set during `up` and `down` events and is always 0 for Touch inputs.
+* `Pointer.leftButtonReleased` is a new method that returns `true` if it was the left mouse button that was just released. This can be checked in a `pointerup` event handler to find out which button was released.
+* `Pointer.rightButtonReleased` is a new method that returns `true` if it was the right mouse button that was just released. This can be checked in a `pointerup` event handler to find out which button was released (thanks @BobtheUltimateProgrammer)
+* `Pointer.middleButtonReleased` is a new method that returns `true` if it was the middle mouse button that was just released. This can be checked in a `pointerup` event handler to find out which button was released.
+* `Pointer.backButtonReleased` is a new method that returns `true` if it was the back mouse button that was just released. This can be checked in a `pointerup` event handler to find out which button was released.
+* `Pointer.forwardButtonReleased` is a new method that returns `true` if it was the forward mouse button that was just released. This can be checked in a `pointerup` event handler to find out which button was released.
+
 #### Input System Bug Fixes
 
 * Calling `setPollAlways()` would cause the `'pointerdown'` event to fire multiple times. Fix #4541 (thanks @Neyromantik)
@@ -98,6 +107,7 @@ The following changes took place in the Pointer class:
 *`WebAudioSoundManager.decodeAudio` is a new method that allows you to decode audio data into a format ready for playback and stored in the audio cache. The audio data can be provided as an ArrayBuffer, a base64 string or a data uri. Listen for the events to know when the data is ready for use.
 * `Phaser.Sound.Events#DECODED` is a new event emitted by the Web Audio Sound Manager when it has finished decoding audio data.
 * `Phaser.Sound.Events#DECODED_ALL` is a new event emitted by the Web Audio Sound Manager when it has finished decoding all of the audio data files passed to the `decodeAudio` method.
+* `Phaser.Utils.Objects.Pick` is a new function that will take an object and an array of keys and return a new object containing just the keys provided in the array.
 
 ### Updates
 
@@ -125,6 +135,24 @@ The following changes took place in the Pointer class:
 * `LineStyleCanvas` now takes an `altColor` argument which is used to override the context color.
 * `LineStyleCanvas` now takes an `altAlpha` argument which is used to override the context alpha.
 * `FillStyleCanvas` now takes an `altAlpha` argument which is used to override the context alpha.
+* `StaticPhysicsGroup` can now take a `classType` property in its Group Config and will use the value of it, rather than override it. If none is provided it'll default to `ArcadeSprite`. Fix #4401 (thanks @Legomite)
+* `Phaser.Tilemaps.Parsers.Tiled` used to run the static function `ParseJSONTiled`. `Parsers.Tiled` is now just a namespace, so access the function within it: `Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled`.
+* `Phaser.Tilemaps.Parsers.Impact` used to run the static function `ParseWeltmeister`. `Parsers.Impact` is now just a namespace, so access the function within it: `Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister`.
+* `Phaser.Tilemaps.Parsers.Tiled.AssignTileProperties` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.Base64Decode` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.BuildTilesetIndex` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseGID` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseImageLayers` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseObject` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseObjectLayers` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseTileLayers` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseTilesets` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.ParseTilesets` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Impact.ParseTileLayers` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Impact.ParseTilesets` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Impact.ParseWeltmeister` is now a public static function, available to be called directly.
+* `Phaser.Tilemaps.Parsers.Tiled.Pick` has been removed. It is now available under `Phaser.Utils.Objects.Pick`, which is a more logical place for it.
 
 ### Bug Fixes
 
@@ -143,6 +171,7 @@ The following changes took place in the Pointer class:
 * The `Grid` Game Object wouldn't render in Canvas mode at all. Fix #4585 (thanks @fyyyyy)
 * If you had a `Graphics` object in the display list immediately after an object with a Bitmap Mask it would throw an error `Uncaught TypeError: Cannot set property 'TL' of undefined`. Fix #4581 (thanks @Petah @Loonride)
 * Calling Arcade Physics `Body.reset` on a Game Object that doesn't have any bounds, like a Container, would throw an error about being unable to access `getTopLeft`. If this is the case, it will now set the position to the given x/y values (thanks Jazz)
+* All of the `Tilemaps.Parsers.Tiled` static functions are now available to be called directly. Fix #4318 (thanks @jestarray)
 
 ### Examples, Documentation and TypeScript
 

src/input/Pointer.js

@@ -103,6 +103,24 @@ var Pointer = new Class({
          */
         this.camera = null;
 
+        /**
+         * A read-only property that indicates which button was pressed, or released, on the pointer
+         * during the most recent event. It is only set during `up` and `down` events.
+         * 
+         * On Touch devices the value is always 0.
+         * 
+         * Users may change the configuration of buttons on their pointing device so that if an event's button property
+         * is zero, it may not have been caused by the button that is physically left–most on the pointing device;
+         * however, it should behave as if the left button was clicked in the standard button layout.
+         *
+         * @name Phaser.Input.Pointer#button
+         * @type {integer}
+         * @readonly
+         * @default 0
+         * @since 3.18.0
+         */
+        this.button = 0;
+
         /**
          * 0: No button or un-initialized
          * 1: Left button
@@ -544,6 +562,8 @@ var Pointer = new Class({
 
         this.event = event;
 
+        this.button = event.button;
+
         this.upElement = event.target;
 
         //  Sets the local x/y properties
@@ -581,6 +601,8 @@ var Pointer = new Class({
 
         this.event = event;
 
+        this.button = event.button;
+
         this.downElement = event.target;
 
         //  Sets the local x/y properties
@@ -876,6 +898,71 @@ var Pointer = new Class({
         return (this.buttons & 16) ? true : false;
     },
 
+    /**
+     * Checks to see if the left button was just released on this Pointer.
+     *
+     * @method Phaser.Input.Pointer#leftButtonReleased
+     * @since 3.18.0
+     *
+     * @return {boolean} `true` if the left button was just released.
+     */
+    leftButtonReleased: function ()
+    {
+        return (this.button === 0 && !this.isDown);
+    },
+
+    /**
+     * Checks to see if the right button was just released on this Pointer.
+     *
+     * @method Phaser.Input.Pointer#rightButtonReleased
+     * @since 3.18.0
+     *
+     * @return {boolean} `true` if the right button was just released.
+     */
+    rightButtonReleased: function ()
+    {
+        return (this.button === 2 && !this.isDown);
+    },
+
+    /**
+     * Checks to see if the middle button was just released on this Pointer.
+     *
+     * @method Phaser.Input.Pointer#middleButtonReleased
+     * @since 3.18.0
+     *
+     * @return {boolean} `true` if the middle button was just released.
+     */
+    middleButtonReleased: function ()
+    {
+        return (this.button === 1 && !this.isDown);
+    },
+
+    /**
+     * Checks to see if the back button was just released on this Pointer.
+     *
+     * @method Phaser.Input.Pointer#backButtonReleased
+     * @since 3.18.0
+     *
+     * @return {boolean} `true` if the back button was just released.
+     */
+    backButtonReleased: function ()
+    {
+        return (this.button === 3 && !this.isDown);
+    },
+
+    /**
+     * Checks to see if the forward button was just released on this Pointer.
+     *
+     * @method Phaser.Input.Pointer#forwardButtonReleased
+     * @since 3.18.0
+     *
+     * @return {boolean} `true` if the forward button was just released.
+     */
+    forwardButtonReleased: function ()
+    {
+        return (this.button === 4 && !this.isDown);
+    },
+
     /**
      * If the Pointer has a button pressed down at the time this method is called, it will return the
      * distance between the Pointer's `downX` and `downY` values and the current position.

src/physics/arcade/StaticPhysicsGroup.js

@@ -7,6 +7,7 @@
 var ArcadeSprite = require('./ArcadeSprite');
 var Class = require('../../utils/Class');
 var CONST = require('./const');
+var GetFastValue = require('../../utils/object/GetFastValue');
 var Group = require('../../gameobjects/group/Group');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
@@ -55,7 +56,7 @@ var StaticPhysicsGroup = new Class({
             config.createCallback = this.createCallbackHandler;
             config.removeCallback = this.removeCallbackHandler;
             config.createMultipleCallback = this.createMultipleCallbackHandler;
-            config.classType = ArcadeSprite;
+            config.classType = GetFastValue(config, 'classType', ArcadeSprite);
         }
         else if (Array.isArray(children) && IsPlainObject(children[0]))
         {
@@ -68,7 +69,7 @@ var StaticPhysicsGroup = new Class({
                 singleConfig.createCallback = this.createCallbackHandler;
                 singleConfig.removeCallback = this.removeCallbackHandler;
                 singleConfig.createMultipleCallback = this.createMultipleCallbackHandler;
-                singleConfig.classType = ArcadeSprite;
+                singleConfig.classType = GetFastValue(singleConfig, 'classType', ArcadeSprite);
             });
         }
 

src/tilemaps/parsers/impact/ParseWeltmeister.js

@@ -9,10 +9,6 @@ var MapData = require('../../mapdata/MapData');
 var ParseTileLayers = require('./ParseTileLayers');
 var ParseTilesets = require('./ParseTilesets');
 
-/**
- * @namespace Phaser.Tilemaps.Parsers.Impact
- */
-
 /**
  * Parses a Weltmeister JSON object into a new MapData object.
  *

src/tilemaps/parsers/impact/index.js

@@ -0,0 +1,17 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Tilemaps.Parsers.Impact
+ */
+
+module.exports = {
+
+    ParseTileLayers: require('./ParseTileLayers'),
+    ParseTilesets: require('./ParseTilesets'),
+    ParseWeltmeister: require('./ParseWeltmeister')
+
+};

src/tilemaps/parsers/index.js

@@ -14,7 +14,7 @@ module.exports = {
     Parse2DArray: require('./Parse2DArray'),
     ParseCSV: require('./ParseCSV'),
 
-    Impact: require('./impact/ParseWeltmeister'),
-    Tiled: require('./tiled/ParseJSONTiled')
+    Impact: require('./impact/'),
+    Tiled: require('./tiled/')
 
 };

src/tilemaps/parsers/tiled/ParseJSONTiled.js

@@ -13,10 +13,6 @@ var ParseObjectLayers = require('./ParseObjectLayers');
 var BuildTilesetIndex = require('./BuildTilesetIndex');
 var AssignTileProperties = require('./AssignTileProperties');
 
-/**
- * @namespace Phaser.Tilemaps.Parsers.Tiled
- */
-
 /**
  * Parses a Tiled JSON object into a new MapData object.
  *

src/tilemaps/parsers/tiled/ParseObject.js

@@ -4,7 +4,7 @@
  * @license      {@link https://opensource.org/licenses/MIT|MIT License}
  */
 
-var Pick = require('./Pick');
+var Pick = require('../../../utils/object/Pick');
 var ParseGID = require('./ParseGID');
 
 var copyPoints = function (p) { return { x: p.x, y: p.y }; };

src/tilemaps/parsers/tiled/ParseTilesets.js

@@ -9,7 +9,7 @@ var ImageCollection = require('../../ImageCollection');
 var ParseObject = require('./ParseObject');
 
 /**
- * Tilesets & Image Collections
+ * Tilesets and Image Collections
  *
  * @function Phaser.Tilemaps.Parsers.Tiled.ParseTilesets
  * @since 3.0.0

src/tilemaps/parsers/tiled/index.js

@@ -0,0 +1,24 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Tilemaps.Parsers.Tiled
+ */
+
+module.exports = {
+
+    AssignTileProperties: require('./AssignTileProperties'),
+    Base64Decode: require('./Base64Decode'),
+    BuildTilesetIndex: require('./BuildTilesetIndex'),
+    ParseGID: require('./ParseGID'),
+    ParseImageLayers: require('./ParseImageLayers'),
+    ParseJSONTiled: require('./ParseJSONTiled'),
+    ParseObject: require('./ParseObject'),
+    ParseObjectLayers: require('./ParseObjectLayers'),
+    ParseTileLayers: require('./ParseTileLayers'),
+    ParseTilesets: require('./ParseTilesets')
+
+};