Phaser API Documentation

  Version: 
<static> Translate([matrix], [x], [y])

Description:

Translates the given Array Matrix by shifting each column and row the amount specified.

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 matrix to translate.

x number <optional>

The amount to horizontally translate the matrix by.

y number <optional>

The amount to vertically translate the matrix by.

Returns:
Description:

The translated matrix.

Type:
  • Array.<Array.<T>>
Since: 3.50.0