Function SetXY

SetXY<G extends GameObject[]>(
    items: G,
    x: number,
    y?: number,
    stepX?: number,
    stepY?: number,
    index?: number,
    direction?: number,
): G
Takes an array of Game Objects, or any objects that have the public properties x and y 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: SetXY(group.getChildren(), x, y, stepX, stepY)
Type Parameters
- G extends GameObject[]
Parameters
- items: G
  The array of items to be updated by this action.
- x: number
  The amount to set the x property to.
- Optionaly: number
  The amount to set the y property to. If undefined or null it uses the x value. Default x.
- OptionalstepX: number
  This is added to the x amount, multiplied by the iteration counter. Default 0.
- OptionalstepY: number
  This is added to the y 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:600