Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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 before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.

There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.


float h_offset = 0.0

  • void set_h_offset (