Phaser API Documentation

  Version: 
Filter
Namespace: Plane
Phaser.Types.GameObjects.Plane

Type Definitions

PlaneCheckerboardConfig
Focus
Focus
Properties:
name type arguments Default description
color1 number <optional> 0xffffff

The odd cell color, specified as a hex value.

color2 number <optional> 0x0000ff

The even cell color, specified as a hex value.

alpha1 number <optional> 255

The odd cell alpha value, specified as a number between 0 and 255.

alpha2 number <optional> 255

The even cell alpha value, specified as a number between 0 and 255.

height number <optional> 128

The view height of the Plane after creation, in pixels.

Type:
object
Focus
Focus
PlaneConfig
Focus
Focus
Properties:
name type arguments Default description
key string | Phaser.Textures.Texture <optional>

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

frame string | number <optional>

An optional frame from the Texture this Game Object 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.

checkerboard Phaser.Types.GameObjects.Plane.PlaneCheckerboardConfig <optional>

Plane checkerboard configuration object.

Type:
object
Since: 3.60.0
Focus
Focus