Phaser API Documentation


Member of: Phaser.Actions

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


Takes an array of Game Objects, or any objects that have a public property as defined in key, and then adds the given value to it.

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

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


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

The array of items to be updated by this action.

key string

The property to be updated.

value number

The amount to be added to the 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.


The array of objects that were passed to this Action.

Since: 3.3.0