Camera.fadeIn is a new method that will fade the camera in from a given color (black by default) and then optionally invoke a callback. This is the same as using Camera.flash but with an easier to grok method name. Fix phaserjs#3412

Author: photonstorm

CHANGELOG.md

@@ -27,6 +27,8 @@ A special mention must go to @orblazer for their outstanding assistance in helpi
 * Camera.shake now has an optional `callback` argument that is invoked when the effect completes (thanks @pixelscripter)
 * Camera.fade now has an optional `callback` argument that is invoked when the effect completes (thanks @pixelscripter)
 * Camera.flash now has an optional `callback` argument that is invoked when the effect completes (thanks @pixelscripter)
+* Camera.fadeIn is a new method that will fade the camera in from a given color (black by default) and then optionally invoke a callback. This is the same as using Camera.flash but with an easier to grok method name. Fix #3412 (thanks @Jerenaux)
+* Camera.fadeOut is a new method that will fade the camera out to a given color (black by default) and then optionally invoke a callback. This is the same as using Camera.fade but with an easier to grok method name. Fix #3412 (thanks @Jerenaux)
 
 ### Bug Fixes
 

src/cameras/2d/Camera.js

@@ -707,6 +707,53 @@ var Camera = new Class({
         return culledObjects;
     },
 
+    /**
+     * Fades the Camera in from the given color over the duration specified.
+     *
+     * @method Phaser.Cameras.Scene2D.Camera#fadeIn
+     * @since 3.3.0
+     *
+     * @param {number} duration - The duration of the effect in milliseconds.
+     * @param {function} [callback] - An optional callback to invoke when the fade completes. Will be sent one argument - a reference to this camera.
+     * @param {number} [red=0] - The value to fade the red channel from. A value between 0 and 1.
+     * @param {number} [green=0] - The value to fade the green channel from. A value between 0 and 1.
+     * @param {number} [blue=0] - The value to fade the blue channel from. A value between 0 and 1.
+     *
+     * @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
+     */
+    fadeIn: function (duration, callback, red, green, blue)
+    {
+        if (red === undefined) { red = 0; }
+        if (green === undefined) { green = 0; }
+        if (blue === undefined) { blue = 0; }
+
+        return this.flash(duration, red, green, blue, true, callback);
+    },
+
+    /**
+     * Fades the Camera out to the given color over the duration specified.
+     * This is an alias for Camera.fade that forces the fade to start, regardless of existing fades.
+     *
+     * @method Phaser.Cameras.Scene2D.Camera#fadeOut
+     * @since 3.3.0
+     *
+     * @param {number} duration - The duration of the effect in milliseconds.
+     * @param {function} [callback] - An optional callback to invoke when the fade completes. Will be sent one argument - a reference to this camera.
+     * @param {number} [red=0] - The value to fade the red channel from. A value between 0 and 1.
+     * @param {number} [green=0] - The value to fade the green channel from. A value between 0 and 1.
+     * @param {number} [blue=0] - The value to fade the blue channel from. A value between 0 and 1.
+     *
+     * @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
+     */
+    fadeOut: function (duration, callback, red, green, blue)
+    {
+        if (red === undefined) { red = 0; }
+        if (green === undefined) { green = 0; }
+        if (blue === undefined) { blue = 0; }
+
+        return this.fade(duration, red, green, blue, true, callback);
+    },
+
     /**
      * Fades the Camera to the given color over the duration specified.
      *
@@ -1370,7 +1417,7 @@ var Camera = new Class({
 
                 if (this._fadeCallback)
                 {
-                    //  Do this in case the callback flashes again (otherwise we'd overwrite the new callback)
+                    //  Do this in case the callback fades again (otherwise we'd overwrite the new callback)
                     var fadeCallback = this._fadeCallback;
 
                     this._fadeCallback = null;
@@ -1393,7 +1440,7 @@ var Camera = new Class({
 
                 if (this._shakeCallback)
                 {
-                    //  Do this in case the callback flashes again (otherwise we'd overwrite the new callback)
+                    //  Do this in case the callback shakes again (otherwise we'd overwrite the new callback)
                     var shakeCallback = this._shakeCallback;
 
                     this._shakeCallback = null;