MoveTo
A MoveTo Curve is a special curve type consisting of a single point. Unlike other curve types, it does not draw anything — it simply repositions the current endpoint of a Path, analogous to the SVG moveto command. Use it within a Phaser.Curves.Path to create a gap between two sub-paths, or to begin drawing from a new position without connecting to the previous curve.
Constructor
new MoveTo([x], [y])
Parameters
| name | type | optional | default | description |
|---|---|---|---|---|
| x | number | Yes | 0 | x pixel coordinate. |
| y | number | Yes | 0 | y pixel coordinate. |
Scope: static
Source: src/curves/path/MoveTo.js#L10
Since: 3.0.0
Public Members
active
active: boolean
Description:
A flag indicating that this curve is inactive and does not contribute to the bounds, length, or rendering of its parent Path. It is always false for a MoveTo, which marks it as a positional marker rather than a drawable segment.
Source: src/curves/path/MoveTo.js#L31
Since: 3.0.0
p0
p0: Phaser.Math.Vector2
Description:
The lone point which this curve consists of.
Source: src/curves/path/MoveTo.js#L41
Since: 3.0.0
Public Methods
getLength
<instance> getLength()
Description:
Gets the length of this curve.
Returns: number - The length of this curve. For a MoveTo the value is always 0.
Source: src/curves/path/MoveTo.js#L102
Since: 3.0.0
getPoint
<instance> getPoint(t, [out])
Description:
Returns the single point that this MoveTo curve represents. Because a MoveTo has only one point, the value of t is ignored and p0 is always returned.
Tags:
- generic
Parameters:
| name | type | optional | description |
|---|---|---|---|
| t | number | No | The position along the curve to return. Where 0 is the start and 1 is the end. |
| out | Phaser.Math.Vector2 | Yes | A Vector2 object to store the result in. If not given will be created. |
Returns: Phaser.Math.Vector2 - The coordinates of the point on the curve. If an out object was given this will be returned.
Source: src/curves/path/MoveTo.js#L51
Since: 3.0.0
getPointAt
<instance> getPointAt(u, [out])
Description:
Retrieves the point at given position in the curve. This will always return this curve's only point.
Tags:
- generic
Parameters:
| name | type | optional | description |
|---|---|---|---|
| u | number | No | The position in the path to retrieve, between 0 and 1. Not used. |
| out | Phaser.Math.Vector2 | Yes | An optional vector in which to store the point. |
Returns: Phaser.Math.Vector2 - The modified out vector, or a new Vector2 if none was provided.
Source: src/curves/path/MoveTo.js#L71
Since: 3.0.0
getResolution
<instance> getResolution()
Description:
Gets the resolution of this curve.
Returns: number - The resolution of this curve. For a MoveTo the value is always 1.
Source: src/curves/path/MoveTo.js#L89
Since: 3.0.0
toJSON
<instance> toJSON()
Description:
Converts this curve into a JSON-serializable object.
Returns: Phaser.Types.Curves.JSONCurve - A primitive object with the curve's type and only point.
Source: src/curves/path/MoveTo.js#L115
Since: 3.0.0