Phaser API Documentation

  Version: 
plane([x], [y], [texture], [frame], [width], [height], [tile])

Description:

Creates a new Plane Game Object and adds it to the Scene.

Note: This method will only be available if the Plane Game Object has been built into Phaser.

Parameters:

name type arguments Default description
x number <optional>

The horizontal position of this Plane in the world.

y number <optional>

The vertical position of this Plane in the world.

texture string | Phaser.Textures.Texture <optional>

The key, or instance of the Texture this Plane will use to render with, as stored in the Texture Manager.

frame string | number <optional>

An optional frame from the Texture this Plane is rendering with.

width number <optional> 8

The width of this Plane, in cells, not pixels.

height number <optional> 8

The height of this Plane, in cells, not pixels.

tile boolean <optional> false

Is the texture tiled? I.e. repeated across each cell.

Returns:
Description:

The Plane Game Object that was created.

Since: 3.60.0