Phaser API Documentation

  Version: 

Member of: Phaser.Actions

<static> IncY(items, value, [step], [index], [direction])

Description:

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

The optional step property is applied incrementally, multiplied by each item in the array.

To use this with a Group: IncY(group.getChildren(), value, step)

Parameters:

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

The array of items to be updated by this action.

value number

The amount to be added to the y property.

step number <optional> 0

This is added to the value 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/IncY.js (Line 9)