Up to date

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

PathFollow3D

Inherits: Node3D < Node < Object

Point sampler for a Path3D.

Description

This node takes its parent Path3D, 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

RotationMode

rotation_mode

3

bool

tilt_enabled

true

bool

use_model_front

false

float

v_offset

0.0

Methods

Transform3D

correct_posture ( Transform3D transform, RotationMode rotation_mode ) static


Enumerations

enum RotationMode:

RotationMode ROTATION_NONE = 0

Forbids the PathFollow3D to rotate.

RotationMode ROTATION_Y = 1

Allows the PathFollow3D to rotate in the Y axis only.

RotationMode ROTATION_XY = 2

Allows the PathFollow3D to rotate in both the X, and Y axes.

RotationMode ROTATION_XYZ = 3

Allows the PathFollow3D to rotate in any axis.

RotationMode ROTATION_ORIENTED = 4

Uses the up vector information in a Curve3D to enforce orientation. This rotation mode requires the Path3D's Curve3D.up_vector_enabled property to be set to true.