Function PropertyValueSet

PropertyValueSet<G extends GameObject[]>(
    items: G,
    key: string,
    value: number,
    step?: number,
    index?: number,
    direction?: number,
): G
Takes an array of Game Objects, or any objects that have a public property as defined in key, and then sets it to the given value.

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

To use this with a Group: PropertyValueSet(group.getChildren(), key, value, step)
Type Parameters
- G extends GameObject[]
Parameters
- items: G
  The array of items to be updated by this action.
- key: string
  The property to be updated.
- value: number
  The amount to set the property to.
- Optionalstep: number
  This is added to the value 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:248