Phaser API Documentation

  Version: 

Member of: Phaser.Actions

<static> IncXY(items, x, [y], [stepX], [stepY], [index], [direction])

Description:

Takes an array of Game Objects, or any objects that have public x and y properties, and then adds the given value to each of them.

The optional stepX and stepY properties are applied incrementally, multiplied by each item in the array.

To use this with a Group: IncXY(group.getChildren(), x, y, stepX, stepY)

Parameters:

name type arguments Default description
items array | Array.<Phaser.GameObjects.GameObject>

The array of items to be updated by this action.

x number

The amount to be added to the x property.

y number <optional> x

The amount to be added to the y property. If undefined or null it uses the x value.

stepX number <optional> 0

This is added to the x amount, multiplied by the iteration counter.

stepY number <optional> 0

This is added to the y amount, multiplied by the iteration counter.

index number <optional> 0

An optional offset to start searching from within the items array.

direction number <optional> 1

The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.

Returns:
Description:

The array of objects that were passed to this Action.

Type:
Examples:
Since: 3.0.0
Source: src/actions/IncXY.js (Line 9)