A Path combines multiple Curves into one continuous compound curve. It does not matter how many Curves are in the Path or what type they are.
A Curve in a Path does not have to start where the previous Curve ends  that is to say, a Path does not have to be an uninterrupted curve. Only the order of the Curves influences the actual points on the Path.
new Path([x], [y])
name  type  arguments  description 

x  number  <optional> 
The X coordinate of the Path's starting point or a {@link Phaser.Types.Curves.JSONPath}. 
y  number  <optional> 
The Y coordinate of the Path's starting point. 
Automatically closes the path.
The list of Curves which make up this Path.
The name of this Path. Empty by default and never populated by Phaser, this is left for developers to use.
The starting point of the Path.
This is not necessarily equivalent to the starting point of the first Curve in the Path. In an empty Path, it's also treated as the ending point.
Appends a Curve to the end of the Path.
The Curve does not have to start where the Path ends or, for an empty Path, at its defined starting point.
name  type  description 

curve  Phaser.Curves.Curve 
The Curve to append. 
This Path object.
Creates a circular Ellipse Curve positioned at the end of the Path.
name  type  arguments  Default  description 

radius  number 
The radius of the circle. 

clockwise  boolean  <optional>  false 

rotation  number  <optional>  0 
The rotation of the circle in degrees. 
This Path object.
Ensures that the Path is closed.
A closed Path starts and ends at the same point. If the Path is not closed, a straight Line Curve will be created from the ending point directly to the starting point. During the check, the actual starting point of the Path, i.e. the starting point of the first Curve, will be used as opposed to the Path's defined startPoint, which could differ.
Calling this method on an empty Path will result in an error.
This Path object.
Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points.
name  type  arguments  description 

x  number  Phaser.Math.Vector2 
The x coordinate of the end point. Or, if a Vector2, the p1 value. 

y  number  Phaser.Math.Vector2 
The y coordinate of the end point. Or, if a Vector2, the p2 value. 

control1X  number  Phaser.Math.Vector2 
The x coordinate of the first control point. Or, if a Vector2, the p3 value. 

control1Y  number  <optional> 
The y coordinate of the first control point. Not used if Vector2s are provided as the first 3 arguments. 
control2X  number  <optional> 
The x coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments. 
control2Y  number  <optional> 
The y coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments. 
This Path object.
Disposes of this Path, clearing its internal references to objects so they can be garbagecollected.
Draws all Curves in the Path to a Graphics Game Object.
name  type  arguments  Default  description 

graphics  Phaser.GameObjects.Graphics 
The Graphics Game Object to draw to. 

pointsTotal  number  <optional>  32 
The number of points to draw for each Curve. Higher numbers result in a smoother curve but require more processing. 
The Graphics object which was drawn to.
Creates an ellipse curve positioned at the previous end point, using the given parameters.
name  type  arguments  Default  description 

xRadius  number  <optional>  0 
The horizontal radius of ellipse. 
yRadius  number  <optional>  0 
The vertical radius of ellipse. 
startAngle  number  <optional>  0 
The start angle of the ellipse, in degrees. 
endAngle  number  <optional>  360 
The end angle of the ellipse, in degrees. 
clockwise  boolean  <optional>  false 
Whether the ellipse angles are given as clockwise ( 
rotation  number  <optional>  0 
The rotation of the ellipse, in degrees. 
This Path object.
Creates a Path from a Path Configuration object.
The provided object should be a Phaser.Types.Curves.JSONPath, as returned by #toJSON. Providing a malformed object may cause errors.
name  type  description 

data  Phaser.Types.Curves.JSONPath 
The JSON object containing the Path data. 
This Path object.
Returns a Rectangle with a position and size matching the bounds of this Path.
name  type  arguments  Default  description 

out  Phaser.Geom.Rectangle  <optional> 
The Rectangle to store the bounds in. 

accuracy  number  <optional>  16 
The accuracy of the bounds calculations. Higher values are more accurate at the cost of calculation speed. 
The modified out
Rectangle, or a new Rectangle if none was provided.
Returns an array containing the length of the Path at the end of each Curve.
The result of this method will be cached to avoid recalculating it in subsequent calls. The cache is only invalidated when the #curves array changes in length, leading to potential inaccuracies if a Curve in the Path is changed, or if a Curve is removed and another is added in its place.
An array containing the length of the Path at the end of each one of its Curves.
Returns the ending point of the Path.
A Path's ending point is equivalent to the ending point of the last Curve in the Path. For an empty Path, the ending point is at the Path's defined #startPoint.
name  type  arguments  description 

out  Phaser.Math.Vector2  <optional> 
The object to store the point in. 
The modified out
object, or a new Vector2 if none was provided.
Returns the total length of the Path.
The total length of the Path.
Calculates the coordinates of the point at the given normalized location (between 0 and 1) on the Path.
The location is relative to the entire Path, not to an individual Curve. A location of 0.5 is always in the middle of the Path and is thus an equal distance away from both its starting and ending points. In a Path with one Curve, it would be in the middle of the Curve; in a Path with two Curves, it could be anywhere on either one of them depending on their lengths.
name  type  arguments  description 

t  number 
The location of the point to return, between 0 and 1. 

out  Phaser.Math.Vector2  <optional> 
The object in which to store the calculated point. 
The modified out
object, or a new Vector2
if none was provided.
Get a sequence of points on the path.
name  type  arguments  Default  description 

divisions  number  <optional>  12 
The number of divisions per resolution per curve. 
An array of Vector2 objects that containing the points along the Path.
Returns a randomly chosen point anywhere on the path. This follows the same rules as getPoint
in that it may return a point on any Curve inside this path.
When calling this method multiple times, the points are not guaranteed to be equally spaced spatially.
name  type  arguments  description 

out  Phaser.Math.Vector2  <optional> 

The modified out
object, or a new Vector2
if none was provided.
Divides this Path into a set of equally spaced points,
The resulting points are equally spaced with respect to the points' position on the path, but not necessarily equally spaced spatially.
name  type  arguments  Default  description 

divisions  number  <optional>  40 
The amount of points to divide this Path into. 
A list of the points this path was subdivided into.
Returns the starting point of the Path.
name  type  arguments  description 

out  Phaser.Math.Vector2  <optional> 

The modified out
object, or a new Vector2 if none was provided.
Gets a unit vector tangent at a relative position on the path.
name  type  arguments  description 

t  number 
The relative position on the path, [0..1]. 

out  Phaser.Math.Vector2  <optional> 
A vector to store the result in. 
Vector approximating the tangent line at the point t (delta +/ 0.0001)
Creates a line curve from the previous end point to x/y.
name  type  arguments  description 

x  number  Phaser.Math.Vector2 
The X coordinate of the line's end point, or a 

y  number  <optional> 
The Y coordinate of the line's end point, if a number was passed as the X parameter. 
This Path object.
Creates a "gap" in this path from the path's current end point to the given coordinates.
After calling this function, this Path's end point will be equal to the given coordinates
name  type  arguments  description 

x  number  Phaser.Math.Vector2 
The X coordinate of the position to move the path's end point to, or a 

y  number  <optional> 
The Y coordinate of the position to move the path's end point to, if a number was passed as the X coordinate. 
This Path object.
Creates a Quadratic Bezier Curve starting at the ending point of the Path.
name  type  arguments  description 

x  number  Array.<Phaser.Math.Vector2> 
The X coordinate of the second control point or, if it's a 

y  number  <optional> 
The Y coordinate of the second control point or, if 
controlX  number  <optional> 
If 
controlY  number  <optional> 
If 
This Path object.
Creates a spline curve starting at the previous end point, using the given points on the curve.
name  type  description 

points  Array.<Phaser.Math.Vector2> 
The points the newly created spline curve should consist of. 
This Path object.
Converts this Path to a JSON object containing the path information and its constituent curves.
The JSON object containing this path's data.
cacheLengths must be recalculated.