Deprecated: Phaser 3 API Documentation - Class: GameObjectFactory

Static method called directly by the Game Object factory functions. With this method you can register a custom GameObject factory in the GameObjectFactory, providing a name (factoryType) and the constructor (factoryFunction) in order to be called when you call to Phaser.Scene.add[ factoryType ] method.

Parameters:

Name	Type	Description
`factoryType`	string	The key of the factory that you will use to call to Phaser.Scene.add[ factoryType ] method.
`factoryFunction`	function	The constructor function to be called when you invoke to the Phaser.Scene.add method.

Since: 3.0.0
Source: src/gameobjects/GameObjectFactory.js (Line 185)

<static> remove(factoryType)

Static method called directly by the Game Object factory functions. With this method you can remove a custom GameObject factory registered in the GameObjectFactory, providing a its factoryType.

Parameters:

Name	Type	Description
`factoryType`	string	The key of the factory that you want to remove from the GameObjectFactory.

Since: 3.0.0
Source: src/gameobjects/GameObjectFactory.js (Line 206)

arc( [x] [, y] [, radius] [, startAngle] [, endAngle] [, anticlockwise] [, fillColor] [, fillAlpha])

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

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

The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

When it renders it displays an arc shape. You can control the start and end angles of the arc, as well as if the angles are winding clockwise or anti-clockwise. With the default settings it renders as a complete circle. By changing the angles you can create other arc shapes, such as half-circles.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`radius`	number	<optional>	128	The radius of the arc.
`startAngle`	number	<optional>	0	The start angle of the arc, in degrees.
`endAngle`	number	<optional>	360	The end angle of the arc, in degrees.
`anticlockwise`	boolean	<optional>	false	The winding order of the start and end angles.
`fillColor`	number	<optional>		The color the arc will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/arc/ArcFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Arc

bitmapText(x, y, font [, text] [, size] [, align])

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

BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.

During rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to match the font structure.

BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by processing the font texture in an image editor, applying fills and any other effects required.

To create multi-line text insert \r, \n or \r\n escape codes into the text string.

To create a BitmapText data files you need a 3rd party app such as:

BMFont (Windows, free): http://www.angelcode.com/products/bmfont/ Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner Littera (Web-based, free): http://kvazars.com/littera/

For most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of converting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson

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

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The x position of the Game Object.
`y`	number			The y position of the Game Object.
`font`	string			The key of the font to use from the BitmapFont cache.
`text`	string \| Array.<string>	<optional>		The string, or array of strings, to be set as the content of this Bitmap Text.
`size`	number	<optional>		The font size to set.
`align`	number	<optional>	0	The alignment of the text in a multi-line BitmapText object.

Since: 3.0.0
Source: src/gameobjects/bitmaptext/static/BitmapTextFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.BitmapText

blitter(x, y, key [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The x position of the Game Object.
`y`	number		The y position of the Game Object.
`key`	string		The key of the Texture the Blitter object will use.
`frame`	string \| number	<optional>	The default Frame children of the Blitter will use.

Since: 3.0.0
Source: src/gameobjects/blitter/BlitterFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Blitter

circle( [x] [, y] [, radius] [, fillColor] [, fillAlpha])

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

A Circle is an Arc with no defined start and end angle, making it render as a complete circle.

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

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`radius`	number	<optional>	128	The radius of the circle.
`fillColor`	number	<optional>		The color the circle will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the circle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/arc/ArcFactory.js (Line 46)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Arc

container( [x] [, y] [, children])

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

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

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`children`	Phaser.GameObjects.GameObject \| Array.<Phaser.GameObjects.GameObject>	<optional>		An optional array of Game Objects to add to this Container.

Since: 3.4.0
Source: src/gameobjects/container/ContainerFactory.js (Line 11)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Container

curve( [x] [, y] [, curve] [, fillColor] [, fillAlpha])

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

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

The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

To render a Curve Shape you must first create a Phaser.Curves.Curve object, then pass it to the Curve Shape in the constructor.

The Curve shape also has a smoothness property and corresponding setSmoothness method. This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations that take place during construction. Increase and decrease the default value for smoother, or more jagged, shapes.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`curve`	Phaser.Curves.Curve	<optional>		The Curve object to use to create the Shape.
`fillColor`	number	<optional>		The color the curve will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/curve/CurveFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Curve

dom(x, y [, element] [, style] [, innerText])

DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.

In order for DOM Elements to display you have to enable them by adding the following to your game configuration object:

dom {
  createContainer: true
}

When this is added, Phaser will automatically create a DOM Container div that is positioned over the top of the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of settings within the Scale Manager, the dom container is resized accordingly.

You can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing Element that you wish to be placed under the control of Phaser. For example:

this.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');

The above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in the 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case, it will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.

You should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control alignment and positioning of the elements next to regular game content.

Rather than specify the CSS and HTML directly you can use the load.html File Loader to load it into the cache and then use the createFromCache method instead. You can also use createFromHTML and various other methods available in this class to help construct your elements.

Once the element has been created you can then control it like you would any other Game Object. You can set its position, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped at the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that they appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have a DOM Element, then a Sprite, then another DOM Element behind it.

They also cannot be enabled for input. To do that, you have to use the addListener method to add native event listeners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas entirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you change the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.

Also, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.

DOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert a login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table. Or a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and UI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top of your game, and should treat it accordingly.

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this DOM Element in the world.
`y`	number		The vertical position of this DOM Element in the world.
`element`	HTMLElement \| string	<optional>	An existing DOM element, or a string. If a string starting with a # it will do a `getElementById` look-up on the string (minus the hash). Without a hash, it represents the type of element to create, i.e. 'div'.
`style`	string \| any	<optional>	If a string, will be set directly as the elements `style` property value. If a plain object, will be iterated and the values transferred. In both cases the values replacing whatever CSS styles may have been previously set.
`innerText`	string	<optional>	If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.

Since: 3.17.0
Source: src/gameobjects/domelement/DOMElementFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.DOMElement

dynamicBitmapText(x, y, font [, text] [, size])

Creates a new Dynamic Bitmap Text Game Object and adds it to the Scene.

BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.

During rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to match the font structure.

Dynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each letter being rendered during the render pass. This callback allows you to manipulate the properties of each letter being rendered, such as its position, scale or tint, allowing you to create interesting effects like jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing time, so only use them if you require the callback ability they have.

To create multi-line text insert \r, \n or \r\n escape codes into the text string.

To create a BitmapText data files you need a 3rd party app such as:

BMFont (Windows, free): http://www.angelcode.com/products/bmfont/ Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner Littera (Web-based, free): http://kvazars.com/littera/

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

Parameters:

Name	Type	Argument	Description
`x`	number		The x position of the Game Object.
`y`	number		The y position of the Game Object.
`font`	string		The key of the font to use from the BitmapFont cache.
`text`	string \| Array.<string>	<optional>	The string, or array of strings, to be set as the content of this Bitmap Text.
`size`	number	<optional>	The font size to set.

Since: 3.0.0
Source: src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.DynamicBitmapText

ellipse( [x] [, y] [, width] [, height] [, fillColor] [, fillAlpha])

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

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

The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

When it renders it displays an ellipse shape. You can control the width and height of the ellipse. If the width and height match it will render as a circle. If the width is less than the height, it will look more like an egg shape.

The Ellipse shape also has a smoothness property and corresponding setSmoothness method. This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations that take place during construction. Increase and decrease the default value for smoother, or more jagged, shapes.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`width`	number	<optional>	128	The width of the ellipse. An ellipse with equal width and height renders as a circle.
`height`	number	<optional>	128	The height of the ellipse. An ellipse with equal width and height renders as a circle.
`fillColor`	number	<optional>		The color the ellipse will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/ellipse/EllipseFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Ellipse

existing(child)

Adds an existing Game Object to this Scene.

If the Game Object renders, it will be added to the Display List. If it has a preUpdate method, it will be added to the Update List.

Parameters:

Name	Type	Description
`child`	Phaser.GameObjects.GameObject \| Phaser.GameObjects.Group	The child to be added to this Scene.

Since: 3.0.0
Source: src/gameobjects/GameObjectFactory.js (Line 116)

Returns:

The Game Object that was added.

Type: Phaser.GameObjects.GameObject

extern()

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

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

Since: 3.16.0
Source: src/gameobjects/extern/ExternFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Extern

follower(path, x, y, texture [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`path`	Phaser.Curves.Path		The Path this PathFollower is connected to.
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`texture`	string \| Phaser.Textures.Texture		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: src/gameobjects/pathfollower/PathFollowerFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.PathFollower

graphics( [config])

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

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

Parameters:

Name	Type	Argument	Description
`config`	Phaser.Types.GameObjects.Graphics.Options	<optional>	The Graphics configuration.

Since: 3.0.0
Source: src/gameobjects/graphics/GraphicsFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Graphics

grid( [x] [, y] [, width] [, height] [, cellWidth] [, cellHeight] [, fillColor] [, fillAlpha] [, outlineFillColor] [, outlineFillAlpha])

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

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

The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports only fill colors and cannot be stroked.

A Grid Shape allows you to display a grid in your game, where you can control the size of the grid as well as the width and height of the grid cells. You can set a fill color for each grid cell as well as an alternate fill color. When the alternate fill color is set then the grid cells will alternate the fill colors as they render, creating a chess-board effect. You can also optionally have an outline fill color. If set, this draws lines between the grid cells in the given color. If you specify an outline color with an alpha of zero, then it will draw the cells spaced out, but without the lines between them.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`width`	number	<optional>	128	The width of the grid.
`height`	number	<optional>	128	The height of the grid.
`cellWidth`	number	<optional>	32	The width of one cell in the grid.
`cellHeight`	number	<optional>	32	The height of one cell in the grid.
`fillColor`	number	<optional>		The color the grid cells will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.
`outlineFillColor`	number	<optional>		The color of the lines between the grid cells.
`outlineFillAlpha`	number	<optional>		The alpha of the lines between the grid cells.

Since: 3.13.0
Source: src/gameobjects/shape/grid/GridFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Grid

group( [children] [, config])

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

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

Parameters:

Name	Type	Argument	Description
`children`	Array.<Phaser.GameObjects.GameObject> \| Phaser.Types.GameObjects.Group.GroupConfig \| Array.<Phaser.Types.GameObjects.Group.GroupConfig>	<optional>	Game Objects to add to this Group; or the `config` argument.
`config`	Phaser.Types.GameObjects.Group.GroupConfig \| Phaser.Types.GameObjects.Group.GroupCreateConfig	<optional>	A Group Configuration object.

Since: 3.0.0
Source: src/gameobjects/group/GroupFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Group

image(x, y, texture [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`texture`	string \| Phaser.Textures.Texture		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: src/gameobjects/image/ImageFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Image

isobox( [x] [, y] [, size] [, height] [, fillTop] [, fillLeft] [, fillRight])

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

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

The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports only fill colors and cannot be stroked.

An IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set the color of the top, left and right faces of the rectangle respectively. You can also choose which of the faces are rendered via the showTop, showLeft and showRight properties.

You cannot view an IsoBox from under-neath, however you can change the 'angle' by setting the projection property.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`size`	number	<optional>	48	The width of the iso box in pixels. The left and right faces will be exactly half this value.
`height`	number	<optional>	32	The height of the iso box. The left and right faces will be this tall. The overall height of the isobox will be this value plus half the `size` value.
`fillTop`	number	<optional>	0xeeeeee	The fill color of the top face of the iso box.
`fillLeft`	number	<optional>	0x999999	The fill color of the left face of the iso box.
`fillRight`	number	<optional>	0xcccccc	The fill color of the right face of the iso box.

Since: 3.13.0
Source: src/gameobjects/shape/isobox/IsoBoxFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.IsoBox

isotriangle( [x] [, y] [, size] [, height] [, reversed] [, fillTop] [, fillLeft] [, fillRight])

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

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

The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports only fill colors and cannot be stroked.

An IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different fill color. You can set the color of the top, left and right faces of the triangle respectively You can also choose which of the faces are rendered via the showTop, showLeft and showRight properties.

You cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting the projection property. The reversed property controls if the IsoTriangle is rendered upside down or not.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`size`	number	<optional>	48	The width of the iso triangle in pixels. The left and right faces will be exactly half this value.
`height`	number	<optional>	32	The height of the iso triangle. The left and right faces will be this tall. The overall height of the iso triangle will be this value plus half the `size` value.
`reversed`	boolean	<optional>	false	Is the iso triangle upside down?
`fillTop`	number	<optional>	0xeeeeee	The fill color of the top face of the iso triangle.
`fillLeft`	number	<optional>	0x999999	The fill color of the left face of the iso triangle.
`fillRight`	number	<optional>	0xcccccc	The fill color of the right face of the iso triangle.

Since: 3.13.0
Source: src/gameobjects/shape/isotriangle/IsoTriangleFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.IsoTriangle

layer( [children])

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

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

Parameters:

Name	Type	Argument	Description
`children`	Phaser.GameObjects.GameObject \| Array.<Phaser.GameObjects.GameObject>	<optional>	An optional array of Game Objects to add to this Layer.

Since: 3.50.0
Source: src/gameobjects/layer/LayerFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Layer

line( [x] [, y] [, x1] [, y1] [, x2] [, y2] [, strokeColor] [, strokeAlpha])

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

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

The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports only stroke colors and cannot be filled.

A Line Shape allows you to draw a line between two points in your game. You can control the stroke color and thickness of the line. In WebGL only you can also specify a different thickness for the start and end of the line, allowing you to render lines that taper-off.

If you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`x1`	number	<optional>	0	The horizontal position of the start of the line.
`y1`	number	<optional>	0	The vertical position of the start of the line.
`x2`	number	<optional>	128	The horizontal position of the end of the line.
`y2`	number	<optional>	0	The vertical position of the end of the line.
`strokeColor`	number	<optional>		The color the line will be drawn in, i.e. 0xff0000 for red.
`strokeAlpha`	number	<optional>		The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/line/LineFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Line

mesh( [x] [, y] [, texture] [, frame] [, vertices] [, uvs] [, indicies] [, containsZ] [, normals] [, colors] [, alphas])

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

Note: This method will only be available if the Mesh Game Object and WebGL support have been built into Phaser.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>		The horizontal position of this Game Object in the world.
`y`	number	<optional>		The vertical position of this Game Object in the world.
`texture`	string \| Phaser.Textures.Texture	<optional>		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>		An optional frame from the Texture this Game Object is rendering with.
`vertices`	Array.<number>	<optional>		The vertices array. Either `xy` pairs, or `xyz` if the `containsZ` parameter is `true`.
`uvs`	Array.<number>	<optional>		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?
`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.

Since: 3.0.0
Source: src/gameobjects/mesh/MeshFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Mesh

particles(texture [, frame] [, emitters])

Creates a new Particle Emitter Manager Game Object and adds it to the Scene.

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

Parameters:

Name	Type	Argument	Description
`texture`	string \| Phaser.Textures.Texture		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number \| object	<optional>	An optional frame from the Texture this Game Object is rendering with.
`emitters`	Phaser.Types.GameObjects.Particles.ParticleEmitterConfig \| Array.<Phaser.Types.GameObjects.Particles.ParticleEmitterConfig>	<optional>	Configuration settings for one or more emitters to create.

Since: 3.0.0
Source: src/gameobjects/particles/ParticleManagerFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Particles.ParticleEmitterManager

path(x, y)

Creates a new Path Object.

Parameters:

Name	Type	Description
`x`	number	The horizontal position of this Path.
`y`	number	The vertical position of this Path.

Since: 3.0.0
Source: src/curves/path/Path.js (Line 859)

Returns:

The Path Object that was created.

Type: Phaser.Curves.Path

pointlight(x, y [, color] [, radius] [, intensity] [, attenuation])

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

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

The Point Light Game Object provides a way to add a point light effect into your game, without the expensive shader processing requirements of the traditional Light Game Object.

The difference is that the Point Light renders using a custom shader, designed to give the impression of a point light source, of variable radius, intensity and color, in your game. However, unlike the Light Game Object, it does not impact any other Game Objects, or use their normal maps for calcuations. This makes them extremely fast to render compared to Lights and perfect for special effects, such as flickering torches or muzzle flashes.

For maximum performance you should batch Point Light Game Objects together. This means ensuring they follow each other consecutively on the display list. Ideally, use a Layer Game Object and then add just Point Lights to it, so that it can batch together the rendering of the lights. You don't have to do this, and if you've only a handful of Point Lights in your game then it's perfectly safe to mix them into the dislay list as normal. However, if you're using a large number of them, please consider how they are mixed into the display list.

The renderer will automatically cull Point Lights. Those with a radius that does not intersect with the Camera will be skipped in the rendering list. This happens automatically and the culled state is refreshed every frame, for every camera.

The origin of a Point Light is always 0.5 and it cannot be changed.

Point Lights are a WebGL only feature and do not have a Canvas counterpart.

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The horizontal position of this Point Light in the world.
`y`	number			The vertical position of this Point Light in the world.
`color`	number	<optional>	0xffffff	The color of the Point Light, given as a hex value.
`radius`	number	<optional>	128	The radius of the Point Light.
`intensity`	number	<optional>	1	The intensity, or colr blend, of the Point Light.
`attenuation`	number	<optional>	0.1	The attenuation of the Point Light. This is the reduction of light from the center point.

Since: 3.50.0
Source: src/gameobjects/pointlight/PointLightFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.PointLight

polygon( [x] [, y] [, points] [, fillColor] [, fillAlpha])

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

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

The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

The Polygon Shape is created by providing a list of points, which are then used to create an internal Polygon geometry object. The points can be set from a variety of formats:

An array of Point or Vector2 objects: [new Phaser.Math.Vector2(x1, y1), ...]
An array of objects with public x/y properties: [obj1, obj2, ...]
An array of paired numbers that represent point coordinates: [x1,y1, x2,y2, ...]
An array of arrays with two elements representing x/y coordinates: [[x1, y1], [x2, y2], ...]

By default the x and y coordinates of this Shape refer to the center of it. However, depending on the coordinates of the points provided, the final shape may be rendered offset from its origin.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`points`	any	<optional>		The points that make up the polygon.
`fillColor`	number	<optional>		The color the polygon will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/polygon/PolygonFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Polygon

rectangle( [x] [, y] [, width] [, height] [, fillColor] [, fillAlpha])

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

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

The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

You can change the size of the rectangle by changing the width and height properties.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`width`	number	<optional>	128	The width of the rectangle.
`height`	number	<optional>	128	The height of the rectangle.
`fillColor`	number	<optional>		The color the rectangle will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/rectangle/RectangleFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Rectangle

renderTexture(x, y [, width] [, height])

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

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

A Render Texture is a special texture that allows any number of Game Objects to be drawn to it. You can take many complex objects and draw them all to this one texture, which can they be used as the texture for other Game Object's. It's a way to generate dynamic textures at run-time that are WebGL friendly and don't invoke expensive GPU uploads.

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The horizontal position of this Game Object in the world.
`y`	number			The vertical position of this Game Object in the world.
`width`	number	<optional>	32	The width of the Render Texture.
`height`	number	<optional>	32	The height of the Render Texture.

Since: 3.2.0
Source: src/gameobjects/rendertexture/RenderTextureFactory.js (Line 10)

Name	Type	Argument	Description
`key`	string	<optional>	The texture key to make the RenderTexture from.
`frame`	string	<optional>	the frame to make the RenderTexture from.

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.RenderTexture

rope(x, y, texture [, frame] [, points] [, horizontal] [, colors] [, alphas])

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

Note: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The horizontal position of this Game Object in the world.
`y`	number			The vertical position of this Game Object in the world.
`texture`	string \| Phaser.Textures.Texture			The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>		An optional frame from the Texture this Game Object is rendering with.
`points`	Array.<Phaser.Types.Math.Vector2Like>	<optional>		An array containing the vertices data for this Rope. If none is provided a simple quad is created. See `setPoints` to set this post-creation.
`horizontal`	boolean	<optional>	true	Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?
`colors`	Array.<number>	<optional>		An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.
`alphas`	Array.<number>	<optional>		An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.

Since: 3.23.0
Source: src/gameobjects/rope/RopeFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Rope

shader(key [, x] [, y] [, width] [, height] [, textures] [, textureData])

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

Note: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.

Parameters:

Name	Type	Argument	Default	Description
`key`	string \| Phaser.Display.BaseShader			The key of the shader to use from the shader cache, or a BaseShader instance.
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`width`	number	<optional>	128	The width of the Game Object.
`height`	number	<optional>	128	The height of the Game Object.
`textures`	Array.<string>	<optional>		Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.
`textureData`	object	<optional>		Optional additional texture data.

Since: 3.17.0
Source: src/gameobjects/shader/ShaderFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Shader

sprite(x, y, texture [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`texture`	string \| Phaser.Textures.Texture		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: src/gameobjects/sprite/SpriteFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Sprite

sprite3D(x, y, z, texture [, frame])

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object.
`y`	number		The vertical position of this Game Object.
`z`	number		The z position of this Game Object.
`texture`	string		The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| integer	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: plugins/camera3d/src/Camera3DPlugin.js (Line 67)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Sprite3D

sprite3D(x, y, z, texture [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object.
`y`	number		The vertical position of this Game Object.
`z`	number		The z position of this Game Object.
`texture`	string		The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| integer	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: plugins/camera3d/src/sprite3d/Sprite3DFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Sprite3D

star( [x] [, y] [, points] [, innerRadius] [, outerRadius] [, fillColor] [, fillAlpha])

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

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

The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

As the name implies, the Star shape will display a star in your game. You can control several aspects of it including the number of points that constitute the star. The default is 5. If you change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky star shape.

You can also control the inner and outer radius, which is how 'long' each point of the star is. Modify these values to create more interesting shapes.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`points`	number	<optional>	5	The number of points on the star.
`innerRadius`	number	<optional>	32	The inner radius of the star.
`outerRadius`	number	<optional>	64	The outer radius of the star.
`fillColor`	number	<optional>		The color the star will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/star/StarFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Star

text(x, y, text [, style])

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

A Text Game Object.

Text objects work by creating their own internal hidden Canvas and then renders text to it using the standard Canvas fillText API. It then creates a texture from this canvas which is rendered to your game during the render pass.

Because it uses the Canvas API you can take advantage of all the features this offers, such as applying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts loaded externally, such as Google or TypeKit Web fonts.

You can only display fonts that are currently loaded and available to the browser: therefore fonts must be pre-loaded. Phaser does not do ths for you, so you will require the use of a 3rd party font loader, or have the fonts ready available in the CSS on the page in which your Phaser game resides.

See this compatibility table for the available default fonts across mobile browsers.

A note on performance: Every time the contents of a Text object changes, i.e. changing the text being displayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the new texture to the GPU. This can be an expensive operation if used often, or with large quantities of Text objects in your game. If you run into performance issues you would be better off using Bitmap Text instead, as it benefits from batching and avoids expensive Canvas API calls.

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`text`	string \| Array.<string>		The text this Text object will display.
`style`	Phaser.Types.GameObjects.Text.TextStyle	<optional>	The Text style configuration object.

Since: 3.0.0
Source: src/gameobjects/text/TextFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Text

tilemap( [key] [, tileWidth] [, tileHeight] [, width] [, height] [, data] [, insertNull])

Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided. When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For an empty map, you should specify tileWidth, tileHeight, width & height.

Parameters:

Name	Type	Argument	Default	Description
`key`	string	<optional>		The key in the Phaser cache that corresponds to the loaded tilemap data.
`tileWidth`	number	<optional>	32	The width of a tile in pixels. Pass in `null` to leave as the default.
`tileHeight`	number	<optional>	32	The height of a tile in pixels. Pass in `null` to leave as the default.
`width`	number	<optional>	10	The width of the map in tiles. Pass in `null` to leave as the default.
`height`	number	<optional>	10	The height of the map in tiles. Pass in `null` to leave as the default.
`data`	Array.<Array.<number>>	<optional>		Instead of loading from the cache, you can also load directly from a 2D array of tile indexes. Pass in `null` for no data.
`insertNull`	boolean	<optional>	false	Controls how empty tiles, tiles with an index of -1, in the map data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty location will get a Tile object with an index of -1. If you've a large sparsely populated map and the tile data doesn't need to change then setting this value to `true` will help with memory consumption. However if your map is small or you need to update the tiles dynamically, then leave the default value set.

Since: 3.0.0
Source: src/tilemaps/TilemapFactory.js (Line 10)

Returns:

Type: Phaser.Tilemaps.Tilemap

tileSprite(x, y, width, height, texture [, frame])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`width`	number		The width of the Game Object. If zero it will use the size of the texture frame.
`height`	number		The height of the Game Object. If zero it will use the size of the texture frame.
`texture`	string \| Phaser.Textures.Texture		The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
`frame`	string \| number	<optional>	An optional frame from the Texture this Game Object is rendering with.

Since: 3.0.0
Source: src/gameobjects/tilesprite/TileSpriteFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.TileSprite

triangle( [x] [, y] [, x1] [, y1] [, x2] [, y2] [, x3] [, y3] [, fillColor] [, fillAlpha])

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

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

The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling it for input or physics. It provides a quick and easy way for you to render this shape in your game without using a texture, while still taking advantage of being fully batched in WebGL.

This shape supports both fill and stroke colors.

The Triangle consists of 3 lines, joining up to form a triangular shape. You can control the position of each point of these lines. The triangle is always closed and cannot have an open face. If you require that, consider using a Polygon instead.

Parameters:

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The horizontal position of this Game Object in the world.
`y`	number	<optional>	0	The vertical position of this Game Object in the world.
`x1`	number	<optional>	0	The horizontal position of the first point in the triangle.
`y1`	number	<optional>	128	The vertical position of the first point in the triangle.
`x2`	number	<optional>	64	The horizontal position of the second point in the triangle.
`y2`	number	<optional>	0	The vertical position of the second point in the triangle.
`x3`	number	<optional>	128	The horizontal position of the third point in the triangle.
`y3`	number	<optional>	128	The vertical position of the third point in the triangle.
`fillColor`	number	<optional>		The color the triangle will be filled with, i.e. 0xff0000 for red.
`fillAlpha`	number	<optional>		The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.

Since: 3.13.0
Source: src/gameobjects/shape/triangle/TriangleFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Triangle

tween(config)

Creates a new Tween object.

Note: This method will only be available if Tweens have been built into Phaser.

Parameters:

Name	Type	Description
`config`	Phaser.Types.Tweens.TweenBuilderConfig \| object	The Tween configuration.

Since: 3.0.0
Source: src/tweens/tween/Tween.js (Line 1593)

Returns:

The Tween that was created.

Type: Phaser.Tweens.Tween

video(x, y [, key])

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

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

Parameters:

Name	Type	Argument	Description
`x`	number		The horizontal position of this Game Object in the world.
`y`	number		The vertical position of this Game Object in the world.
`key`	string	<optional>	Optional key of the Video this Game Object will play, as stored in the Video Cache.

Since: 3.20.0
Source: src/gameobjects/video/VideoFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Video

zone(x, y, width, height)

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

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

Parameters:

Name	Type	Description
`x`	number	The horizontal position of this Game Object in the world.
`y`	number	The vertical position of this Game Object in the world.
`width`	number	The width of the Game Object.
`height`	number	The height of the Game Object.

Since: 3.0.0
Source: src/gameobjects/zone/ZoneFactory.js (Line 10)

Returns:

The Game Object that was created.

Type: Phaser.GameObjects.Zone