Class: MoveTo

Phaser.Curves. MoveTo

A MoveTo Curve is a very simple curve consisting of only a single point. Its intended use is to move the ending point in a Path.


new MoveTo( [x] [, y])

Parameters:
Name Type Argument Description
x number <optional>

x pixel coordinate.

y number <optional>

y pixel coordinate.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 10)

Members


active :boolean

Denotes that this Curve does not influence the bounds, points, and drawing of its parent Path. Must be false or some methods in the parent Path will throw errors.

Type:
  • boolean
Since: 3.0.0
Default Value:
  • false
Source: src/curves/path/MoveTo.js (Line 30)

p0 :Phaser.Math.Vector2

The lone point which this curve consists of.

Type:
Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 40)

Methods


getLength()

Gets the length of this curve.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 101)
Returns:

The length of this curve. For a MoveTo the value is always 0.

Type
number

getPoint(t [, out])

Get point at relative position in curve according to length.

Parameters:
Name Type Argument Description
t number

The position along the curve to return. Where 0 is the start and 1 is the end.

out Phaser.Math.Vector2 <optional>

A Vector2 object to store the result in. If not given will be created.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 50)
Returns:

The coordinates of the point on the curve. If an out object was given this will be returned.

Type
Phaser.Math.Vector2

getPointAt(u [, out])

Retrieves the point at given position in the curve. This will always return this curve's only point.

Parameters:
Name Type Argument Description
u number

The position in the path to retrieve, between 0 and 1. Not used.

out Phaser.Math.Vector2 <optional>

An optional vector in which to store the point.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 70)
Returns:

The modified out vector, or a new Vector2 if none was provided.

Type
Phaser.Math.Vector2

getResolution()

Gets the resolution of this curve.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 88)
Returns:

The resolution of this curve. For a MoveTo the value is always 1.

Type
number

toJSON()

Converts this curve into a JSON-serializable object.

Since: 3.0.0
Source: src/curves/path/MoveTo.js (Line 114)
Returns:

A primitive object with the curve's type and only point.

Type
JSONCurve