Function SetScrollFactor

SetScrollFactor<G extends GameObject[]>(
    items: G,
    scrollFactorX: number,
    scrollFactorY?: number,
    stepX?: number,
    stepY?: number,
    index?: number,
    direction?: number,
): G
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)
Type Parameters
- G extends GameObject[]
Parameters
- items: G
  The array of items to be updated by this action.
- scrollFactorX: number
  The amount to set the scrollFactorX property to.
- OptionalscrollFactorY: number
  The amount to set the scrollFactorY property to. If undefined or null it uses the scrollFactorX value.
- OptionalstepX: number
  This is added to the scrollFactorX amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the scrollFactorY amount, multiplied by the iteration counter. Default 0.
- Optionalindex: number
  An optional offset to start searching from within the items array. Default 0.
- Optionaldirection: number
  The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. Default 1.
Returns G
- Defined in types/phaser.d.ts:516