Namespace: PathFollower

Type Definitions

---

PathConfig

Settings for a PathFollower.

Type:

• object

Properties:

Name	Type	Argument	Default	Description
duration	number	<optional>	1000	The duration of the path follow in ms. Must be > 0.
from	number	<optional>	0	The start position of the path follow, between 0 and 1. Must be less than to.
to	number	<optional>	1	The end position of the path follow, between 0 and 1. Must be more than from.
positionOnPath	boolean	<optional>	false	Whether to position the PathFollower on the Path using its path offset.
rotateToPath	boolean	<optional>	false	Should the PathFollower automatically rotate to point in the direction of the Path?
rotationOffset	number	<optional>	0	If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.
startAt	number	<optional>	0	Current start position of the path follow, must be between from and to.

Since: 3.0.0

Source: src/gameobjects/pathfollower/typedefs/PathConfig.js (Line 1)