Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

PathFollow2D¶

Inherits: Node2D < CanvasItem < Node < Object

Point sampler for a Path2D.

Description¶

This node takes its parent Path2D, and returns the coordinates of a point within it, given a distance from the first vertex.

It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting the progress in this node.

Properties¶

bool	cubic_interp	`true`
float	h_offset	`0.0`
bool	loop	`true`
float	progress	`0.0`
float	progress_ratio	`0.0`
bool	rotates	`true`
float	v_offset	`0.0`

Property Descriptions¶

bool cubic_interp = true

void set_cubic_interpolation ( bool value )
bool get_cubic_interpolation ( )

If true, the position between two cached points is interpolated cubically, and linearly otherwise.

The points along the Curve2D of the Path2D are precomputed