Phaser API Documentation

  Version: 
Filter

A Plane Game Object.

The Plane Game Object is a helper class that takes the Mesh Game Object and extends it, allowing for fast and easy creation of Planes. A Plane is a one-sided grid of cells, where you specify the number of cells in each dimension. The Plane can have a texture that is either repeated (tiled) across each cell, or applied to the full Plane.

The Plane can then be manipulated in 3D space, with rotation across all 3 axis.

This allows you to create effects not possible with regular Sprites, such as perspective distortion. You can also adjust the vertices on a per-vertex basis. Plane data becomes part of the WebGL batch, just like standard Sprites, so doesn't introduce any additional shader overhead. Because the Plane just generates vertices into the WebGL batch, like any other Sprite, you can use all of the common Game Object components on a Plane too, such as a custom pipeline, mask, blend mode or texture.

You can use the uvScroll and uvScale methods to adjust the placement and scaling of the texture if this Plane is using a single texture, and not a frame from a texture atlas or sprite sheet.

The Plane Game Object also has the Animation component, allowing you to play animations across the Plane just as you would with a Sprite.

Note that the Plane object is WebGL only and does not have a Canvas counterpart.

The Plane origin is always 0.5 x 0.5 and cannot be changed.

Constructor:

new Plane(scene, [x], [y], [texture], [frame], [width], [height], [tile])

Parameters:

name type arguments Default description
scene Phaser.Scene

The Scene to which this Plane belongs. A Plane can only belong to one Scene at a time.

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.

Since: 3.60.0

Extends


Members

<private> _alpha: number
Focus
Focus

Description:

Private internal value. Holds the global alpha value.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.AlphaSingle#_alpha
Since: 3.0.0
Focus
Focus
<private> _blendMode: number
Focus
Focus

Description:

Private internal value. Holds the current blend mode.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.BlendMode#_blendMode
Since: 3.0.0
Focus
Focus
<private, nullable> _checkerboard: WebGLTexture
Focus
Focus

Description:

If this Plane has a checkboard texture, this is a reference to the WebGLTexture being used. Otherwise, it's null.

Type:
WebGLTexture
Since: 3.60.0
Focus
Focus
<private> _depth: number
Focus
Focus

Description:

Private internal value. Holds the depth of the Game Object.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Depth#_depth
Since: 3.0.0
Focus
Focus
<private> _rotation: number
Focus
Focus

Description:

Private internal value. Holds the rotation value in radians.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#_rotation
Since: 3.0.0
Focus
Focus
<private> _scaleX: number
Focus
Focus

Description:

Private internal value. Holds the horizontal scale value.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#_scaleX
Since: 3.0.0
Focus
Focus
<private> _scaleY: number
Focus
Focus

Description:

Private internal value. Holds the vertical scale value.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#_scaleY
Since: 3.0.0
Focus
Focus
<private> _sizeComponent: boolean
Focus
Focus

Description:

A property indicating that a Game Object has this component.

Type:
boolean
Default: true
Inherited from: Phaser.GameObjects.Components.Size#_sizeComponent
Since: 3.2.0
Focus
Focus
<private> _visible: boolean
Focus
Focus

Description:

Private internal value. Holds the visible value.

Type:
boolean
Default: true
Inherited from: Phaser.GameObjects.Components.Visible#_visible
Since: 3.0.0
Focus
Focus
active: boolean
Focus
Focus

Description:

The active state of this Game Object. A Game Object with an active state of true is processed by the Scenes UpdateList, if added to it. An active object is one which is having its logic and internal systems updated.

Type:
boolean
Default: true
Inherited from: Phaser.GameObjects.GameObject#active
Since: 3.0.0
Focus
Focus
alpha: number
Focus
Focus

Description:

The alpha value of the Game Object.

This is a global value, impacting the entire Game Object, not just a region of it.

Type:
number
Inherited from: Phaser.GameObjects.Components.AlphaSingle#alpha
Since: 3.0.0
Focus
Focus
angle: number
Focus
Focus

Description:

The angle of this Game Object as expressed in degrees.

Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left and -90 is up.

If you prefer to work in radians, see the rotation property instead.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#angle
Since: 3.0.0
Focus
Focus

Description:

The Animation State component of this Sprite.

This component provides features to apply animations to this Sprite. It is responsible for playing, loading, queuing animations for later playback, mixing between animations and setting the current animation frame to this Sprite.

Type:
Since: 3.60.0
Focus
Focus
blendMode: string | number | Phaser.BlendModes
Focus
Focus

Description:

Sets the Blend Mode being used by this Game Object.

This can be a const, such as Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)

Under WebGL only the following Blend Modes are available:

  • NORMAL
  • ADD
  • MULTIPLY
  • SCREEN
  • ERASE

Canvas has more available depending on browser support.

You can also create your own custom Blend Modes in WebGL.

Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency of which blend modes are used.

Type:
string | number | Phaser.BlendModes
Inherited from: Phaser.GameObjects.Components.BlendMode#blendMode
Since: 3.0.0
Focus
Focus
<nullable> body: MatterJS.BodyType | Phaser.Physics.Arcade.Body | Phaser.Physics.Arcade.StaticBody
Focus
Focus

Description:

If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.

Type:
Default: null
Inherited from: Phaser.GameObjects.GameObject#body
Since: 3.0.0
Focus
Focus
cameraFilter: number
Focus
Focus

Description:

A bitmask that controls if this Game Object is drawn by a Camera or not. Not usually set directly, instead call Camera.ignore, however you can set this property directly using the Camera.id property:

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.GameObject#cameraFilter
Since: 3.0.0
Focus
Focus

Description:

A Data Manager. It allows you to store, query and get key/value paired information specific to this Game Object. null by default. Automatically created if you use getData or setData or setDataEnabled.

Type:
Default: null
Inherited from: Phaser.GameObjects.GameObject#data
Since: 3.0.0
Focus
Focus
debugCallback: function
Focus
Focus

Description:

You can optionally choose to render the vertices of this Mesh to a Graphics instance.

Achieve this by setting the debugCallback and the debugGraphic properties.

You can do this in a single call via the Mesh.setDebug method, which will use the built-in debug function. You can also set it to your own callback. The callback will be invoked once per render and sent the following parameters:

debugCallback(src, meshLength, verts)

src is the Mesh instance being debugged. meshLength is the number of mesh vertices in total. verts is an array of the translated vertex coordinates.

To disable rendering, set this property back to null.

Please note that high vertex count Meshes will struggle to debug properly.

Type:
function
Inherited from: Phaser.GameObjects.Mesh#debugCallback
Since: 3.50.0
Focus
Focus

Description:

The Graphics instance that the debug vertices will be drawn to, if setDebug has been called.

Type:
Inherited from: Phaser.GameObjects.Mesh#debugGraphic
Since: 3.50.0
Focus
Focus
Only webGL defaultPipeline: Phaser.Renderer.WebGL.WebGLPipeline
Focus
Focus

Description:

The initial WebGL pipeline of this Game Object.

If you call resetPipeline on this Game Object, the pipeline is reset to this default.

Type:
Default: null
Inherited from: Phaser.GameObjects.Components.Pipeline#defaultPipeline
Since: 3.0.0
Focus
Focus
depth: number
Focus
Focus

Description:

The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.

The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.

The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.

Setting the depth will queue a depth sort event within the Scene.

Type:
number
Inherited from: Phaser.GameObjects.Components.Depth#depth
Since: 3.0.0
Focus
Focus
<private> dirtyCache: Array.<number>
Focus
Focus

Description:

An internal cache, used to compare position, rotation, scale and face data each frame, to avoid math calculations in preUpdate.

Cache structure = position xyz | rotation xyz | scale xyz | face count | view | ortho

Type:
Array.<number>
Inherited from: Phaser.GameObjects.Mesh#dirtyCache
Since: 3.50.0
Focus
Focus
displayHeight: number
Focus
Focus

Description:

The displayed height of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

Type:
number
Inherited from: Phaser.GameObjects.Components.Size#displayHeight
Since: 3.0.0
Focus
Focus

Description:

Holds a reference to the Display List that contains this Game Object.

This is set automatically when this Game Object is added to a Scene or Layer.

You should treat this property as being read-only.

Type:
Default: null
Inherited from: Phaser.GameObjects.GameObject#displayList
Since: 3.50.0
Focus
Focus
displayWidth: number
Focus
Focus

Description:

The displayed width of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

Type:
number
Inherited from: Phaser.GameObjects.Components.Size#displayWidth
Since: 3.0.0
Focus
Focus
faces: Array.<Phaser.Geom.Mesh.Face>
Focus
Focus

Description:

An array containing the Face instances belonging to this Mesh.

A Face consists of 3 Vertex objects.

This array is populated during calls such as addVertices or addOBJ.

Type:
Inherited from: Phaser.GameObjects.Mesh#faces
Since: 3.50.0
Focus
Focus
<readonly> fov: number
Focus
Focus

Description:

The Camera fov (field of view) in degrees.

This is set automatically as part of the Mesh.setPerspective call, but exposed here for additional math.

Do not modify this property directly, doing so will not change the fov. For that, call the respective Mesh methods.

Type:
number
Inherited from: Phaser.GameObjects.Mesh#fov
Since: 3.60.0
Focus
Focus

Description:

The Texture Frame this Game Object is using to render with.

Type:
Inherited from: Phaser.GameObjects.Components.Texture#frame
Since: 3.0.0
Focus
Focus
<readonly> gridHeight: number
Focus
Focus

Description:

The height of this Plane in cells, not pixels.

This value is read-only. To adjust it, see the setGridSize method.

Type:
number
Since: 3.60.0
Focus
Focus
<readonly> gridWidth: number
Focus
Focus

Description:

The width of this Plane in cells, not pixels.

This value is read-only. To adjust it, see the setGridSize method.

Type:
number
Since: 3.60.0
Focus
Focus
Only webGL hasPostPipeline: boolean
Focus
Focus

Description:

Does this Game Object have any Post Pipelines set?

Type:
boolean
Inherited from: Phaser.GameObjects.Components.PostPipeline#hasPostPipeline
Since: 3.60.0
Focus
Focus
<readonly> hasTransformComponent: boolean
Focus
Focus

Description:

A property indicating that a Game Object has this component.

Type:
boolean
Default: true
Inherited from: Phaser.GameObjects.Components.Transform#hasTransformComponent
Since: 3.60.0
Focus
Focus
height: number
Focus
Focus

Description:

The native (un-scaled) height of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayHeight property.

Type:
number
Inherited from: Phaser.GameObjects.Components.Size#height
Since: 3.0.0
Focus
Focus
hideCCW: boolean
Focus
Focus

Description:

When rendering, skip any Face that isn't counter clockwise?

Enable this to hide backward-facing Faces during rendering.

Disable it to render all Faces.

Type:
boolean
Inherited from: Phaser.GameObjects.Mesh#hideCCW
Since: 3.50.0
Focus
Focus
ignoreDestroy: boolean
Focus
Focus

Description:

This Game Object will ignore all calls made to its destroy method if this flag is set to true. This includes calls that may come from a Group, Container or the Scene itself. While it allows you to persist a Game Object across Scenes, please understand you are entirely responsible for managing references to and from this Game Object.

Type:
boolean
Default: false
Inherited from: Phaser.GameObjects.GameObject#ignoreDestroy
Since: 3.5.0
Focus
Focus
ignoreDirtyCache: boolean
Focus
Focus

Description:

By default, the Mesh will check to see if its model or view transform has changed each frame and only recalculate the vertex positions if they have.

This avoids lots of additional math in the preUpdate step when not required.

However, if you are performing per-Face or per-Vertex manipulation on this Mesh, such as tweening a Face, or moving it without moving the rest of the Mesh, then you may need to disable the dirty cache in order for the Mesh to re-render correctly. You can toggle this property to do that. Please note that leaving this set to true will cause the Mesh to recalculate the position of every single vertex in it, every single frame. So only really do this if you know you need it.

Type:
boolean
Inherited from: Phaser.GameObjects.Mesh#ignoreDirtyCache
Since: 3.50.0
Focus
Focus

Description:

If this Game Object is enabled for input then this property will contain an InteractiveObject instance. Not usually set directly. Instead call GameObject.setInteractive().

Type:
Default: null
Inherited from: Phaser.GameObjects.GameObject#input
Since: 3.0.0
Focus
Focus
<private> isCropped: boolean
Focus
Focus

Description:

Internal flag. Not to be set by this Game Object.

Type:
boolean
Inherited from: Phaser.GameObjects.Components.Texture#isCropped
Since: 3.11.0
Focus
Focus
<readonly> isTiled: boolean
Focus
Focus

Description:

Is the texture of this Plane tiled across all cells, or not?

This value is read-only. To adjust it, see the setGridSize method.

Type:
boolean
Since: 3.60.0
Focus
Focus
modelPosition: Phaser.Math.Vector3
Focus
Focus

Description:

A Vector3 containing the 3D position of the vertices in this Mesh.

Modifying the components of this property will allow you to reposition where the vertices are rendered within the Mesh. This happens in the preUpdate phase, where each vertex is transformed using the view and projection matrices.

Changing this property will impact all vertices being rendered by this Mesh.

You can also adjust the 'view' by using the pan methods.

Type:
Inherited from: Phaser.GameObjects.Mesh#modelPosition
Since: 3.50.0
Focus
Focus
modelRotation: Phaser.Math.Vector3
Focus
Focus

Description:

A Vector3 containing the 3D rotation of the vertices in this Mesh.

The values should be given in radians, i.e. to rotate the vertices by 90 degrees you can use modelRotation.x = Phaser.Math.DegToRad(90).

Modifying the components of this property will allow you to rotate the vertices within the Mesh. This happens in the preUpdate phase, where each vertex is transformed using the view and projection matrices.

Changing this property will impact all vertices being rendered by this Mesh.

Type:
Inherited from: Phaser.GameObjects.Mesh#modelRotation
Since: 3.50.0
Focus
Focus
modelScale: Phaser.Math.Vector3
Focus
Focus

Description:

A Vector3 containing the 3D scale of the vertices in this Mesh.

Modifying the components of this property will allow you to scale the vertices within the Mesh. This happens in the preUpdate phase, where each vertex is transformed using the view and projection matrices.

Changing this property will impact all vertices being rendered by this Mesh.

Type:
Inherited from: Phaser.GameObjects.Mesh#modelScale
Since: 3.50.0
Focus
Focus
name: string
Focus
Focus

Description:

The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.

Type:
string
Default: ''
Inherited from: Phaser.GameObjects.GameObject#name
Since: 3.0.0
Focus
Focus
parentContainer: Phaser.GameObjects.Container
Focus
Focus

Description:

The parent Container of this Game Object, if it has one.

Type:
Inherited from: Phaser.GameObjects.GameObject#parentContainer
Since: 3.4.0
Focus
Focus

Description:

The current WebGL pipeline of this Game Object.

Type:
Default: null
Inherited from: Phaser.GameObjects.Components.Pipeline#pipeline
Since: 3.0.0
Focus
Focus
Only webGL pipelineData: object
Focus
Focus

Description:

An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.

Type:
object
Inherited from: Phaser.GameObjects.Components.Pipeline#pipelineData
Since: 3.50.0
Focus
Focus

Description:

The Post FX component of this Game Object.

This component allows you to apply a variety of built-in effects to this Game Object, such as glow, blur, bloom, displacements, vignettes and more. You access them via this property, for example:

const player = this.add.sprite();
player.postFX.addBloom();

All FX are WebGL only and do not have Canvas counterparts.

Please see the FX Class for more details and available methods.

This property is always null until the initPostPipeline method is called.

Type:
Inherited from: Phaser.GameObjects.Components.PostPipeline#postFX
Since: 3.60.0
Focus
Focus
Only webGL postPipelineData: object
Focus
Focus

Description:

An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.

Type:
object
Inherited from: Phaser.GameObjects.Components.PostPipeline#postPipelineData
Since: 3.60.0
Focus
Focus
Only webGL postPipelines: Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>
Focus
Focus

Description:

The WebGL Post FX Pipelines this Game Object uses for post-render effects.

The pipelines are processed in the order in which they appear in this array.

If you modify this array directly, be sure to set the hasPostPipeline property accordingly.

Type:
Inherited from: Phaser.GameObjects.Components.PostPipeline#postPipelines
Since: 3.60.0
Focus
Focus
Only webGL <nullable> preFX: Phaser.GameObjects.Components.FX
Focus
Focus

Description:

The Pre FX component of this Game Object.

This component allows you to apply a variety of built-in effects to this Game Object, such as glow, blur, bloom, displacements, vignettes and more. You access them via this property, for example:

const player = this.add.sprite();
player.preFX.addBloom();

Only the following Game Objects support Pre FX:

  • Image
  • Sprite
  • TileSprite
  • Text
  • RenderTexture
  • Video

All FX are WebGL only and do not have Canvas counterparts.

Please see the FX Class for more details and available methods.

Type:
Inherited from: Phaser.GameObjects.Components.PostPipeline#preFX
Since: 3.60.0
Focus
Focus
projectionMatrix: Phaser.Math.Matrix4
Focus
Focus

Description:

The projection matrix for this Mesh.

Update it with the setPerspective or setOrtho methods.

Type:
Inherited from: Phaser.GameObjects.Mesh#projectionMatrix
Since: 3.50.0
Focus
Focus
renderFlags: number
Focus
Focus

Description:

The flags that are compared against RENDER_MASK to determine if this Game Object will render or not. The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively. If those components are not used by your custom class then you can use this bitmask as you wish.

Type:
number
Default: 15
Inherited from: Phaser.GameObjects.GameObject#renderFlags
Since: 3.0.0
Focus
Focus
rotation: number
Focus
Focus

Description:

The angle of this Game Object in radians.

Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left and -PI/2 is up.

If you prefer to work in degrees, see the angle property instead.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#rotation
Since: 3.0.0
Focus
Focus
scale: number
Focus
Focus

Description:

This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object to the same value, at the same time. When reading this value the result returned is (scaleX + scaleY) / 2.

Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this isn't the case, use the scaleX or scaleY properties instead.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#scale
Since: 3.18.0
Focus
Focus
scaleX: number
Focus
Focus

Description:

The horizontal scale of this Game Object.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#scaleX
Since: 3.0.0
Focus
Focus
scaleY: number
Focus
Focus

Description:

The vertical scale of this Game Object.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.Transform#scaleY
Since: 3.0.0
Focus
Focus
scene: Phaser.Scene
Focus
Focus

Description:

A reference to the Scene to which this Game Object belongs.

Game Objects can only belong to one Scene.

You should consider this property as being read-only. You cannot move a Game Object to another Scene by simply changing it.

Type:
Inherited from: Phaser.GameObjects.GameObject#scene
Since: 3.0.0
Focus
Focus
scrollFactorX: number
Focus
Focus

Description:

The horizontal scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.ScrollFactor#scrollFactorX
Since: 3.0.0
Focus
Focus
scrollFactorY: number
Focus
Focus

Description:

The vertical scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.

Type:
number
Default: 1
Inherited from: Phaser.GameObjects.Components.ScrollFactor#scrollFactorY
Since: 3.0.0
Focus
Focus
state: number | string
Focus
Focus

Description:

The current state of this Game Object.

Phaser itself will never modify this value, although plugins may do so.

Use this property to track the state of a Game Object during its lifetime. For example, it could change from a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons. If you need to store complex data about your Game Object, look at using the Data Component instead.

Type:
number | string
Inherited from: Phaser.GameObjects.GameObject#state
Since: 3.16.0
Focus
Focus
tabIndex: number
Focus
Focus

Description:

The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.

Type:
number
Default: -1
Inherited from: Phaser.GameObjects.GameObject#tabIndex
Since: 3.0.0
Focus
Focus

Description:

The Texture this Game Object is using to render with.

Type:
Inherited from: Phaser.GameObjects.Components.Texture#texture
Since: 3.0.0
Focus
Focus
tintFill: boolean
Focus
Focus

Description:

The tint fill mode.

false = An additive tint (the default), where vertices colors are blended with the texture. true = A fill tint, where the vertex colors replace the texture, but respects texture alpha.

Type:
boolean
Default: false
Inherited from: Phaser.GameObjects.Mesh#tintFill
Since: 3.50.0
Focus
Focus
<private> totalFrame: number
Focus
Focus

Description:

Internal cache var for the total number of faces rendered this frame.

See totalRendered instead for the actual value.

Type:
number
Inherited from: Phaser.GameObjects.Mesh#totalFrame
Since: 3.50.0
Focus
Focus
<readonly> totalRendered: number
Focus
Focus

Description:

How many faces were rendered by this Mesh Game Object in the last draw? This is reset in the preUpdate method and then incremented each time a face is drawn. Note that in multi-camera Scenes this value may exceed that found in Mesh.getFaceCount due to cameras drawing the same faces more than once.

Type:
number
Inherited from: Phaser.GameObjects.Mesh#totalRendered
Since: 3.50.0
Focus
Focus
transformMatrix: Phaser.Math.Matrix4
Focus
Focus

Description:

The transformation matrix for this Mesh.

Type:
Inherited from: Phaser.GameObjects.Mesh#transformMatrix
Since: 3.50.0
Focus
Focus
type: string
Focus
Focus

Description:

A textual representation of this Game Object, i.e. sprite. Used internally by Phaser but is available for your own custom classes to populate.

Type:
string
Inherited from: Phaser.GameObjects.GameObject#type
Since: 3.0.0
Focus
Focus
vertices: Array.<Phaser.Geom.Mesh.Vertex>
Focus
Focus

Description:

An array containing Vertex instances. One instance per vertex in this Mesh.

This array is populated during calls such as addVertex or addOBJ.

Type:
Inherited from: Phaser.GameObjects.Mesh#vertices
Since: 3.50.0
Focus
Focus
viewMatrix: Phaser.Math.Matrix4
Focus
Focus

Description:

The view matrix for this Mesh.

Type:
Inherited from: Phaser.GameObjects.Mesh#viewMatrix
Since: 3.50.0
Focus
Focus
viewPosition: Phaser.Math.Vector3
Focus
Focus

Description:

The view position for this Mesh.

Use the methodspanX, panY and panZ to adjust the view.

Type:
Inherited from: Phaser.GameObjects.Mesh#viewPosition
Since: 3.50.0
Focus
Focus
visible: boolean
Focus
Focus

Description:

The visible state of the Game Object.

An invisible Game Object will skip rendering, but will still process update logic.

Type:
boolean
Inherited from: Phaser.GameObjects.Components.Visible#visible
Since: 3.0.0
Focus
Focus
w: number
Focus
Focus

Description:

The w position of this Game Object.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#w
Since: 3.0.0
Focus
Focus
width: number
Focus
Focus

Description:

The native (un-scaled) width of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayWidth property.

Type:
number
Inherited from: Phaser.GameObjects.Components.Size#width
Since: 3.0.0
Focus
Focus
x: number
Focus
Focus

Description:

The x position of this Game Object.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#x
Since: 3.0.0
Focus
Focus
y: number
Focus
Focus

Description:

The y position of this Game Object.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#y
Since: 3.0.0
Focus
Focus
z: number
Focus
Focus

Description:

The z position of this Game Object.

Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#depth instead.

Type:
number
Default: 0
Inherited from: Phaser.GameObjects.Components.Transform#z
Since: 3.0.0
Focus
Focus

Methods

addFace(vertex1, vertex2, vertex3)
Focus
Focus

Description:

Adds a new Face into the faces array of this Mesh.

A Face consists of references to 3 Vertex instances, which must be provided.

Parameters:

name type description
vertex1 Phaser.Geom.Mesh.Vertex

The first vertex of the Face.

vertex2 Phaser.Geom.Mesh.Vertex

The second vertex of the Face.

vertex3 Phaser.Geom.Mesh.Vertex

The third vertex of the Face.

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#addFace
Since: 3.50.0
Focus
Focus
addListener(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#addListener
Since: 3.0.0
Focus
Focus
addToDisplayList([displayList])
Focus
Focus

Description:

Adds this Game Object to the given Display List.

If no Display List is specified, it will default to the Display List owned by the Scene to which this Game Object belongs.

A Game Object can only exist on one Display List at any given time, but may move freely between them.

If this Game Object is already on another Display List when this method is called, it will first be removed from it, before being added to the new list.

You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList property.

If a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarly disable it from rendering, consider using the setVisible method, instead.

Parameters:

name type arguments description
displayList Phaser.GameObjects.DisplayList | Phaser.GameObjects.Layer <optional>

The Display List to add to. Defaults to the Scene Display List.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.GameObject#addToDisplayList
Since: 3.53.0
Focus
Focus
addToUpdateList()
Focus
Focus

Description:

Adds this Game Object to the Update List belonging to the Scene.

When a Game Object is added to the Update List it will have its preUpdate method called every game frame. This method is passed two parameters: delta and time.

If you wish to run your own logic within preUpdate then you should always call super.preUpdate(delta, time) within it, or it may fail to process required operations, such as Sprite animations.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.GameObject#addToUpdateList
Since: 3.53.0
Focus
Focus
addVertex(x, y, z, u, v, [color], [alpha])
Focus
Focus

Description:

Adds a new Vertex into the vertices array of this Mesh.

Just adding a vertex isn't enough to render it. You need to also make it part of a Face, with 3 Vertex instances per Face.

Parameters:

name type arguments Default description
x number

The x position of the vertex.

y number

The y position of the vertex.

z number

The z position of the vertex.

u number

The UV u coordinate of the vertex.

v number

The UV v coordinate of the vertex.

color number <optional> 0xffffff

The color value of the vertex.

alpha number <optional> 1

The alpha value of the vertex.

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#addVertex
Since: 3.50.0
Focus
Focus
addVertices(vertices, uvs, [indicies], [containsZ], [normals], [colors], [alphas])
Focus
Focus

Description:

Adds new vertices to this Mesh by parsing the given data.

This method will take vertex data in one of two formats, based on the containsZ parameter.

If your vertex data are x, y pairs, then containsZ should be false (this is the default, and will result in z=0 for each vertex).

If your vertex data is groups of x, y and z values, then the containsZ parameter must be true.

The uvs parameter is a numeric array consisting of u and v pairs.

The normals parameter is a numeric array consisting of x, y vertex normal values and, if containsZ is true, z values as well.

The indicies parameter is an optional array that, if given, is an indexed list of vertices to be added.

The colors parameter is an optional array, or single value, that if given sets the color of each vertex created.

The alphas parameter is an optional array, or single value, that if given sets the alpha of each vertex created.

When providing indexed data it is assumed that all of the arrays are indexed, not just the vertices.

The following example will create a 256 x 256 sized quad using an index array:

let mesh = new Mesh(this);  // Assuming `this` is a scene!
const vertices = [
  -128, 128,
  128, 128,
  -128, -128,
  128, -128
];

const uvs = [
  0, 1,
  1, 1,
  0, 0,
  1, 0
];

const indices = [ 0, 2, 1, 2, 3, 1 ];

mesh.addVertices(vertices, uvs, indicies);
// Note: Otherwise the added points will be "behind" the camera! This value will project vertex `x` & `y` values 1:1 to pixel values.
mesh.hideCCW = false;
mesh.setOrtho(mesh.width, mesh.height);

If the data is not indexed, it's assumed that the arrays all contain sequential data.

Parameters:

name type arguments Default description
vertices Array.<number>

The vertices array. Either xy pairs, or xyz if the containsZ parameter is true.

uvs Array.<number>

The UVs pairs array.

indicies Array.<number> <optional>

Optional vertex indicies array. If you don't have one, pass null or an empty array.

containsZ boolean <optional> false

Does the vertices data include a z component? If not, it will be assumed z=0, see methods panZ or setOrtho.

normals Array.<number> <optional>

Optional vertex normals array. If you don't have one, pass null or an empty array.

colors number | Array.<number> <optional> 0xffffff

An array of colors, one per vertex, or a single color value applied to all vertices.

alphas number | Array.<number> <optional> 1

An array of alpha values, one per vertex, or a single alpha value applied to all vertices.

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#addVertices
Since: 3.50.0
Focus
Focus
addVerticesFromObj(key, [scale], [x], [y], [z], [rotateX], [rotateY], [rotateZ], [zIsUp])
Focus
Focus

Description:

This method will add the data from a triangulated Wavefront OBJ model file to this Mesh.

The data should have been loaded via the OBJFile:

this.load.obj(key, url);

Then use the same key as the first parameter to this method.

Multiple Mesh Game Objects can use the same model data without impacting on each other.

Make sure your 3D package has triangulated the model data prior to exporting it.

You can add multiple models to a single Mesh, although they will act as one when moved or rotated. You can scale the model data, should it be too small, or too large, to see. You can also offset the vertices of the model via the x, y and z parameters.

Parameters:

name type arguments Default description
key string

The key of the model data in the OBJ Cache to add to this Mesh.

scale number <optional> 1

An amount to scale the model data by. Use this if the model has exported too small, or large, to see.

x number <optional> 0

Translate the model x position by this amount.

y number <optional> 0

Translate the model y position by this amount.

z number <optional> 0

Translate the model z position by this amount.

rotateX number <optional> 0

Rotate the model on the x axis by this amount, in radians.

rotateY number <optional> 0

Rotate the model on the y axis by this amount, in radians.

rotateZ number <optional> 0

Rotate the model on the z axis by this amount, in radians.

zIsUp boolean <optional> true

Is the z axis up (true), or is y axis up (false)?

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#addVerticesFromObj
Since: 3.50.0
Focus
Focus
addedToScene()
Focus
Focus

Description:

This callback is invoked when this Game Object is added to a Scene.

Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to add themselves into the Update List.

You can also listen for the ADDED_TO_SCENE event from this Game Object.

Inherited from: Phaser.GameObjects.GameObject#addedToScene
Since: 3.50.0
Focus
Focus
clear()
Focus
Focus

Description:

Iterates and destroys all current Faces in this Mesh, then resets the faces and vertices arrays.

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#clear
Since: 3.50.0
Focus
Focus
clearAlpha()
Focus
Focus

Description:

Clears all alpha values associated with this Game Object.

Immediately sets the alpha levels back to 1 (fully opaque).

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.AlphaSingle#clearAlpha
Since: 3.0.0
Focus
Focus
Only webGL clearFX()
Focus
Focus

Description:

Removes all Pre and Post FX Controllers from this Game Object.

If you wish to remove a single controller, use the preFX.remove(fx) or postFX.remove(fx) methods instead.

If you wish to clear a single controller, use the preFX.clear() or postFX.clear() methods instead.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.Components.PostPipeline#clearFX
Since: 3.60.0
Focus
Focus
clearMask([destroyMask])
Focus
Focus

Description:

Clears the mask that this Game Object was using.

Parameters:

name type arguments Default description
destroyMask boolean <optional> false

Destroy the mask before clearing it?

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Mask#clearMask
Since: 3.6.2
Focus
Focus
Only webGL clearTint()
Focus
Focus

Description:

Clears all tint values associated with this Game Object.

Immediately sets the color values back to 0xffffff on all vertices, which results in no visible change to the texture.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Mesh#clearTint
Since: 3.60.0
Focus
Focus
copyPosition(source)
Focus
Focus

Description:

Copies an object's coordinates to this Game Object's position.

Parameters:

name type description
source Phaser.Types.Math.Vector2Like | Phaser.Types.Math.Vector3Like | Phaser.Types.Math.Vector4Like

An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#copyPosition
Since: 3.50.0
Focus
Focus
createBitmapMask([maskObject], [x], [y], [texture], [frame])
Focus
Focus

Description:

Creates and returns a Bitmap Mask. This mask can be used by any Game Object, including this one, or a Dynamic Texture.

Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.

To create the mask you need to pass in a reference to a renderable Game Object. A renderable Game Object is one that uses a texture to render with, such as an Image, Sprite, Render Texture or BitmapText.

If you do not provide a renderable object, and this Game Object has a texture, it will use itself as the object. This means you can call this method to create a Bitmap Mask from any renderable texture-based Game Object.

Parameters:

name type arguments description
maskObject Phaser.GameObjects.GameObject | Phaser.Textures.DynamicTexture <optional>

The Game Object or Dynamic Texture that will be used as the mask. If null it will generate an Image Game Object using the rest of the arguments.

x number <optional>

If creating a Game Object, the horizontal position in the world.

y number <optional>

If creating a Game Object, the vertical position in the world.

texture string | Phaser.Textures.Texture <optional>

If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.

frame string | number | Phaser.Textures.Frame <optional>

If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.

Returns:
Description:

This Bitmap Mask that was created.

Inherited from: Phaser.GameObjects.Components.Mask#createBitmapMask
Since: 3.6.2
Focus
Focus
createCheckerboard([color1], [color2], [alpha1], [alpha2], [height])
Focus
Focus

Description:

Creates a checkerboard style texture, based on the given colors and alpha values and applies it to this Plane, replacing any current texture it may have.

The colors are used in an alternating pattern, like a chess board.

Calling this method generates a brand new 16x16 pixel WebGLTexture internally and applies it to this Plane. While quite fast to do, you should still be mindful of calling this method either extensively, or in tight parts of your game.

Parameters:

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.

Since: 3.60.0
Focus
Focus
createGeometryMask([graphics])
Focus
Focus

Description:

Creates and returns a Geometry Mask. This mask can be used by any Game Object, including this one.

To create the mask you need to pass in a reference to a Graphics Game Object.

If you do not provide a graphics object, and this Game Object is an instance of a Graphics object, then it will use itself to create the mask.

This means you can call this method to create a Geometry Mask from any Graphics Game Object.

Parameters:

name type arguments description
graphics Phaser.GameObjects.Graphics | Phaser.GameObjects.Shape <optional>

A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.

Returns:
Description:

This Geometry Mask that was created.

Inherited from: Phaser.GameObjects.Components.Mask#createGeometryMask
Since: 3.6.2
Focus
Focus
depthSort()
Focus
Focus

Description:

Runs a depth sort across all Faces in this Mesh, comparing their averaged depth.

This is called automatically if you use any of the rotate methods, but you can also invoke it to sort the Faces should you manually position them.

Returns:
Description:

This Mesh Game Object.

Inherited from: Phaser.GameObjects.Mesh#depthSort
Since: 3.50.0
Focus
Focus
destroy([fromScene])
Focus
Focus

Description:

Destroys this Game Object removing it from the Display List and Update List and severing all ties to parent resources.

Also removes itself from the Input Manager and Physics Manager if previously enabled.

Use this to remove a Game Object from your game if you don't ever plan to use it again. As long as no reference to it exists within your own code it should become free for garbage collection by the browser.

If you just want to temporarily disable an object then look at using the Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.

Parameters:

name type arguments Default description
fromScene boolean <optional> false

True if this Game Object is being destroyed by the Scene, false if not.

Inherited from: Phaser.GameObjects.GameObject#destroy
Since: 3.0.0
Focus
Focus
disableInteractive()
Focus
Focus

Description:

If this Game Object has previously been enabled for input, this will disable it.

An object that is disabled for input stops processing or being considered for input events, but can be turned back on again at any time by simply calling setInteractive() with no arguments provided.

If want to completely remove interaction from this Game Object then use removeInteractive instead.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#disableInteractive
Since: 3.7.0
Focus
Focus
emit(event, [args])
Focus
Focus

Description:

Calls each of the listeners registered for a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

args * <optional>

Additional arguments that will be passed to the event handler.

Returns:
Description:

true if the event had listeners, else false.

Type:
  • boolean
Inherited from: Phaser.Events.EventEmitter#emit
Since: 3.0.0
Focus
Focus
eventNames()
Focus
Focus

Description:

Return an array listing the events for which the emitter has registered listeners.

Type:
  • Array.<(string
  • symbol)>
Inherited from: Phaser.Events.EventEmitter#eventNames
Since: 3.0.0
Focus
Focus
getData(key)
Focus
Focus

Description:

Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.

You can also access values via the values object. For example, if you had a key called gold you can do either:

sprite.getData('gold');

Or access the value directly:

sprite.data.values.gold;

You can also pass in an array of keys, in which case an array of values will be returned:

sprite.getData([ 'gold', 'armor', 'health' ]);

This approach is useful for destructuring arrays in ES6.

Parameters:

name type description
key string | Array.<string>

The key of the value to retrieve, or an array of keys.

Returns:
Description:

The value belonging to the given key, or an array of values, the order of which will match the input array.

Type:
  • *
Inherited from: Phaser.GameObjects.GameObject#getData
Since: 3.0.0
Focus
Focus
getFace(index)
Focus
Focus

Description:

Returns the Face at the given index in this Mesh Game Object.

Parameters:

name type description
index number

The index of the Face to get.

Returns:
Description:

The Face at the given index, or undefined if index out of range.

Inherited from: Phaser.GameObjects.Mesh#getFace
Since: 3.50.0
Focus
Focus
getFaceAt(x, y, [camera])
Focus
Focus

Description:

Return an array of Face objects from this Mesh that intersect with the given coordinates.

The given position is translated through the matrix of this Mesh and the given Camera, before being compared against the vertices.

If more than one Face intersects, they will all be returned in the array, but the array will be depth sorted first, so the first element will always be that closest to the camera.

Parameters:

name type arguments description
x number

The x position to check against.

y number

The y position to check against.

camera Phaser.Cameras.Scene2D.Camera <optional>

The camera to pass the coordinates through. If not give, the default Scene Camera is used.

Returns:
Description:

An array of Face objects that intersect with the given point, ordered by depth.

Type:
Inherited from: Phaser.GameObjects.Mesh#getFaceAt
Since: 3.50.0
Focus
Focus
getFaceCount()
Focus
Focus

Description:

Returns the total number of Faces in this Mesh Game Object.

Returns:
Description:

The number of Faces in this Mesh Game Object.

Type:
  • number
Inherited from: Phaser.GameObjects.Mesh#getFaceCount
Since: 3.50.0
Focus
Focus
getIndexList()
Focus
Focus

Description:

Returns an array containing the display list index of either this Game Object, or if it has one, its parent Container. It then iterates up through all of the parent containers until it hits the root of the display list (which is index 0 in the returned array).

Used internally by the InputPlugin but also useful if you wish to find out the display depth of this Game Object and all of its ancestors.

Returns:
Description:

An array of display list position indexes.

Type:
  • Array.<number>
Inherited from: Phaser.GameObjects.GameObject#getIndexList
Since: 3.4.0
Focus
Focus
getLocalPoint(x, y, [point], [camera])
Focus
Focus

Description:

Takes the given x and y coordinates and converts them into local space for this Game Object, taking into account parent and local transforms, and the Display Origin.

The returned Vector2 contains the translated point in its properties.

A Camera needs to be provided in order to handle modified scroll factors. If no camera is specified, it will use the main camera from the Scene to which this Game Object belongs.

Parameters:

name type arguments description
x number

The x position to translate.

y number

The y position to translate.

point Phaser.Math.Vector2 <optional>

A Vector2, or point-like object, to store the results in.

camera Phaser.Cameras.Scene2D.Camera <optional>

The Camera which is being tested against. If not given will use the Scene default camera.

Returns:
Description:

The translated point.

Inherited from: Phaser.GameObjects.Components.Transform#getLocalPoint
Since: 3.50.0
Focus
Focus
getLocalTransformMatrix([tempMatrix])
Focus
Focus

Description:

Gets the local transform matrix for this Game Object.

Parameters:

name type arguments description
tempMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

The matrix to populate with the values from this Game Object.

Returns:
Description:

The populated Transform Matrix.

Inherited from: Phaser.GameObjects.Components.Transform#getLocalTransformMatrix
Since: 3.4.0
Focus
Focus
getParentRotation()
Focus
Focus

Description:

Gets the sum total rotation of all of this Game Objects parent Containers.

The returned value is in radians and will be zero if this Game Object has no parent container.

Returns:
Description:

The sum total rotation, in radians, of all parent containers of this Game Object.

Type:
  • number
Inherited from: Phaser.GameObjects.Components.Transform#getParentRotation
Since: 3.18.0
Focus
Focus
Only webGL getPipelineName()
Focus
Focus

Description:

Gets the name of the WebGL Pipeline this Game Object is currently using.

Returns:
Description:

The string-based name of the pipeline being used by this Game Object.

Type:
  • string
Inherited from: Phaser.GameObjects.Components.Pipeline#getPipelineName
Since: 3.0.0
Focus
Focus
Only webGL getPostPipeline(pipeline)
Focus
Focus

Description:

Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.

Parameters:

name type description
pipeline string | function | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

The string-based name of the pipeline, or a pipeline class.

Returns:
Description:

An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.

Inherited from: Phaser.GameObjects.Components.PostPipeline#getPostPipeline
Since: 3.60.0
Focus
Focus
getVertexCount()
Focus
Focus

Description:

Returns the total number of Vertices in this Mesh Game Object.

Returns:
Description:

The number of Vertices in this Mesh Game Object.

Type:
  • number
Inherited from: Phaser.GameObjects.Mesh#getVertexCount
Since: 3.50.0
Focus
Focus
getWorldTransformMatrix([tempMatrix], [parentMatrix])
Focus
Focus

Description:

Gets the world transform matrix for this Game Object, factoring in any parent Containers.

Parameters:

name type arguments description
tempMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

The matrix to populate with the values from this Game Object.

parentMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

A temporary matrix to hold parent values during the calculations.

Returns:
Description:

The populated Transform Matrix.

Inherited from: Phaser.GameObjects.Components.Transform#getWorldTransformMatrix
Since: 3.4.0
Focus
Focus
hasFaceAt(x, y, [camera])
Focus
Focus

Description:

Tests to see if any face in this Mesh intersects with the given coordinates.

The given position is translated through the matrix of this Mesh and the given Camera, before being compared against the vertices.

Parameters:

name type arguments description
x number

The x position to check against.

y number

The y position to check against.

camera Phaser.Cameras.Scene2D.Camera <optional>

The camera to pass the coordinates through. If not give, the default Scene Camera is used.

Returns:
Description:

Returns true if any face of this Mesh intersects with the given coordinate, otherwise false.

Type:
  • boolean
Inherited from: Phaser.GameObjects.Mesh#hasFaceAt
Since: 3.60.0
Focus
Focus
incData(key, [data])
Focus
Focus

Description:

Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.

If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled before setting the value.

If the key doesn't already exist in the Data Manager then it is created.

When the value is first set, a setdata event is emitted from this Game Object.

Parameters:

name type arguments description
key string | object

The key to increase the value for.

data * <optional>

The value to increase for the given key.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#incData
Since: 3.23.0
Focus
Focus
Only webGL initPipeline([pipeline])
Focus
Focus

Description:

Sets the initial WebGL Pipeline of this Game Object.

This should only be called during the instantiation of the Game Object. After that, use setPipeline.

Parameters:

name type arguments description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline <optional>

Either the string-based name of the pipeline, or a pipeline instance to set.

Returns:
Description:

true if the pipeline was set successfully, otherwise false.

Type:
  • boolean
Inherited from: Phaser.GameObjects.Components.Pipeline#initPipeline
Since: 3.0.0
Focus
Focus
Only webGL initPostPipeline([preFX])
Focus
Focus

Description:

This should only be called during the instantiation of the Game Object.

It is called by default by all core Game Objects and doesn't need calling again.

After that, use setPostPipeline.

Parameters:

name type arguments Default description
preFX boolean <optional> false

Does this Game Object support Pre FX?

Inherited from: Phaser.GameObjects.Components.PostPipeline#initPostPipeline
Since: 3.60.0
Focus
Focus
isDirty()
Focus
Focus

Description:

Checks if the transformation data in this mesh is dirty.

This is used internally by the preUpdate step to determine if the vertices should be recalculated or not.

Returns:
Description:

Returns true if the data of this mesh is dirty, otherwise false.

Type:
  • boolean
Inherited from: Phaser.GameObjects.Mesh#isDirty
Since: 3.50.0
Focus
Focus
listenerCount(event)
Focus
Focus

Description:

Return the number of listeners listening to a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The number of listeners.

Type:
  • number
Inherited from: Phaser.Events.EventEmitter#listenerCount
Since: 3.0.0
Focus
Focus
listeners(event)
Focus
Focus

Description:

Return the listeners registered for a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The registered listeners.

Type:
  • Array.<function()>
Inherited from: Phaser.Events.EventEmitter#listeners
Since: 3.0.0
Focus
Focus
off(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#off
Since: 3.0.0
Focus
Focus
on(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#on
Since: 3.0.0
Focus
Focus
once(event, fn, [context])
Focus
Focus

Description:

Add a one-time listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#once
Since: 3.0.0
Focus
Focus
panX(v)
Focus
Focus

Description:

Translates the view position of this Mesh on the x axis by the given amount.

Parameters:

name type description
v number

The amount to pan by.

Inherited from: Phaser.GameObjects.Mesh#panX
Since: 3.50.0
Focus
Focus
panY(v)
Focus
Focus

Description:

Translates the view position of this Mesh on the y axis by the given amount.

Parameters:

name type description
v number

The amount to pan by.

Inherited from: Phaser.GameObjects.Mesh#panY
Since: 3.50.0
Focus
Focus
panZ(v)
Focus
Focus

Description:

Translates the view position of this Mesh on the z axis by the given amount.

As the default panZ value is 0, vertices with z=0 (the default) need special care or else they will not display as they are "behind" the camera.

Consider using mesh.panZ(mesh.height / (2 * Math.tan(Math.PI / 16))), which will interpret vertex geometry 1:1 with pixel geometry (or see setOrtho).

Parameters:

name type description
v number

The amount to pan by.

Inherited from: Phaser.GameObjects.Mesh#panZ
Since: 3.50.0
Focus
Focus
play(key, [ignoreIfPlaying])
Focus
Focus

Description:

Start playing the given animation on this Plane.

Animations in Phaser can either belong to the global Animation Manager, or specifically to this Plane.

The benefit of a global animation is that multiple Game Objects can all play the same animation, without having to duplicate the data. You can just create it once and then play it on any animating Game Object.

The following code shows how to create a global repeating animation. The animation will be created from all of the frames within the sprite sheet that was loaded with the key 'muybridge':

var config = {
    key: 'run',
    frames: 'muybridge',
    frameRate: 15,
    repeat: -1
};

//  This code should be run from within a Scene:
this.anims.create(config);

However, if you wish to create an animation that is unique to this Plane, and this Plane alone, you can call the Animation.create method instead. It accepts the exact same parameters as when creating a global animation, however the resulting data is kept locally in this Plane.

With the animation created, either globally or locally, you can now play it on this Plane:

const plane = this.add.plane(...);
plane.play('run');

Alternatively, if you wish to run it at a different frame rate for example, you can pass a config object instead:

const plane = this.add.plane(...);
plane.play({ key: 'run', frameRate: 24 });

When playing an animation on a Plane it will first check to see if it can find a matching key locally within the Plane. If it can, it will play the local animation. If not, it will then search the global Animation Manager and look for it there.

If you need a Plane to be able to play both local and global animations, make sure they don't have conflicting keys.

See the documentation for the PlayAnimationConfig config object for more details about this.

Also, see the documentation in the Animation Manager for further details on creating animations.

Parameters:

name type arguments Default description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

The string-based key of the animation to play, or an Animation instance, or a PlayAnimationConfig object.

ignoreIfPlaying boolean <optional> false

If an animation is already playing then ignore this call.

Returns:
Description:

This Game Object.

Since: 3.60.0
Focus
Focus
playAfterDelay(key, delay)
Focus
Focus

Description:

Waits for the specified delay, in milliseconds, then starts playback of the given animation.

If the animation also has a delay value set in its config, it will be added to the delay given here.

If an animation is already running and a new animation is given to this method, it will wait for the given delay before starting the new animation.

If no animation is currently running, the given one begins after the delay.

When playing an animation on a Game Object it will first check to see if it can find a matching key locally within the Game Object. If it can, it will play the local animation. If not, it will then search the global Animation Manager and look for it there.

Parameters:

name type description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

The string-based key of the animation to play, or an Animation instance, or a PlayAnimationConfig object.

delay number

The delay, in milliseconds, to wait before starting the animation playing.

Returns:
Description:

This Game Object.

Since: 3.60.0
Focus
Focus
playAfterRepeat(key, [repeatCount])
Focus
Focus

Description:

Waits for the current animation to complete the repeatCount number of repeat cycles, then starts playback of the given animation.

You can use this to ensure there are no harsh jumps between two sets of animations, i.e. going from an idle animation to a walking animation, by making them blend smoothly into each other.

If no animation is currently running, the given one will start immediately.

When playing an animation on a Game Object it will first check to see if it can find a matching key locally within the Game Object. If it can, it will play the local animation. If not, it will then search the global Animation Manager and look for it there.

Parameters:

name type arguments Default description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

The string-based key of the animation to play, or an Animation instance, or a PlayAnimationConfig object.

repeatCount number <optional> 1

How many times should the animation repeat before the next one starts?

Returns:
Description:

This Game Object.

Since: 3.60.0
Focus
Focus
playReverse(key, [ignoreIfPlaying])
Focus
Focus

Description:

Start playing the given animation on this Plane, in reverse.

Animations in Phaser can either belong to the global Animation Manager, or specifically to a Game Object.

The benefit of a global animation is that multiple Game Objects can all play the same animation, without having to duplicate the data. You can just create it once and then play it on any animating Game Object.

The following code shows how to create a global repeating animation. The animation will be created from all of the frames within the sprite sheet that was loaded with the key 'muybridge':

var config = {
    key: 'run',
    frames: 'muybridge',
    frameRate: 15,
    repeat: -1
};

//  This code should be run from within a Scene:
this.anims.create(config);

However, if you wish to create an animation that is unique to this Game Object, and this Game Object alone, you can call the Animation.create method instead. It accepts the exact same parameters as when creating a global animation, however the resulting data is kept locally in this Game Object.

With the animation created, either globally or locally, you can now play it on this Game Object:

const plane = this.add.plane(...);
plane.playReverse('run');

Alternatively, if you wish to run it at a different frame rate, for example, you can pass a config object instead:

const plane = this.add.plane(...);
plane.playReverse({ key: 'run', frameRate: 24 });

When playing an animation on a Game Object it will first check to see if it can find a matching key locally within the Game Object. If it can, it will play the local animation. If not, it will then search the global Animation Manager and look for it there.

If you need a Game Object to be able to play both local and global animations, make sure they don't have conflicting keys.

See the documentation for the PlayAnimationConfig config object for more details about this.

Also, see the documentation in the Animation Manager for further details on creating animations.

Parameters:

name type arguments Default description
key string | Phaser.Animations.Animation | Phaser.Types.Animations.PlayAnimationConfig

The string-based key of the animation to play, or an Animation instance, or a PlayAnimationConfig object.

ignoreIfPlaying boolean <optional> false

If an animation is already playing then ignore this call.

Returns:
Description:

This Game Object.

Since: 3.60.0
Focus
Focus
preDestroy([width], [height], [tile])
Focus
Focus

Description:

Modifies the layout of this Plane by adjusting the grid dimensions to the given width and height. The values are given in cells, not pixels.

The tile parameter allows you to control if the texture is tiled, or applied across the entire Plane? A tiled texture will repeat with one iteration per cell. A non-tiled texture will be applied across the whole Plane.

Note that if this Plane is using a single texture, not from a texture atlas or sprite sheet, then you can use the Plane.uvScale method to have much more fine-grained control over the texture tiling.

Parameters:

name type arguments Default description
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.

Overrides: Phaser.GameObjects.Mesh#preDestroy
Since: 3.60.0
Focus
Focus
<private> preDestroy([width], [height], [tile])
Focus
Focus

Description:

Handles the pre-destroy step for the Plane, which removes the vertices and debug callbacks.

Parameters:

name type arguments Default description
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.

Overrides: Phaser.GameObjects.Mesh#preDestroy
Since: 3.60.0
Focus
Focus
<protected> preUpdate(time, delta)
Focus
Focus

Description:

Runs the preUpdate for this Plane, which will check its Animation State, if one is playing, and refresh view / model matrices, if updated.

Parameters:

name type description
time number

The current timestamp.

delta number

The delta time, in ms, elapsed since the last frame.

Overrides: Phaser.GameObjects.Mesh#preUpdate
Since: 3.60.0
Focus
Focus
removeAllListeners([event])
Focus
Focus

Description:

Remove all listeners, or those of the specified event.

Parameters:

name type arguments description
event string | symbol <optional>

The event name.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeAllListeners
Since: 3.0.0
Focus
Focus
removeCheckerboard()
Focus
Focus

Description:

If this Plane has a Checkerboard Texture, this method will destroy it and reset the internal flag for it.

Since: 3.60.0
Focus
Focus
removeFromDisplayList()
Focus
Focus

Description:

Removes this Game Object from the Display List it is currently on.

A Game Object can only exist on one Display List at any given time, but may move freely removed and added back at a later stage.

You can query which list it is on by looking at the Phaser.GameObjects.GameObject#displayList property.

If a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarly disable it from rendering, consider using the setVisible method, instead.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.GameObject#removeFromDisplayList
Since: 3.53.0
Focus
Focus
removeFromUpdateList()
Focus
Focus

Description:

Removes this Game Object from the Scene's Update List.

When a Game Object is on the Update List, it will have its preUpdate method called every game frame. Calling this method will remove it from the list, preventing this.

Removing a Game Object from the Update List will stop most internal functions working. For example, removing a Sprite from the Update List will prevent it from being able to run animations.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.GameObject#removeFromUpdateList
Since: 3.53.0
Focus
Focus
removeInteractive()
Focus
Focus

Description:

If this Game Object has previously been enabled for input, this will queue it for removal, causing it to no longer be interactive. The removal happens on the next game step, it is not immediate.

The Interactive Object that was assigned to this Game Object will be destroyed, removed from the Input Manager and cleared from this Game Object.

If you wish to re-enable this Game Object at a later date you will need to re-create its InteractiveObject by calling setInteractive again.

If you wish to only temporarily stop an object from receiving input then use disableInteractive instead, as that toggles the interactive state, where-as this erases it completely.

If you wish to resize a hit area, don't remove and then set it as being interactive. Instead, access the hitarea object directly and resize the shape being used. I.e.: sprite.input.hitArea.setSize(width, height) (assuming the shape is a Rectangle, which it is by default.)

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#removeInteractive
Since: 3.7.0
Focus
Focus
removeListener(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeListener
Since: 3.0.0
Focus
Focus
Only webGL removePostPipeline(pipeline)
Focus
Focus

Description:

Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.

If you wish to remove all Post Pipelines use the resetPostPipeline method instead.

Parameters:

name type description
pipeline string | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

The string-based name of the pipeline, or a pipeline class.

Returns:
Description:

This Game Object.

Inherited from: Phaser.GameObjects.Components.PostPipeline#removePostPipeline
Since: 3.60.0
Focus
Focus
removedFromScene()
Focus
Focus

Description:

This callback is invoked when this Game Object is removed from a Scene.

Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to removed themselves from the Update List.

You can also listen for the REMOVED_FROM_SCENE event from this Game Object.

Inherited from: Phaser.GameObjects.GameObject#removedFromScene
Since: 3.50.0
Focus
Focus
<private> renderCanvas(renderer, src, camera)
Focus
Focus

Description:

This is a stub function for Mesh.Render. There is no Canvas renderer for Mesh objects.

Parameters:

name type description
renderer Phaser.Renderer.Canvas.CanvasRenderer

A reference to the current active Canvas renderer.

src Phaser.GameObjects.Mesh

The Game Object being rendered in this call.

camera Phaser.Cameras.Scene2D.Camera

The Camera that is rendering the Game Object.

Inherited from: Phaser.GameObjects.Mesh#renderCanvas
Since: 3.0.0
Focus
Focus
renderDebug(src, faces)
Focus
Focus

Description:

The built-in Mesh debug rendering method.

See Mesh.setDebug for more details.

Parameters:

name type description
src Phaser.GameObjects.Mesh

The Mesh object being rendered.

faces Array.<Phaser.Geom.Mesh.Face>

An array of Faces.

Inherited from: Phaser.GameObjects.Mesh#renderDebug
Since: 3.50.0
Focus
Focus
<private> renderWebGL(renderer, src, camera, parentMatrix)
Focus
Focus

Description:

Renders this Game Object with the WebGL Renderer to the given Camera. The object will not render if any of its renderFlags are set or it is being actively filtered out by the Camera. This method should not be called directly. It is a utility function of the Render module.

Parameters:

name type description
renderer Phaser.Renderer.WebGL.WebGLRenderer

A reference to the current active WebGL renderer.

src Phaser.GameObjects.Mesh

The Game Object being rendered in this call.

camera Phaser.Cameras.Scene2D.Camera

The Camera that is rendering the Game Object.

parentMatrix Phaser.GameObjects.Components.TransformMatrix

This transform matrix is defined if the game object is nested

Inherited from: Phaser.GameObjects.Mesh#renderWebGL
Overrides: Phaser.GameObjects.Mesh#renderWebGL
Since: 3.0.0
Focus
Focus
Only webGL resetPipeline([resetData])
Focus
Focus

Description:

Resets the WebGL Pipeline of this Game Object back to the default it was created with.

Parameters:

name type arguments Default description
resetData boolean <optional> false

Reset the pipelineData object to being an empty object?

Returns:
Description:

true if the pipeline was reset successfully, otherwise false.

Type:
  • boolean
Inherited from: Phaser.GameObjects.Components.Pipeline#resetPipeline
Since: 3.0.0
Focus
Focus
Only webGL resetPostPipeline([resetData])
Focus
Focus

Description:

Resets the WebGL Post Pipelines of this Game Object. It does this by calling the destroy method on each post pipeline and then clearing the local array.

Parameters:

name type arguments Default description
resetData boolean <optional> false

Reset the postPipelineData object to being an empty object?

Inherited from: Phaser.GameObjects.Components.PostPipeline#resetPostPipeline
Since: 3.60.0
Focus
Focus
rotateX()
Focus
Focus

Description:

The x rotation of the Model in 3D space, as specified in degrees.

If you need the value in radians use the modelRotation.x property directly.

Type:
  • number
Inherited from: Phaser.GameObjects.Mesh#rotateX
Since: 3.60.0
Focus
Focus
rotateY()
Focus
Focus

Description:

The y rotation of the Model in 3D space, as specified in degrees.

If you need the value in radians use the modelRotation.y property directly.

Type:
  • number
Inherited from: Phaser.GameObjects.Mesh#rotateY
Since: 3.60.0
Focus
Focus
rotateZ()
Focus
Focus

Description:

The z rotation of the Model in 3D space, as specified in degrees.

If you need the value in radians use the modelRotation.z property directly.

Type:
  • number
Inherited from: Phaser.GameObjects.Mesh#rotateZ
Since: 3.60.0
Focus
Focus
setActive(value)
Focus
Focus

Description:

Sets the active property of this Game Object and returns this Game Object for further chaining. A Game Object with its active property set to true will be updated by the Scenes UpdateList.

Parameters:

name type description
value boolean

True if this Game Object should be set as active, false if not.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#setActive
Since: 3.0.0
Focus
Focus
setAlpha([value])
Focus
Focus

Description:

Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

Parameters:

name type arguments Default description
value number <optional> 1

The alpha value applied across the whole Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.AlphaSingle#setAlpha
Since: 3.0.0
Focus
Focus
setAngle([degrees])
Focus
Focus

Description:

Sets the angle of this Game Object.

Parameters:

name type arguments description
degrees number <optional>

The rotation of this Game Object, in degrees.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#setAngle
Since: 3.0.0
Focus
Focus
setBlendMode(value)
Focus
Focus

Description:

Sets the Blend Mode being used by this Game Object.

This can be a const, such as Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)

Under WebGL only the following Blend Modes are available:

  • NORMAL
  • ADD
  • MULTIPLY
  • SCREEN
  • ERASE (only works when rendering to a framebuffer, like a Render Texture)

Canvas has more available depending on browser support.

You can also create your own custom Blend Modes in WebGL.

Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency in which blend modes are used.

Parameters:

name type description
value string | number | Phaser.BlendModes

The BlendMode value. Either a string, a CONST or a number.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.BlendMode#setBlendMode
Since: 3.0.0
Focus
Focus
setData(key, [data])
Focus
Focus

Description:

Allows you to store a key value pair within this Game Objects Data Manager.

If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled before setting the value.

If the key doesn't already exist in the Data Manager then it is created.

sprite.setData('name', 'Red Gem Stone');

You can also pass in an object of key value pairs as the first argument:

sprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });

To get a value back again you can call getData:

sprite.getData('gold');

Or you can access the value directly via the values property, where it works like any other variable:

sprite.data.values.gold += 50;

When the value is first set, a setdata event is emitted from this Game Object.

If the key already exists, a changedata event is emitted instead, along an event named after the key. For example, if you updated an existing key called PlayerLives then it would emit the event changedata-PlayerLives. These events will be emitted regardless if you use this method to set the value, or the direct values setter.

Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings. This means the keys gold and Gold are treated as two unique values within the Data Manager.

Parameters:

name type arguments description
key string | object

The key to set the value for. Or an object of key value pairs. If an object the data argument is ignored.

data * <optional>

The value to set for the given key. If an object is provided as the key this argument is ignored.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#setData
Since: 3.0.0
Focus
Focus
setDataEnabled()
Focus
Focus

Description:

Adds a Data Manager component to this Game Object.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#setDataEnabled
Since: 3.0.0
Focus
Focus
setDebug([graphic], [callback])
Focus
Focus

Description:

This method enables rendering of the Mesh vertices to the given Graphics instance.

If you enable this feature, you must call Graphics.clear() in your Scene update, otherwise the Graphics instance you provide to debug will fill-up with draw calls, eventually crashing the browser. This is not done automatically to allow you to debug draw multiple Mesh objects to a single Graphics instance.

The Mesh class has a built-in debug rendering callback Mesh.renderDebug, however you can also provide your own callback to be used instead. Do this by setting the callback parameter.

The callback is invoked once per render and sent the following parameters:

callback(src, faces)

src is the Mesh instance being debugged. faces is an array of the Faces that were rendered.

You can get the final drawn vertex position from a Face object like this:

let face = faces[i];

let x0 = face.vertex1.tx;
let y0 = face.vertex1.ty;
let x1 = face.vertex2.tx;
let y1 = face.vertex2.ty;
let x2 = face.vertex3.tx;
let y2 = face.vertex3.ty;

graphic.strokeTriangle(x0, y0, x1, y1, x2, y2);

If using your own callback you do not have to provide a Graphics instance to this method.

To disable debug rendering, to either your own callback or the built-in one, call this method with no arguments.

Parameters:

name type arguments description
graphic Phaser.GameObjects.Graphics <optional>

The Graphic instance to render to if using the built-in callback.

callback function <optional>

The callback to invoke during debug render. Leave as undefined to use the built-in callback.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Mesh#setDebug
Since: 3.50.0
Focus
Focus
setDepth(value)
Focus
Focus

Description:

The depth of this Game Object within the Scene.

The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.

The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.

Setting the depth will queue a depth sort event within the Scene.

Parameters:

name type description
value number

The depth of this Game Object. Ensure this value is only ever a number data-type.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Depth#setDepth
Since: 3.0.0
Focus
Focus
setDisplaySize(width, height)
Focus
Focus

Description:

Sets the display size of this Game Object.

Calling this will adjust the scale.

Parameters:

name type description
width number

The width of this Game Object.

height number

The height of this Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Size#setDisplaySize
Since: 3.0.0
Focus
Focus
setFrame(frame, [updateSize], [updateOrigin])
Focus
Focus

Description:

Sets the frame this Game Object will use to render with.

If you pass a string or index then the Frame has to belong to the current Texture being used by this Game Object.

If you pass a Frame instance, then the Texture being used by this Game Object will also be updated.

Calling setFrame will modify the width and height properties of your Game Object.

It will also change the origin if the Frame has a custom pivot point, as exported from packages like Texture Packer.

Parameters:

name type arguments Default description
frame string | number | Phaser.Textures.Frame

The name or index of the frame within the Texture, or a Frame instance.

updateSize boolean <optional> true

Should this call adjust the size of the Game Object?

updateOrigin boolean <optional> true

Should this call adjust the origin of the Game Object?

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Texture#setFrame
Since: 3.0.0
Focus
Focus
setInteractive()
Focus
Focus

Description:

Pass this Mesh Game Object to the Input Manager to enable it for Input.

Unlike other Game Objects, the Mesh Game Object uses its own special hit area callback, which you cannot override.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.Mesh#setInteractive
Examples:
mesh.setInteractive();
Since: 3.60.0
Focus
Focus
setMask(mask)
Focus
Focus

Description:

Sets the mask that this Game Object will use to render with.

The mask must have been previously created and can be either a GeometryMask or a BitmapMask. Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.

If a mask is already set on this Game Object it will be immediately replaced.

Masks are positioned in global space and are not relative to the Game Object to which they are applied. The reason for this is that multiple Game Objects can all share the same mask.

Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.

Parameters:

name type description
mask Phaser.Display.Masks.BitmapMask | Phaser.Display.Masks.GeometryMask

The mask this Game Object will use when rendering.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Mask#setMask
Since: 3.6.2
Focus
Focus
setName(value)
Focus
Focus

Description:

Sets the name property of this Game Object and returns this Game Object for further chaining. The name property is not populated by Phaser and is presented for your own use.

Parameters:

name type description
value string

The name to be given to this Game Object.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#setName
Since: 3.0.0
Focus
Focus
setOrtho([scaleX], [scaleY], [near], [far])
Focus
Focus

Description:

Builds a new orthographic projection matrix from the given values.

If using this mode you will often need to set Mesh.hideCCW to false as well.

By default, calling this method with no parameters will set the scaleX value to match the renderer's aspect ratio. If you would like to render vertex positions 1:1 to pixel positions, consider calling as mesh.setOrtho(mesh.width, mesh.height).

See also setPerspective.

Parameters:

name type arguments Default description
scaleX number <optional> 1

The default horizontal scale in relation to the Mesh / Renderer dimensions.

scaleY number <optional> 1

The default vertical scale in relation to the Mesh / Renderer dimensions.

near number <optional> -1000

The near value of the view.

far number <optional> 1000

The far value of the view.

Inherited from: Phaser.GameObjects.Mesh#setOrtho
Since: 3.50.0
Focus
Focus
setPerspective(width, height, [fov], [near], [far])
Focus
Focus

Description:

Builds a new perspective projection matrix from the given values.

These are also the initial projection matrix and parameters for Mesh (see Mesh.panZ for more discussion).

See also setOrtho.

Parameters:

name type arguments Default description
width number

The width of the projection matrix. Typically the same as the Mesh and/or Renderer.

height number

The height of the projection matrix. Typically the same as the Mesh and/or Renderer.

fov number <optional> 45

The field of view, in degrees.

near number <optional> 0.01

The near value of the view.

far number <optional> 1000

The far value of the view.

Inherited from: Phaser.GameObjects.Mesh#setPerspective
Since: 3.50.0
Focus
Focus
Only webGL setPipeline(pipeline, [pipelineData], [copyData])
Focus
Focus

Description:

Sets the main WebGL Pipeline of this Game Object.

Also sets the pipelineData property, if the parameter is given.

Parameters:

name type arguments Default description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline

Either the string-based name of the pipeline, or a pipeline instance to set.

pipelineData object <optional>

Optional pipeline data object that is set in to the pipelineData property of this Game Object.

copyData boolean <optional> true

Should the pipeline data object be deep copied into the pipelineData property of this Game Object? If false it will be set by reference instead.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Pipeline#setPipeline
Since: 3.0.0
Focus
Focus
Only webGL setPipelineData(key, [value])
Focus
Focus

Description:

Adds an entry to the pipelineData object belonging to this Game Object.

If the 'key' already exists, its value is updated. If it doesn't exist, it is created.

If value is undefined, and key exists, key is removed from the data object.

Parameters:

name type arguments description
key string

The key of the pipeline data to set, update, or delete.

value any <optional>

The value to be set with the key. If undefined then key will be deleted from the object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Pipeline#setPipelineData
Since: 3.50.0
Focus
Focus
setPosition([x], [y], [z], [w])
Focus
Focus

Description:

Sets the position of this Game Object.

Parameters:

name type arguments Default description
x number <optional> 0

The x position of this Game Object.

y number <optional> x

The y position of this Game Object. If not set it will use the x value.

z number <optional> 0

The z position of this Game Object.

w number <optional> 0

The w position of this Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#setPosition
Since: 3.0.0
Focus
Focus
Only webGL setPostPipeline(pipelines, [pipelineData], [copyData])
Focus
Focus

Description:

Sets one, or more, Post Pipelines on this Game Object.

Post Pipelines are invoked after this Game Object has rendered to its target and are commonly used for post-fx.

The post pipelines are appended to the postPipelines array belonging to this Game Object. When the renderer processes this Game Object, it iterates through the post pipelines in the order in which they appear in the array. If you are stacking together multiple effects, be aware that the order is important.

If you call this method multiple times, the new pipelines will be appended to any existing post pipelines already set. Use the resetPostPipeline method to clear them first, if required.

You can optionally also set the postPipelineData property, if the parameter is given.

Parameters:

name type arguments Default description
pipelines string | Array.<string> | function | Array.<function()> | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>

Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.

pipelineData object <optional>

Optional pipeline data object that is set in to the postPipelineData property of this Game Object.

copyData boolean <optional> true

Should the pipeline data object be deep copied into the postPipelineData property of this Game Object? If false it will be set by reference instead.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.PostPipeline#setPostPipeline
Since: 3.60.0
Focus
Focus
Only webGL setPostPipelineData(key, [value])
Focus
Focus

Description:

Adds an entry to the postPipelineData object belonging to this Game Object.

If the 'key' already exists, its value is updated. If it doesn't exist, it is created.

If value is undefined, and key exists, key is removed from the data object.

Parameters:

name type arguments description
key string

The key of the pipeline data to set, update, or delete.

value any <optional>

The value to be set with the key. If undefined then key will be deleted from the object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.PostPipeline#setPostPipelineData
Since: 3.60.0
Focus
Focus
setRandomPosition([x], [y], [width], [height])
Focus
Focus

Description:

Sets the position of this Game Object to be a random position within the confines of the given area.

If no area is specified a random position between 0 x 0 and the game width x height is used instead.

The position does not factor in the size of this Game Object, meaning that only the origin is guaranteed to be within the area.

Parameters:

name type arguments description
x number <optional>

The x position of the top-left of the random area.

y number <optional>

The y position of the top-left of the random area.

width number <optional>

The width of the random area.

height number <optional>

The height of the random area.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#setRandomPosition
Since: 3.8.0
Focus
Focus
setRotation([radians])
Focus
Focus

Description:

Sets the rotation of this Game Object.

Parameters:

name type arguments description
radians number <optional>

The rotation of this Game Object, in radians.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#setRotation
Since: 3.0.0
Focus
Focus
setScale([x], [y])
Focus
Focus

Description:

Sets the scale of this Game Object.

Parameters:

name type arguments Default description
x number <optional> 1

The horizontal scale of this Game Object.

y number <optional> x

The vertical scale of this Game Object. If not set it will use the x value.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Transform#setScale
Since: 3.0.0
Focus
Focus
setScrollFactor(x, [y])
Focus
Focus

Description:

Sets the scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.

Parameters:

name type arguments Default description
x number

The horizontal scroll factor of this Game Object.

y number <optional> x

The vertical scroll factor of this Game Object. If not set it will use the x value.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.ScrollFactor#setScrollFactor
Since: 3.0.0
Focus
Focus
setSize(width, height)
Focus
Focus

Description:

Sets the internal size of this Game Object, as used for frame or physics body creation.

This will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or call the setDisplaySize method, which is the same thing as changing the scale but allows you to do so by giving pixel values.

If you have enabled this Game Object for input, changing the size will not change the size of the hit area. To do this you should adjust the input.hitArea object directly.

Parameters:

name type description
width number

The width of this Game Object.

height number

The height of this Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Size#setSize
Since: 3.0.0
Focus
Focus
setSizeToFrame([resetUV])
Focus
Focus

Description:

An internal method that resets the perspective projection for this Plane when it changes texture or frame, and also resets the cell UV coordinates, if required.

Parameters:

name type arguments Default description
resetUV boolean <optional> true

Reset all of the cell UV coordinates?

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Size#setSizeToFrame
Overrides: Phaser.GameObjects.Mesh#setSizeToFrame
Since: 3.60.0
Focus
Focus
setState(value)
Focus
Focus

Description:

Sets the current state of this Game Object.

Phaser itself will never modify the State of a Game Object, although plugins may do so.

For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'. The state value should typically be an integer (ideally mapped to a constant in your game code), but could also be a string. It is recommended to keep it light and simple. If you need to store complex data about your Game Object, look at using the Data Component instead.

Parameters:

name type description
value number | string

The state of the Game Object.

Returns:
Description:

This GameObject.

Inherited from: Phaser.GameObjects.GameObject#setState
Since: 3.16.0
Focus
Focus
setTexture(key, [frame])
Focus
Focus

Description:

Sets the texture and frame this Game Object will use to render with.

Textures are referenced by their string-based keys, as stored in the Texture Manager.

Parameters:

name type arguments description
key string | Phaser.Textures.Texture

The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.

frame string | number <optional>

The name or index of the frame within the Texture.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Texture#setTexture
Since: 3.0.0
Focus
Focus
Only webGL setTint([tint])
Focus
Focus

Description:

Sets an additive tint on all vertices of this Mesh Game Object.

The tint works by taking the pixel color values from the Game Objects texture, and then multiplying it by the color value of the tint.

To modify the tint color once set, either call this method again with new values or use the tint property to set all colors at once.

To remove a tint call clearTint.

Parameters:

name type arguments Default description
tint number <optional> 0xffffff

The tint being applied to all vertices of this Mesh Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Mesh#setTint
Since: 3.60.0
Focus
Focus
setViewHeight([value])
Focus
Focus

Description:

Sets the height of this Plane to match the given value, in pixels.

This adjusts the Plane.viewPosition.z value to achieve this.

If no value parameter is given, it will set the view height to match that of the current texture frame the Plane is using.

Parameters:

name type arguments description
value number <optional>

The height, in pixels, to set this Plane view height to.

Since: 3.60.0
Focus
Focus
setVisible(value)
Focus
Focus

Description:

Sets the visibility of this Game Object.

An invisible Game Object will skip rendering, but will still process update logic.

Parameters:

name type description
value boolean

The visible state of the Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Visible#setVisible
Since: 3.0.0
Focus
Focus
setW([value])
Focus
Focus

Description:

Sets the w position of this Game Object.

Parameters:

name type arguments description
value number <optional>

The w position of this Game Object.

Returns:
Description:

This Game Object instance.

Inherited from: