Phaser API Documentation

  Version: 

Member of: Phaser.Utils.Array

<static> NumberArrayStep([start], [end], [step])

Description:

Create an array of numbers (positive and/or negative) progressing from start up to but not including end by advancing by step.

If start is less than end a zero-length range is created unless a negative step is specified.

Certain values for start and end (eg. NaN/undefined/null) are currently coerced to 0; for forward compatibility make sure to pass in actual numbers.

Parameters:

name type arguments Default description
start number <optional> 0

The start of the range.

end number <optional> null

The end of the range.

step number <optional> 1

The value to increment or decrement by.

Returns:
Description:

The array of number values.

Type:
  • Array.<number>
Examples:
NumberArrayStep(4);
// => [0, 1, 2, 3]

NumberArrayStep(1, 5);
// => [1, 2, 3, 4]

NumberArrayStep(0, 20, 5);
// => [0, 5, 10, 15]

NumberArrayStep(0, -4, -1);
// => [0, -1, -2, -3]

NumberArrayStep(1, 4, 0);
// => [1, 1, 1]

NumberArrayStep(0);
// => []
Since: 3.0.0