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

Author: svipal

CHANGELOG.md

@@ -7,10 +7,14 @@
 * `Line.GetEasedPoints` is a new function that will take a Line, a quantity, and an ease function, and returns an array of points where each point has been spaced out across the length of the Line based on the ease function given.
 * `XHRSettings.withCredentials` is a new boolean property that controls the `withCredentials` setting of the XHR Request made by the Loader. It indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. You can set this on a per-file basis, or global in the Game Config.
 * `Config.loaderWithCredentials` is the new global setting for `XHRSettings.withCredentials`.
+* `Camera.renderToGame` is a new property used in conjunction with `renderToTexture`. It controls if the Camera should still render to the Game canvas after rendering to its own texture or not. By default, it will render to both, but you can now toggle this at run-time.
+* `Camera.setRenderToTexture` has a new optional parameter `renderToGame` which sets the `Camera.renderToGame` property, controlling if the Camera should render to both its texture and the Game canvas, or just its texture.
 
 ### Updates
 
 * `XHRLoader` will now use the `XHRSettings.withCredentials` as set in the file or global loader config.
+* `Animation.setCurrentFrame` will no longer try to call `setOrigin` or `updateDisplayOrigin` if the Game Object doesn't have the Origin component, preventing unknown function errors.
+* `MatterTileBody` now extends `EventEmitter`, meaning you can listen to collision events from Tiles directly and it will no longer throw errors about `gameObject.emit` not working. Fix #4967 (thanks @reinildo)
 
 ### Bug Fixes
 
@@ -20,7 +24,7 @@
 
 My thanks to the following for helping with the Phaser 3 Examples, Docs and TypeScript definitions, either by reporting errors, fixing them or helping author the docs:
 
-
+@JasonHK
 
 ## Version 3.22 - Kohaku - January 15th 2020
 

README.md

@@ -2,6 +2,11 @@
 
 ![Phaser Header](https://phaser.io/images/github/300/phaser-header.png "Phaser 3 Header Banner")
 
+[![Discord chat](https://img.shields.io/discord/244245946873937922?style=for-the-badge)](https://discord.gg/phaser)
+[![Twitter Follow](https://img.shields.io/twitter/follow/phaser_?style=for-the-badge)](https://twitter.com/phaser_)
+![GitHub All Releases](https://img.shields.io/github/downloads/photonstorm/phaser/total?style=for-the-badge)
+![npm](https://img.shields.io/npm/dy/phaser?label=npm&style=for-the-badge)
+
 Phaser is a fast, free, and fun open source HTML5 game framework that offers WebGL and Canvas rendering across desktop and mobile web browsers. Games can be compiled to iOS, Android and native apps by using 3rd party tools. You can use JavaScript or TypeScript for development.
 
 Along with the fantastic open source community, Phaser is actively developed and maintained by [Photon Storm](http://www.photonstorm.com). As a result of rapid support, and a developer friendly API, Phaser is currently one of the [most starred](https://github.com/collections/javascript-game-engines) game frameworks on GitHub.

src/cameras/2d/Camera.js

@@ -208,6 +208,24 @@ var Camera = new Class({
          */
         this.renderToTexture = false;
 
+        /**
+         * If this Camera is rendering to a texture (via `setRenderToTexture`) then you
+         * have the option to control if it should also render to the Game canvas as well.
+         * 
+         * By default, a Camera will render both to its texture and to the Game canvas.
+         * 
+         * However, if you set ths property to `false` it will only render to the texture
+         * and skip rendering to the Game canvas.
+         * 
+         * Setting this property if the Camera isn't rendering to a texture has no effect.
+         *
+         * @name Phaser.Cameras.Scene2D.Camera#renderToGame
+         * @type {boolean}
+         * @default true
+         * @since 3.23.0
+         */
+        this.renderToGame = true;
+
         /**
          * If this Camera has been set to render to a texture then this holds a reference
          * to the HTML Canvas Element that the Camera is drawing to.
@@ -304,6 +322,9 @@ var Camera = new Class({
      *
      * You should not enable this unless you plan on actually using the texture it creates
      * somehow, otherwise you're just doubling the work required to render your game.
+     * 
+     * If you only require the Camera to render to a texture, and not also to the Game,
+     * them set the `renderToGame` parameter to `false`.
      *
      * To temporarily disable rendering to a texture, toggle the `renderToTexture` boolean.
      *
@@ -314,11 +335,14 @@ var Camera = new Class({
      * @since 3.13.0
      *
      * @param {(string|Phaser.Renderer.WebGL.WebGLPipeline)} [pipeline] - An optional WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference.
+     * @param {boolean} [renderToGame=true] - If you do not need the Camera to still render to the Game, set this parameter to `false`.
      *
      * @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
      */
-    setRenderToTexture: function (pipeline)
+    setRenderToTexture: function (pipeline, renderToGame)
     {
+        if (renderToGame === undefined) { renderToGame = true; }
+
         var renderer = this.scene.sys.game.renderer;
 
         if (renderer.gl)
@@ -333,6 +357,7 @@ var Camera = new Class({
         }
 
         this.renderToTexture = true;
+        this.renderToGame = renderToGame;
 
         if (pipeline)
         {

src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js

@@ -155,7 +155,7 @@ var DynamicBitmapText = new Class({
      * @param {number} width - The width of the crop.
      * @param {number} height - The height of the crop.
      *
-     * @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
+     * @return {this} This Game Object.
      */
     setSize: function (width, height)
     {
@@ -179,7 +179,7 @@ var DynamicBitmapText = new Class({
      *
      * @param {Phaser.Types.GameObjects.BitmapText.DisplayCallback} callback - The display callback to set.
      *
-     * @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
+     * @return {this} This Game Object.
      */
     setDisplayCallback: function (callback)
     {
@@ -196,7 +196,7 @@ var DynamicBitmapText = new Class({
      *
      * @param {number} value - The horizontal scroll position to set.
      *
-     * @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
+     * @return {this} This Game Object.
      */
     setScrollX: function (value)
     {
@@ -213,7 +213,7 @@ var DynamicBitmapText = new Class({
      *
      * @param {number} value - The vertical scroll position to set.
      *
-     * @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
+     * @return {this} This Game Object.
      */
     setScrollY: function (value)
     {

src/gameobjects/blitter/Bob.js

@@ -152,7 +152,7 @@ var Bob = new Class({
      *
      * @param {(string|integer|Phaser.Textures.Frame)} [frame] - The frame to be used during rendering.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setFrame: function (frame)
     {
@@ -178,7 +178,7 @@ var Bob = new Class({
      * @method Phaser.GameObjects.Bob#resetFlip
      * @since 3.0.0
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     resetFlip: function ()
     {
@@ -202,7 +202,7 @@ var Bob = new Class({
      * @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.
      * @param {(string|integer|Phaser.Textures.Frame)} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     reset: function (x, y, frame)
     {
@@ -234,7 +234,7 @@ var Bob = new Class({
      * @param {number} x - The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.
      * @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setPosition: function (x, y)
     {
@@ -252,7 +252,7 @@ var Bob = new Class({
      *
      * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setFlipX: function (value)
     {
@@ -269,7 +269,7 @@ var Bob = new Class({
      *
      * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setFlipY: function (value)
     {
@@ -287,7 +287,7 @@ var Bob = new Class({
      * @param {boolean} x - The horizontal flipped state. `false` for no flip, or `true` to be flipped.
      * @param {boolean} y - The horizontal flipped state. `false` for no flip, or `true` to be flipped.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setFlip: function (x, y)
     {
@@ -307,7 +307,7 @@ var Bob = new Class({
      *
      * @param {boolean} value - The visible state of the Game Object.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setVisible: function (value)
     {
@@ -327,7 +327,7 @@ var Bob = new Class({
      *
      * @param {number} value - The alpha value used for this Bob. Between 0 and 1.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setAlpha: function (value)
     {
@@ -344,7 +344,7 @@ var Bob = new Class({
      *
      * @param {number} value - The tint value used for this Bob. Between 0 and 0xffffff.
      *
-     * @return {Phaser.GameObjects.Bob} This Bob Game Object.
+     * @return {this} This Bob Game Object.
      */
     setTint: function (value)
     {

src/gameobjects/components/Animation.js

@@ -1020,13 +1020,16 @@ var Animation = new Class({
 
         gameObject.setSizeToFrame();
 
-        if (animationFrame.frame.customPivot)
+        if (gameObject._originComponent)
         {
-            gameObject.setOrigin(animationFrame.frame.pivotX, animationFrame.frame.pivotY);
-        }
-        else
-        {
-            gameObject.updateDisplayOrigin();
+            if (animationFrame.frame.customPivot)
+            {
+                gameObject.setOrigin(animationFrame.frame.pivotX, animationFrame.frame.pivotY);
+            }
+            else
+            {
+                gameObject.updateDisplayOrigin();
+            }
         }
 
         return gameObject;

src/gameobjects/components/PathFollower.js

@@ -110,7 +110,7 @@ var PathFollower = {
      * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.
      * @param {(number|Phaser.Types.GameObjects.PathFollower.PathConfig|Phaser.Types.Tweens.NumberTweenBuilderConfig)} [config] - Settings for the PathFollower.
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     setPath: function (path, config)
     {
@@ -142,7 +142,7 @@ var PathFollower = {
      * @param {boolean} value - Whether the PathFollower should automatically rotate to point in the direction of the Path.
      * @param {number} [offset=0] - Rotation offset in degrees.
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     setRotateToPath: function (value, offset)
     {
@@ -181,7 +181,7 @@ var PathFollower = {
      * @param {(number|Phaser.Types.GameObjects.PathFollower.PathConfig|Phaser.Types.Tweens.NumberTweenBuilderConfig)} [config={}] - The duration of the follow, or a PathFollower config object.
      * @param {number} [startAt=0] - Optional start position of the follow, between 0 and 1.
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     startFollow: function (config, startAt)
     {
@@ -271,7 +271,7 @@ var PathFollower = {
      * @method Phaser.GameObjects.Components.PathFollower#pauseFollow
      * @since 3.3.0
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     pauseFollow: function ()
     {
@@ -293,7 +293,7 @@ var PathFollower = {
      * @method Phaser.GameObjects.Components.PathFollower#resumeFollow
      * @since 3.3.0
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     resumeFollow: function ()
     {
@@ -315,7 +315,7 @@ var PathFollower = {
      * @method Phaser.GameObjects.Components.PathFollower#stopFollow
      * @since 3.3.0
      *
-     * @return {Phaser.GameObjects.PathFollower} This Game Object.
+     * @return {this} This Game Object.
      */
     stopFollow: function ()
     {

src/gameobjects/components/TransformMatrix.js

@@ -438,7 +438,7 @@ var TransformMatrix = new Class({
      * @param {Phaser.GameObjects.Components.TransformMatrix} rhs - The Matrix to multiply by.
      * @param {Phaser.GameObjects.Components.TransformMatrix} [out] - An optional Matrix to store the results in.
      *
-     * @return {Phaser.GameObjects.Components.TransformMatrix} Either this TransformMatrix, or the `out` Matrix, if given in the arguments.
+     * @return {(this|Phaser.GameObjects.Components.TransformMatrix)} Either this TransformMatrix, or the `out` Matrix, if given in the arguments.
      */
     multiply: function (rhs, out)
     {