Phaser API Documentation

  Version: 
<static> CheckMatrix([matrix])

Description:

Checks if an array can be used as a matrix.

A matrix is a two-dimensional array (array of arrays), where all sub-arrays (rows) have the same length. There must be at least two rows. This is an example matrix:

[
   [ 1, 1, 1, 1, 1, 1 ],
   [ 2, 0, 0, 0, 0, 4 ],
   [ 2, 0, 1, 2, 0, 4 ],
   [ 2, 0, 3, 4, 0, 4 ],
   [ 2, 0, 0, 0, 0, 4 ],
   [ 3, 3, 3, 3, 3, 3 ]
]

Parameters:

name type arguments description
matrix Array.<Array.<T>> <optional>

The array to check.

Returns:
Description:

true if the given matrix array is a valid matrix.

Type:
  • boolean
Since: 3.0.0