PathFollow2D

Refreshing Cache...

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 an offset in this node.

Property Descriptions

Defaulttrue
Setterset_cubic_interpolation(value)
Getterget_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.


Default0.0
Setterset_h_offset(value)
Getterget_h_offset()

The node’s offset along the curve.


Default4.0
Setterset_lookahead(value)
Getterget_lookahead()

How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations.


Defaulttrue
Setterset_loop(value)
Getterhas_loop()

If true, any offset outside the path’s length will wrap around, instead of stopping at the ends. Use it for cyclic paths.


Default0.0
Setterset_offset(value)
Getterget_offset()

The distance along the path in pixels.


Defaulttrue
Setterset_rotate(value)
Getteris_rotating()

If true, this node rotates to follow the path, making its descendants rotate.


Default0.0
Setterset_unit_offset(value)
Getterget_unit_offset()

The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path’s length.


Default0.0
Setterset_v_offset(value)
Getterget_v_offset()

The node’s offset perpendicular to the curve.

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:37:05. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.