Filter
A Graphics object is a way to draw primitive shapes to your game. Primitives include forms of geometry, such as Rectangles, Circles, and Polygons. They also include lines, arcs and curves. When you initially create a Graphics object it will be empty.
To draw to it you must first specify a line style or fill style (or both), draw shapes using paths, and finally fill or stroke them. For example:
graphics.lineStyle(5, 0xFF00FF, 1.0);
graphics.beginPath();
graphics.moveTo(100, 100);
graphics.lineTo(200, 200);
graphics.closePath();
graphics.strokePath();
There are also many helpful methods that draw and fill/stroke common shapes for you.
graphics.lineStyle(5, 0xFF00FF, 1.0);
graphics.fillStyle(0xFFFFFF, 1.0);
graphics.fillRect(50, 50, 400, 200);
graphics.strokeRect(50, 50, 400, 200);
When a Graphics object is rendered it will render differently based on if the game is running under Canvas or WebGL. Under Canvas it will use the HTML Canvas context drawing operations to draw the path. Under WebGL the graphics data is decomposed into polygons. Both of these are expensive processes, especially with complex shapes.
If your Graphics object doesn't change much (or at all) once you've drawn your shape to it, then you will help performance by calling Phaser.GameObjects.Graphics#generateTexture. This will 'bake' the Graphics object into a Texture, and return it. You can then use this Texture for Sprites or other display objects. If your Graphics object updates frequently then you should avoid doing this, as it will constantly generate new textures, which will consume memory.
As you can tell, Graphics objects are a bit of a trade-off. While they are extremely useful, you need to be careful in their complexity and quantity of them in your game.
Constructor:
new Graphics(scene, [options])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| scene | Phaser.Scene |
The Scene to which this Graphics object belongs. |
|
| options | Phaser.Types.GameObjects.Graphics.Options | <optional> |
Options that set the position and default style of this Graphics object. |
Extends
- Phaser.GameObjects.GameObject
- Phaser.GameObjects.Components.AlphaSingle
- Phaser.GameObjects.Components.BlendMode
- Phaser.GameObjects.Components.Depth
- Phaser.GameObjects.Components.Mask
- Phaser.GameObjects.Components.Pipeline
- Phaser.GameObjects.Components.PostPipeline
- Phaser.GameObjects.Components.Transform
- Phaser.GameObjects.Components.Visible
- Phaser.GameObjects.Components.ScrollFactor
Members
Description:
A Camera used specifically by the Graphics system for rendering to textures.
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:
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:
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:
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:
Description:
If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.
Type:
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:
Description:
The array of commands used to render the Graphics.
Type:
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:
Description:
The default fill alpha for shapes rendered by this Graphics object.
Set this value with setDefaultStyles().
Type:
Description:
The default fill color for shapes rendered by this Graphics object.
Set this value with setDefaultStyles().
Type:
Description:
The initial WebGL pipeline of this Game Object.
If you call resetPipeline on this Game Object, the pipeline is reset to this default.
Description:
The default stroke alpha for shapes rendered by this Graphics object.
Set this value with setDefaultStyles().
Type:
Description:
The default stroke color for shapes rendered by this Graphics object.
Set this value with setDefaultStyles().
Type:
Description:
The default stroke width for shapes rendered by this Graphics object.
Set this value with setDefaultStyles().
Type:
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:
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.
Description:
The horizontal display origin of the Graphics.
Type:
Description:
The vertical display origin of the Graphics.
Type:
Description:
Does this Game Object have any Post Pipelines set?
Type:
Description:
A property indicating that a Game Object has this component.
Type:
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:
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().
Description:
The Mask this Game Object is using during render.
Description:
The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.
Type:
Description:
The parent Container of this Game Object, if it has one.
Description:
The current WebGL pipeline of this Game Object.
Description:
An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.
Type:
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.
Description:
An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.
Type:
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:
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.
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:
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:
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:
Description:
The horizontal scale of this Game Object.
Type:
Description:
The vertical scale of this Game Object.
Type:
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:
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:
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:
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:
Description:
The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.
Type:
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:
Description:
The visible state of the Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
Type:
Description:
The w position of this Game Object.
Type:
Description:
The x position of this Game Object.
Type:
Description:
The y position of this Game Object.
Type:
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:
Methods
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.
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.
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.
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.
Description:
Draw an arc.
This method can be used to create circles, or parts of circles.
Make sure you call beginPath before starting the arc unless you wish for the arc to automatically
close when filled or stroked.
Use the optional overshoot argument increase the number of iterations that take place when
the arc is rendered in WebGL. This is useful if you're drawing an arc with an especially thick line,
as it will allow the arc to fully join-up. Try small values at first, i.e. 0.01.
Call Phaser.GameObjects.Graphics#fillPath or Phaser.GameObjects.Graphics#strokePath after calling this method to draw the arc.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the center of the circle. |
||
| y | number |
The y coordinate of the center of the circle. |
||
| radius | number |
The radius of the circle. |
||
| startAngle | number |
The starting angle, in radians. |
||
| endAngle | number |
The ending angle, in radians. |
||
| anticlockwise | boolean | <optional> | false |
Whether the drawing should be anticlockwise or clockwise. |
| overshoot | number | <optional> | 0 |
This value allows you to increase the segment iterations in WebGL rendering. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly. Use small numbers such as 0.01 to start with and increase as needed. |
Returns:
Description:
This Game Object.
Description:
Start a new shape path.
Returns:
Description:
This Game Object.
Description:
Clear the command buffer and reset the fill style and line style to their defaults.
Returns:
Description:
This Game Object.
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.
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.
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.
Description:
Close the current path.
Returns:
Description:
This Game Object.
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.
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 |
| 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.
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.
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 |
|
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.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| resetCursor | boolean | <optional> | false |
Should the currently active Input cursor, if any, be reset to the default cursor? |
Returns:
Description:
This GameObject.
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
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Fill the current path.
This is an alias for Graphics.fillPath and does the same thing.
It was added to match the CanvasRenderingContext 2D API.
Returns:
Description:
This Game Object.
Description:
Fill a circle with the given position and radius.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate of the center of the circle. |
| y | number |
The y coordinate of the center of the circle. |
| radius | number |
The radius of the circle. |
Returns:
Description:
This Game Object.
Description:
Fill the given circle.
Parameters:
| name | type | description |
|---|---|---|
| circle | Phaser.Geom.Circle |
The circle to fill. |
Returns:
Description:
This Game Object.
Description:
Fill an ellipse with the given position and size.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the center of the ellipse. |
||
| y | number |
The y coordinate of the center of the ellipse. |
||
| width | number |
The width of the ellipse. |
||
| height | number |
The height of the ellipse. |
||
| smoothness | number | <optional> | 32 |
The number of points to draw the ellipse with. |
Returns:
Description:
This Game Object.
Description:
Fill the given ellipse.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| ellipse | Phaser.Geom.Ellipse |
The ellipse to fill. |
||
| smoothness | number | <optional> | 32 |
The number of points to draw the ellipse with. |
Returns:
Description:
This Game Object.
Description:
Sets a gradient fill style. This is a WebGL only feature.
The gradient color values represent the 4 corners of an untransformed rectangle.
The gradient is used to color all filled shapes and paths drawn after calling this method.
If you wish to turn a gradient off, call fillStyle and provide a new single fill color.
When filling a triangle only the first 3 color values provided are used for the 3 points of a triangle.
This feature is best used only on rectangles and triangles. All other shapes will give strange results.
Note that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used will be filled with a gradient on its own. There is no ability to gradient fill a shape or path as a single entity at this time.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| topLeft | number |
The top left fill color. |
||
| topRight | number |
The top right fill color. |
||
| bottomLeft | number |
The bottom left fill color. |
||
| bottomRight | number |
The bottom right fill color. Not used when filling triangles. |
||
| alphaTopLeft | number | <optional> | 1 |
The top left alpha value. If you give only this value, it's used for all corners. |
| alphaTopRight | number | <optional> | 1 |
The top right alpha value. |
| alphaBottomLeft | number | <optional> | 1 |
The bottom left alpha value. |
| alphaBottomRight | number | <optional> | 1 |
The bottom right alpha value. |
Returns:
Description:
This Game Object.
Description:
Fill the current path.
Returns:
Description:
This Game Object.
Description:
Fill a point at the given position.
Draws a square at the given position, 1 pixel in size by default.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the point. |
||
| y | number |
The y coordinate of the point. |
||
| size | number | <optional> | 1 |
The size of the square to draw. |
Returns:
Description:
This Game Object.
Description:
Fill the given point.
Draws a square at the given position, 1 pixel in size by default.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| point | object | Phaser.Geom.Point | Phaser.Math.Vector2 |
The point to fill. |
||
| size | number | <optional> | 1 |
The size of the square to draw. |
Returns:
Description:
This Game Object.
Description:
Fill the shape represented by the given array of points.
Pass closeShape to automatically close the shape by joining the last to the first point.
Pass closePath to automatically close the path before it is filled.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| points | array | Array.<Phaser.Geom.Point> |
The points to fill. |
||
| closeShape | boolean | <optional> | false |
When |
| closePath | boolean | <optional> | false |
When |
| endIndex | number | <optional> |
The index of |
Returns:
Description:
This Game Object.
Description:
Fill a rectangle with the given position and size.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate of the top-left of the rectangle. |
| y | number |
The y coordinate of the top-left of the rectangle. |
| width | number |
The width of the rectangle. |
| height | number |
The height of the rectangle. |
Returns:
Description:
This Game Object.
Description:
Fill the given rectangle.
Parameters:
| name | type | description |
|---|---|---|
| rect | Phaser.Geom.Rectangle |
The rectangle to fill. |
Returns:
Description:
This Game Object.
Description:
Fill a rounded rectangle with the given position, size and radius.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the top-left of the rectangle. |
||
| y | number |
The y coordinate of the top-left of the rectangle. |
||
| width | number |
The width of the rectangle. |
||
| height | number |
The height of the rectangle. |
||
| radius | number | Phaser.Types.GameObjects.Graphics.RoundedRectRadius | <optional> | 20 |
The corner radius; It can also be an object to specify different radius for corners. |
Returns:
Description:
This Game Object.
Description:
Set the current fill style. Used for all 'fill' related functions.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| color | number |
The fill color. |
||
| alpha | number | <optional> | 1 |
The fill alpha. |
Returns:
Description:
This Game Object.
Description:
Fill a triangle with the given points.
Parameters:
| name | type | description |
|---|---|---|
| x0 | number |
The x coordinate of the first point. |
| y0 | number |
The y coordinate of the first point. |
| x1 | number |
The x coordinate of the second point. |
| y1 | number |
The y coordinate of the second point. |
| x2 | number |
The x coordinate of the third point. |
| y2 | number |
The y coordinate of the third point. |
Returns:
Description:
This Game Object.
Description:
Fill the given triangle.
Parameters:
| name | type | description |
|---|---|---|
| triangle | Phaser.Geom.Triangle |
The triangle to fill. |
Returns:
Description:
This Game Object.
Description:
Generate a texture from this Graphics object.
If key is a string it'll generate a new texture using it and add it into the
Texture Manager (assuming no key conflict happens).
If key is a Canvas it will draw the texture to that canvas context. Note that it will NOT
automatically upload it to the GPU in WebGL mode.
Please understand that the texture is created via the Canvas API of the browser, therefore some
Graphics features, such as fillGradientStyle, will not appear on the resulting texture,
as they're unsupported by the Canvas API.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string | HTMLCanvasElement |
The key to store the texture with in the Texture Manager, or a Canvas to draw to. |
|
| width | number | <optional> |
The width of the graphics to generate. |
| height | number | <optional> |
The height of the graphics to generate. |
Returns:
Description:
This Game Object.
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:
- *
Description:
Returns a reference to the underlying display list array that contains this Game Object, which will be either the Scene's Display List or the internal list belonging to its parent Container, if it has one.
If this Game Object is not on a display list or in a container, it will return null.
You should be very careful with this method, and understand that it returns a direct reference to the internal array used by the Display List. Mutating this array directly can cause all kinds of subtle and difficult to debug issues in your game.
Returns:
Description:
The internal Display List array of Game Objects, or null.
Type:
- Array.<Phaser.GameObjects.GameObject>
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>
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.
Type:
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.
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
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, or null.
Type:
- string
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.
Type:
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.
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 | Default | description |
|---|---|---|---|---|
| key | string |
The key to change the value for. |
||
| amount | number | <optional> | 1 |
The amount to increase the given key by. Pass a negative value to decrease the key. |
Returns:
Description:
This GameObject.
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
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? |
Description:
Draw a line between the given points.
Parameters:
| name | type | description |
|---|---|---|
| x1 | number |
The x coordinate of the start point of the line. |
| y1 | number |
The y coordinate of the start point of the line. |
| x2 | number |
The x coordinate of the end point of the line. |
| y2 | number |
The y coordinate of the end point of the line. |
Returns:
Description:
This Game Object.
Description:
Sets a gradient line style. This is a WebGL only feature.
The gradient color values represent the 4 corners of an untransformed rectangle.
The gradient is used to color all stroked shapes and paths drawn after calling this method.
If you wish to turn a gradient off, call lineStyle and provide a new single line color.
This feature is best used only on single lines. All other shapes will give strange results.
Note that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used will be filled with a gradient on its own. There is no ability to gradient stroke a shape or path as a single entity at this time.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| lineWidth | number |
The stroke width. |
||
| topLeft | number |
The tint being applied to the top-left of the Game Object. |
||
| topRight | number |
The tint being applied to the top-right of the Game Object. |
||
| bottomLeft | number |
The tint being applied to the bottom-left of the Game Object. |
||
| bottomRight | number |
The tint being applied to the bottom-right of the Game Object. |
||
| alpha | number | <optional> | 1 |
The fill alpha. |
Returns:
Description:
This Game Object.
Description:
Set the current line style. Used for all 'stroke' related functions.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| lineWidth | number |
The stroke width. |
||
| color | number |
The stroke color. |
||
| alpha | number | <optional> | 1 |
The stroke alpha. |
Returns:
Description:
This Game Object.
Description:
Draw a line from the current drawing position to the given position.
Moves the current drawing position to the given position.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate to draw the line to. |
| y | number |
The y coordinate to draw the line to. |
Returns:
Description:
This Game Object.
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
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()>
Description:
Move the current drawing position to the given position.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate to move to. |
| y | number |
The y coordinate to move to. |
Returns:
Description:
This Game Object.
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.
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.
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.
Description:
Internal destroy handler, called as part of the destroy process.
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.
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.
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.
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.)
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| resetCursor | boolean | <optional> | false |
Should the currently active Input cursor, if any, be reset to the default cursor? |
Returns:
Description:
This GameObject.
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.
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.
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.
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 |
Returns:
Description:
true if the pipeline was reset successfully, otherwise false.
Type:
- boolean
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 |
Description:
Restores the most recently saved state of the Graphics by popping from the state stack.
Use Phaser.GameObjects.Graphics#save to save the current state, and call this afterwards to restore that state.
If there is no saved state, this command does nothing.
Returns:
Description:
This Game Object.
Description:
Inserts a rotation command into this Graphics objects command buffer.
All objects drawn after calling this method will be rotated by the given amount.
This does not change the rotation of the Graphics object itself, only of the objects drawn by it after calling this method.
Parameters:
| name | type | description |
|---|---|---|
| radians | number |
The rotation angle, in radians. |
Returns:
Description:
This Game Object.
Description:
Saves the state of the Graphics by pushing the current state onto a stack.
The most recently saved state can then be restored with Phaser.GameObjects.Graphics#restore.
Returns:
Description:
This Game Object.
Description:
Inserts a scale command into this Graphics objects command buffer.
All objects drawn after calling this method will be scaled by the given amount.
This does not change the scale of the Graphics object itself, only of the objects drawn by it after calling this method.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The horizontal scale to apply. |
| y | number |
The vertical scale to apply. |
Returns:
Description:
This Game Object.
Description:
Move this Game Object so that it appears above the given Game Object.
This means it will render immediately after the other object in the display list.
Both objects must belong to the same display list, or parent container.
This method does not change this Game Objects depth value, it simply alters its list position.
Parameters:
| name | type | description |
|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
The Game Object that this Game Object will be moved to be above. |
Returns:
Description:
This Game Object instance.
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.
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.
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.
Description:
Move this Game Object so that it appears below the given Game Object.
This means it will render immediately under the other object in the display list.
Both objects must belong to the same display list, or parent container.
This method does not change this Game Objects depth value, it simply alters its list position.
Parameters:
| name | type | description |
|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
The Game Object that this Game Object will be moved to be below. |
Returns:
Description:
This Game Object instance.
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.
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 | * | <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.
Description:
Adds a Data Manager component to this Game Object.
Returns:
Description:
This GameObject.
Description:
Set the default style settings for this Graphics object.
Parameters:
| name | type | description |
|---|---|---|
| options | Phaser.Types.GameObjects.Graphics.Styles |
The styles to set as defaults. |
Returns:
Description:
This Game Object.
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.
Description:
Pass this Game Object to the Input Manager to enable it for Input.
Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced input detection.
If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific shape for it to use.
You can also provide an Input Configuration Object as the only argument to this method.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| hitArea | any | Phaser.Types.Input.InputConfiguration | <optional> |
Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame. |
|
| callback | Phaser.Types.Input.HitAreaCallback | <optional> |
The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback. |
|
| dropZone | boolean | <optional> | false |
Should this Game Object be treated as a drop zone target? |
Returns:
Description:
This GameObject.
sprite.setInteractive();
sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);
graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);
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.
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.
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 |
|
| copyData | boolean | <optional> | true |
Should the pipeline data object be deep copied into the |
Returns:
Description:
This Game Object instance.
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 |
Returns:
Description:
This Game Object instance.
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 |
| 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.
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 |
|
| copyData | boolean | <optional> | true |
Should the pipeline data object be deep copied into the |
Returns:
Description:
This Game Object instance.
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 |
Returns:
Description:
This Game Object instance.
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.
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.
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 |
Returns:
Description:
This Game Object instance.
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 |
Returns:
Description:
This Game Object instance.
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.
Description:
Sets this Game Object to the back of the display list, or the back of its parent container.
Being at the back means it will render below everything else.
This method does not change this Game Objects depth value, it simply alters its list position.
Returns:
Description:
This Game Object instance.
Description:
Sets this Game Object to be at the top of the display list, or the top of its parent container.
Being at the top means it will render on-top of everything else.
This method does not change this Game Objects depth value, it simply alters its list position.
Returns:
Description:
This Game Object instance.
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.
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.
Description:
Sets the x position of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The x position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets the y position of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The y position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets 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#setDepth instead.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The z position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Removes all listeners.
Description:
Creates a pie-chart slice shape centered at x, y with the given radius.
You must define the start and end angle of the slice.
Setting the anticlockwise argument to true creates a shape similar to Pacman.
Setting it to false creates a shape like a slice of pie.
This method will begin a new path and close the path at the end of it.
To display the actual slice you need to call either strokePath or fillPath after it.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The horizontal center of the slice. |
||
| y | number |
The vertical center of the slice. |
||
| radius | number |
The radius of the slice. |
||
| startAngle | number |
The start angle of the slice, given in radians. |
||
| endAngle | number |
The end angle of the slice, given in radians. |
||
| anticlockwise | boolean | <optional> | false |
Whether the drawing should be anticlockwise or clockwise. |
| overshoot | number | <optional> | 0 |
This value allows you to overshoot the endAngle by this amount. Useful if the arc has a thick stroke and needs to overshoot to join-up cleanly. |
Returns:
Description:
This Game Object.
Description:
Stroke the current path.
This is an alias for Graphics.strokePath and does the same thing.
It was added to match the CanvasRenderingContext 2D API.
Returns:
Description:
This Game Object.
Description:
Stroke a circle with the given position and radius.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate of the center of the circle. |
| y | number |
The y coordinate of the center of the circle. |
| radius | number |
The radius of the circle. |
Returns:
Description:
This Game Object.
Description:
Stroke the given circle.
Parameters:
| name | type | description |
|---|---|---|
| circle | Phaser.Geom.Circle |
The circle to stroke. |
Returns:
Description:
This Game Object.
Description:
Stroke an ellipse with the given position and size.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the center of the ellipse. |
||
| y | number |
The y coordinate of the center of the ellipse. |
||
| width | number |
The width of the ellipse. |
||
| height | number |
The height of the ellipse. |
||
| smoothness | number | <optional> | 32 |
The number of points to draw the ellipse with. |
Returns:
Description:
This Game Object.
Description:
Stroke the given ellipse.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| ellipse | Phaser.Geom.Ellipse |
The ellipse to stroke. |
||
| smoothness | number | <optional> | 32 |
The number of points to draw the ellipse with. |
Returns:
Description:
This Game Object.
Description:
Draw the given line.
Parameters:
| name | type | description |
|---|---|---|
| line | Phaser.Geom.Line |
The line to stroke. |
Returns:
Description:
This Game Object.
Description:
Stroke the current path.
Returns:
Description:
This Game Object.
Description:
Stroke the shape represented by the given array of points.
Pass closeShape to automatically close the shape by joining the last to the first point.
Pass closePath to automatically close the path before it is stroked.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| points | array | Array.<Phaser.Geom.Point> |
The points to stroke. |
||
| closeShape | boolean | <optional> | false |
When |
| closePath | boolean | <optional> | false |
When |
| endIndex | number | <optional> |
The index of |
Returns:
Description:
This Game Object.
Description:
Stroke a rectangle with the given position and size.
Parameters:
| name | type | description |
|---|---|---|
| x | number |
The x coordinate of the top-left of the rectangle. |
| y | number |
The y coordinate of the top-left of the rectangle. |
| width | number |
The width of the rectangle. |
| height | number |
The height of the rectangle. |
Returns:
Description:
This Game Object.
Description:
Stroke the given rectangle.
Parameters:
| name | type | description |
|---|---|---|
| rect | Phaser.Geom.Rectangle |
The rectangle to stroke. |
Returns:
Description:
This Game Object.
Description:
Stroke a rounded rectangle with the given position, size and radius.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The x coordinate of the top-left of the rectangle. |
||
| y | number |
The y coordinate of the top-left of the rectangle. |
||
| width | number |
The width of the rectangle. |
||
| height | number |
The height of the rectangle. |
||
| radius | number | Phaser.Types.GameObjects.Graphics.RoundedRectRadius | <optional> | 20 |
The corner radius; It can also be an object to specify different radii for corners. |
Returns:
Description:
This Game Object.
Description:
Stroke a triangle with the given points.
Parameters:
| name | type | description |
|---|---|---|
| x0 | number |
The x coordinate of the first point. |
| y0 |