Path Follow

Follows a target while being positionally confined to a Path node. The position on the path is based on the closest baked point relative to the target's position.

Warning

This can lead to sudden camera jumps if the Path spline has steep curvatures.

Video Examples

2D 3D

Properties

2D 3D

follow_target

Type: Node2D

Default: null

Determines which Node should be followed. The Camera will follow the position of the Follow Target based on the Follow Mode type and its parameters.

---

Setter

void set_follow_target(Node2D target_node)

Example

pcam.set_follow_target(player_node)

Example

pcam.set_follow_target(player_node)

Getter

Node2D get_follow_target_node()

Node3D get_follow_target_node()

Example

pcam.get_follow_target_node()

Example

pcam.get_follow_target_node()

2D 3D

follow_path

Type: Path2D

Default: null

Determines the Path node the PCam should be bound to. The PCam will follow the position of the Follow Target while sticking to the closest point on this path.

---

Setter

void set_follow_path(Path2D path_name)

Example

pcam.set_follow_path(follow_path_2d)

Example

pcam.set_follow_path(follow_path_3d)

Getter

Vector2 get_follow_path()

Vector3 get_follow_path()

Example

pcam.get_follow_path()

Example

pcam.get_follow_path()

follow_damping

Type: bool

Default: false

Applies a damping effect on the Camera's movement. Leading to heavier / slower camera movement as the targeted node moves around.

This is useful to avoid sharp and rapid camera movement.

---

Setter

void set_follow_damping(bool enable)

Example

pcam.set_follow_damping(true)

Getter

bool get_follow_damping()

Example

pcam.get_follow_damping()

2D 3D

damping_value

Type: Vector2

Default: Vector2(0.1, 0.1)

Defines the damping amount. The ideal range should be somewhere between 0-1, likely somewhere around 0.1-0.25.

The damping amount is specified in the individual axis. X and Y for 2D and X, Y and Z for 3D scenes. To have the damping be consistent in all directions, simply supply the same value in all slots.

Lower value = faster / sharper camera movement.
Higher value = slower / heavier camera movement.

---

Setter

void set_follow_damping_value(Vector2 damping_value)

Example

pcam.set_follow_damping_value(Vector2(0.2, 0.2))

Example

pcam.set_follow_damping_value(Vector3(0.2, 0.2, 0.2))

Getter

Vector2 get_follow_damping_value()

Vector3 get_follow_damping_value()

Example

pcam.get_follow_damping_value()

Example

pcam.get_follow_damping_value()

rotate_with_target

Type: bool

Default: false

Makes the PhantomCamera2D copy the rotation of its follow_target This behavior is only available when follow_mode is set and only has one follow_target.

Important

Be sure to disable ignore_rotation on the Camera2D node to enable this feature.

This property is for PCam2D only.

---

Setter

void set_rotate_with_target(bool enable)

Example

pcam.set_rotate_with_target(true)

Getter

float get_rotate_with_target()

Example

pcam.get_rotate_with_target()

rotation_offset

Type: float

Default: 0

Offsets the rotation when rotate_with_target is enabled.

This property is for PCam2D only.

---

Setter

void set_rotation_offset(float rotation_offset)

Example

pcam.set_rotation_offset(42)

Getter

float get_rotation_offset()

Example

pcam.get_rotation_offset()

rotation_damping

Type: bool

Default: false

Enables rotational damping when rotate_with_target is enabled.

This property is for PCam2D only.

---

Setter

void set_rotation_damping(bool enable)

Example

pcam.set_rotation_damping(true)

Getter

bool get_rotation_damping()

Example

pcam.get_rotation_damping()

rotation_damping_value

Type: float

Default: 0.1

Defines the damping amount for the rotate_with_target.

This property is for PCam2D only.

---

Setter

void set_rotation_damping_value(float damping_value)

Example

pcam.set_rotation_damping_value(0.42)

Getter

float get_rotation_damping_value()

Example

pcam.get_rotation_damping_value()