Merge pull request phaserjs#4847 from rexrainbow/Action-of-scrollFactor

Add SetScrollFactor into Action and Group's createFromConfig

Author: photonstorm

src/actions/SetScrollFactor.js

@@ -0,0 +1,41 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+var PropertyValueSet = require('./PropertyValueSet');
+
+/**
+ * Takes an array of Game Objects, or any objects that have the public properties `scrollFactorX` and `scrollFactorY`
+ * and then sets them to the given values.
+ *
+ * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.
+ *
+ * To use this with a Group: `SetScrollFactor(group.getChildren(), scrollFactorX, scrollFactorY, stepX, stepY)`
+ *
+ * @function Phaser.Actions.SetScrollFactor
+ * @since 3.0.0
+ *
+ * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
+ *
+ * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
+ * @param {number} scrollFactorX - The amount to set the `scrollFactorX` property to.
+ * @param {number} [scrollFactorY] - The amount to set the `scrollFactorY` property to. If `undefined` or `null` it uses the `scrollFactorX` value.
+ * @param {number} [stepX=0] - This is added to the `scrollFactorX` amount, multiplied by the iteration counter.
+ * @param {number} [stepY=0] - This is added to the `scrollFactorY` amount, multiplied by the iteration counter.
+ * @param {integer} [index=0] - An optional offset to start searching from within the items array.
+ * @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
+ *
+ * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
+ */
+var SetScrollFactor = function (items, scrollFactorX, scrollFactorY, stepX, stepY, index, direction)
+{
+    if (scrollFactorY === undefined || scrollFactorY === null) { scrollFactorY = scrollFactorX; }
+
+    PropertyValueSet(items, 'scrollFactorX', scrollFactorX, stepX, index, direction);
+
+    return PropertyValueSet(items, 'scrollFactorY', scrollFactorY, stepY, index, direction);
+};
+
+module.exports = SetScrollFactor;

src/actions/SetScrollFactorX.js

@@ -0,0 +1,35 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+var PropertyValueSet = require('./PropertyValueSet');
+
+/**
+ * Takes an array of Game Objects, or any objects that have the public property `scrollFactorX`
+ * and then sets it to the given value.
+ *
+ * The optional `step` property is applied incrementally, multiplied by each item in the array.
+ *
+ * To use this with a Group: `SetScrollFactorX(group.getChildren(), value, step)`
+ *
+ * @function Phaser.Actions.SetScrollFactorX
+ * @since 3.0.0
+ *
+ * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
+ *
+ * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
+ * @param {number} value - The amount to set the property to.
+ * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
+ * @param {integer} [index=0] - An optional offset to start searching from within the items array.
+ * @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
+ *
+ * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
+ */
+var SetScrollFactorX = function (items, value, step, index, direction)
+{
+    return PropertyValueSet(items, 'scrollFactorX', value, step, index, direction);
+};
+
+module.exports = SetScrollFactorX;

src/actions/SetScrollFactorY.js

@@ -0,0 +1,35 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+var PropertyValueSet = require('./PropertyValueSet');
+
+/**
+ * Takes an array of Game Objects, or any objects that have the public property `scrollFactorY`
+ * and then sets it to the given value.
+ *
+ * The optional `step` property is applied incrementally, multiplied by each item in the array.
+ *
+ * To use this with a Group: `SetScrollFactorY(group.getChildren(), value, step)`
+ *
+ * @function Phaser.Actions.SetScrollFactorY
+ * @since 3.0.0
+ *
+ * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
+ *
+ * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
+ * @param {number} value - The amount to set the property to.
+ * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
+ * @param {integer} [index=0] - An optional offset to start searching from within the items array.
+ * @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
+ *
+ * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
+ */
+var SetScrollFactorY = function (items, value, step, index, direction)
+{
+    return PropertyValueSet(items, 'scrollFactorY', value, step, index, direction);
+};
+
+module.exports = SetScrollFactorY;

src/actions/index.js

@@ -47,6 +47,9 @@ module.exports = {
     SetScale: require('./SetScale'),
     SetScaleX: require('./SetScaleX'),
     SetScaleY: require('./SetScaleY'),
+    SetScrollFactor: require('./SetScrollFactor'),
+    SetScrollFactorX: require('./SetScrollFactorX'),
+    SetScrollFactorY: require('./SetScrollFactorY'),    
     SetTint: require('./SetTint'),
     SetVisible: require('./SetVisible'),
     SetX: require('./SetX'),

src/gameobjects/group/Group.js

@@ -412,6 +412,18 @@ var Group = new Class({
 
         Actions.SetAlpha(entries, alpha, stepAlpha);
 
+        var depth = GetValue(options, 'setDepth.value', 0);
+        var stepDepth = GetValue(options, 'setDepth.step', 0);
+
+        Actions.SetDepth(entries, depth, stepDepth);        
+
+        var scrollFactorX = GetValue(options, 'setScrollFactor.x', 1);
+        var scrollFactorY = GetValue(options, 'setScrollFactor.y', scrollFactorX);
+        var stepScrollFactorX = GetValue(options, 'setScrollFactor.stepX', 0);
+        var stepScrollFactorY = GetValue(options, 'setScrollFactor.stepY', 0);
+
+        Actions.SetScrollFactor(entries, scrollFactorX, scrollFactorY, stepScrollFactorX, stepScrollFactorY);        
+
         var hitArea = GetFastValue(options, 'hitArea', null);
         var hitAreaCallback = GetFastValue(options, 'hitAreaCallback', null);
 

src/gameobjects/group/typedefs/GroupCreateConfig.js

@@ -38,6 +38,14 @@
  * @property {?object} [setAlpha]
  * @property {?number} [setAlpha.value=0] - The alpha value of each new Game Object.
  * @property {?number} [setAlpha.step=0] - Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.
+ * @property {?object} [setDepth]
+ * @property {?number} [setDepth.value=0] - The depth value of each new Game Object.
+ * @property {?number} [setDepth.step=0] - Increment each Game Object's depth from the previous by this amount, starting from `setDepth.value`.
+ * @property {?object} [setScrollFactor]
+ * @property {?number} [setScrollFactor.x=0] - The horizontal scroll factor of each new Game Object.
+ * @property {?number} [setScrollFactor.y=0] - The vertical scroll factor of each new Game Object.
+ * @property {?number} [setScrollFactor.stepX=0] - Increment each Game Object's horizontal scroll factor from the previous by this amount, starting from `setScrollFactor.x`.
+ * @property {?number} [setScrollFactor.stepY=0] - Increment each Game object's vertical scroll factor from the previous by this amount, starting from `setScrollFactor.y`.
  * @property {?*} [hitArea] - A geometric shape that defines the hit area for the Game Object.
  * @property {?Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - A callback to be invoked when the Game Object is interacted with.
  * @property {?(false|Phaser.Types.Actions.GridAlignConfig)} [gridAlign=false] - Align the new Game Objects in a grid using these settings.
@@ -48,6 +56,8 @@
  * @see Phaser.Actions.SetRotation
  * @see Phaser.Actions.SetScale
  * @see Phaser.Actions.SetXY
+ * @see Phaser.Actions.SetDepth
+ * @see Phaser.Actions.SetScrollFactor
  * @see Phaser.GameObjects.Group#createFromConfig
  * @see Phaser.Utils.Array.Range
  */