Phaser API Documentation

  Version: 
Filter

A Layer Game Object.

A Layer is a special type of Game Object that acts as a Display List. You can add any type of Game Object to a Layer, just as you would to a Scene. Layers can be used to visually group together 'layers' of Game Objects:

const spaceman = this.add.sprite(150, 300, 'spaceman');
const bunny = this.add.sprite(400, 300, 'bunny');
const elephant = this.add.sprite(650, 300, 'elephant');

const layer = this.add.layer();

layer.add([ spaceman, bunny, elephant ]);

The 3 sprites in the example above will now be managed by the Layer they were added to. Therefore, if you then set layer.setVisible(false) they would all vanish from the display.

You can also control the depth of the Game Objects within the Layer. For example, calling the setDepth method of a child of a Layer will allow you to adjust the depth of that child within the Layer itself, rather than the whole Scene. The Layer, too, can have its depth set as well.

The Layer class also offers many different methods for manipulating the list, such as the methods moveUp, moveDown, sendToBack, bringToTop and so on. These allow you to change the display list position of the Layers children, causing it to adjust the order in which they are rendered. Using setDepth on a child allows you to override this.

Layers can have Post FX Pipelines set, which allows you to easily enable a post pipeline across a whole range of children, which, depending on the effect, can often be far more efficient that doing so on a per-child basis.

Layers have no position or size within the Scene. This means you cannot enable a Layer for physics or input, or change the position, rotation or scale of a Layer. They also have no scroll factor, texture, tint, origin, crop or bounds.

If you need those kind of features then you should use a Container instead. Containers can be added to Layers, but Layers cannot be added to Containers.

However, you can set the Alpha, Blend Mode, Depth, Mask and Visible state of a Layer. These settings will impact all children being rendered by the Layer.

Constructor:

new Layer(scene, [children])

Parameters:

name type arguments description
scene Phaser.Scene

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

children Array.<Phaser.GameObjects.GameObject> <optional>

An optional array of Game Objects to add to this Layer.

Since: 3.50.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> _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> _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
Since: 3.50.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
blendMode: string | 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:

  • 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:
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:

This property is kept purely so a Layer has the same shape as a Game Object. You cannot give a Layer a physics body.

Type:
Default: null
Since: 3.51.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
Since: 3.50.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
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.

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

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
Since: 3.50.0
Focus
Focus

Description:

A reference to the Scene Event Emitter.

Type:
Since: 3.50.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.Pipeline#hasPostPipeline
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
Since: 3.50.0
Focus
Focus

Description:

This property is kept purely so a Layer has the same shape as a Game Object. You cannot input enable a Layer.

Type:
Default: null
Since: 3.51.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: ''
Since: 3.50.0
Focus
Focus
parentContainer: Phaser.GameObjects.Container
Focus
Focus

Description:

A Layer cannot be placed inside a Container.

This property is kept purely so a Layer has the same shape as a Game Object.

Type:
Since: 3.51.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
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.Pipeline#postPipelines
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
Since: 3.50.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:
Since: 3.50.0
Focus
Focus
sortChildrenFlag: boolean
Focus
Focus

Description:

The flag the determines whether Game Objects should be sorted when depthSort() is called.

Type:
boolean
Default: false
Since: 3.50.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
Since: 3.50.0
Focus
Focus

Description:

A reference to the Scene Systems.

Type:
Since: 3.50.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
Since: 3.51.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
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

Methods

<private> addChildCallback(gameObject)
Focus
Focus

Description:

Internal method called from List.addCallback.

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was added to the list.

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.

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
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
createBitmapMask([renderable])
Focus
Focus

Description:

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

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 Game Object.

Parameters:

name type arguments description
renderable Phaser.GameObjects.GameObject <optional>

A renderable Game Object that uses a texture, such as a Sprite.

Returns:
Description:

This Bitmap Mask that was created.

Inherited from: Phaser.GameObjects.Components.Mask#createBitmapMask
Since: 3.6.2
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 <optional>

A Graphics 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:

Immediately sorts the display list if the flag is set.

Since: 3.50.0
Focus
Focus
destroy()
Focus
Focus

Description:

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

Also destroys all children of this Layer. If you do not wish for the children to be destroyed, you should move them from this Layer first.

Use this to remove this Layer 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.

Since: 3.50.0
Focus
Focus
disableInteractive()
Focus
Focus

Description:

A Layer cannot be enabled for input.

This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.

Returns:
Description:

This GameObject.

Since: 3.51.0
Focus
Focus
getChildren()
Focus
Focus

Description:

Returns an array which contains all Game Objects within this Layer.

This is a reference to the main list array, not a copy of it, so be careful not to modify it.

Returns:
Description:

The group members.

Since: 3.50.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:
  • *
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>
Since: 3.51.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:

The Post Pipeline/s matching the name, or undefined if no match. If more than one match they are returned in an array.

Inherited from: Phaser.GameObjects.Components.Pipeline#getPostPipeline
Since: 3.50.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.

Since: 3.50.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 description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline

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
queueDepthSort()
Focus
Focus

Description:

Force a sort of the display list on the next call to depthSort.

Since: 3.50.0
Focus
Focus
<private> removeChildCallback(gameObject)
Focus
Focus

Description:

Internal method called from List.removeCallback.

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was removed from the list.

Since: 3.50.0
Focus
Focus
removeInteractive()
Focus
Focus

Description:

A Layer cannot be enabled for input.

This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.

Returns:
Description:

This GameObject.

Since: 3.51.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.Pipeline#removePostPipeline
Since: 3.50.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.

Since: 3.50.0
Focus
Focus
<private> renderCanvas(renderer, layer, camera, parentMatrix)
Focus
Focus

Description:

Renders this Game Object with the Canvas 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.Canvas.CanvasRenderer

A reference to the current active Canvas renderer.

layer Phaser.GameObjects.Layer

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

Since: 3.50.0
Focus
Focus
<private> renderWebGL(renderer, layer, camera)
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.

layer Phaser.GameObjects.Layer

The Game Object being rendered in this call.

camera Phaser.Cameras.Scene2D.Camera

The Camera that is rendering the Game Object.

Since: 3.50.0
Focus
Focus
Only webGL resetPipeline([resetPostPipelines], [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
resetPostPipelines boolean <optional> false

Reset all of the post pipelines?

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 pipelineData object to being an empty object?

Inherited from: Phaser.GameObjects.Components.Pipeline#resetPostPipeline
Since: 3.50.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.

Since: 3.50.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
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:

  • 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 | Phaser.BlendModes

The BlendMode value. Either a string or a CONST.

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.

Since: 3.50.0
Focus
Focus
setDataEnabled()
Focus
Focus

Description:

Adds a Data Manager component to this Game Object.

Returns:
Description:

This GameObject.

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.

Returns:
Description:

This Game Object instance.

Inherited from: Phaser.GameObjects.Components.Depth#setDepth
Since: 3.0.0
Focus
Focus
setInteractive()
Focus
Focus

Description:

A Layer cannot be enabled for input.

This method does nothing and is kept to ensure the Layer has the same shape as a Game Object.

Returns:
Description:

This GameObject.

Since: 3.51.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.

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.

Both the pipeline and post pipelines share the same pipeline data object.

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 deep copied into 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.

Both the pipeline and post pipelines share the pipeline data object together.

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
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 sets the pipelineData property, if the parameter is given.

Both the pipeline and post pipelines share the pipeline data object together.

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 deep copied into 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#setPostPipeline
Since: 3.50.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.

Since: 3.50.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
sortByDepth(childA, childB)
Focus
Focus

Description:

Compare the depth of two Game Objects.

Parameters:

name type description
childA Phaser.GameObjects.GameObject

The first Game Object.

childB Phaser.GameObjects.GameObject

The second Game Object.

Returns:
Description:

The difference between the depths of each Game Object.

Type:
  • number
Since: 3.50.0
Focus
Focus
toJSON()
Focus
Focus

Description:

Returns a JSON representation of the Game Object.

Returns:
Description:

A JSON representation of the Game Object.

Since: 3.50.0
Focus
Focus
toggleData(key)
Focus
Focus

Description:

Toggle a boolean 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 toggled from false.

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 description
key string | object

The key to toggle the value for.

Returns:
Description:

This GameObject.

Since: 3.50.0
Focus
Focus
update([args])
Focus
Focus

Description:

To be overridden by custom GameObjects. Allows base objects to be used in a Pool.

Parameters:

name type arguments description
args * <optional>

args

Since: 3.50.0
Focus
Focus
willRender(camera)
Focus
Focus

Description:

Compares the renderMask with the renderFlags to see if this Game Object will render or not. Also checks the Game Object against the given Cameras exclusion list.

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The Camera to check against this Game Object.

Returns:
Description:

True if the Game Object should be rendered, otherwise false.

Type:
  • boolean
Since: 3.50.0
Focus
Focus