Phaser Class: ArrayUtils

Utility functions for dealing with Arrays.

<static> findClosest(value, arr) → {number}

Snaps a value to the nearest value in an array. The result will always be in the range [first_value, last_value].

Name	Type	Description
`value`	number	The search value
`arr`	number[]	The input array which must be sorted.

number -

The nearest value found.

<static> getRandomItem(objects, startIndex, length) → {object}

Fetch a random entry from the given array. Will return null if random selection is missing, or array has no entries.

Name	Type	Description
`objects`	any[]	An array of objects.
`startIndex`	integer	Optional offset off the front of the array. Default value is 0, or the beginning of the array.
`length`	integer	Optional restriction on the number of values you want to randomly select from.

object -

The random object that was selected.

<static> removeRandomItem(objects, startIndex, length) → {object}

Removes a random object from the given array and returns it. Will return null if random selection is missing, or array has no entries.

Name	Type	Description
`objects`	any[]	An array of objects.
`startIndex`	integer	Optional offset off the front of the array. Default value is 0, or the beginning of the array.
`length`	integer	Optional restriction on the number of values you want to randomly select from.

object -

The random object that was removed.

<static> rotate(array) → {any}

Moves the element from the start of the array to the end, shifting all items in the process. The "rotation" happens to the left.

Name	Type	Description
`array`	any[]	The array to shift/rotate. The array is modified.

any -

The shifted value.

<static> rotateMatrix(matrix, direction) → {array}

Rotates the given array. Based on the routine from http://jsfiddle.net/MrPolywhirl/NH42z/

Name	Type	Description
`matrix`	array	The array to rotate.
`direction`	number \| string	The amount to rotate. Either a number: 90, -90, 270, -270, 180 or a string: 'rotateLeft', 'rotateRight' or 'rotate180'