Follow Overview

Determines the positional logic for a given PCam.

The different modes have different functionalities and purposes, so choosing the correct one depends on what each PCam is meant to do.

Core Modes

Glued

Sticks to its target.

Simple

Follows its target with an optional offset.

Group

Follows multiple targets with the option to dynamically reframe itself as targets move further apart.

Path

Follows a target while being positionally confined to a Path node.

Framed

Applies a dead zone to the frame and only follows its target when it tries to leave it.

Third Person

Applies a SpringArm3D node to its target and allows for rotating around it.

Properties

follow_mode

Type: int

Default: 0

Defines the current Follow Mode of the PCam based on FOLLOW_MODE enum.

Follow Mode	Value
NONE	0
GLUED	1
SIMPLE	2
GROUP	3
PATH	4
FRAMED	5
THIRD_PERSON	6

Only Third Person Follow is exclusive to 3D scenes.

Important

This property should not be changed during runtime, as such the setter for this has purposely been excluded.

To use another follow_mode at runtime, switch to a separate PCam with the specific follow_mode applied.

---

Getter

int get_follow_mode()

Example

pcam.get_follow_mode()

follow_axis_lock

Type: int

Default: 0

Prevents camera movement in one or multiple world axes.

Locking a PCam does not change its position nor take its Follow Target's transform values into account.

Note

This only applies once the PCam has a valid Follow Target.

2D

FollowLockAxis	Value
NONE	0
X	1
Y	2
XY	3

3D

FollowLockAxis	Value
NONE	0
X	1
Y	2
Z	3
XY	4
XZ	5
YZ	6
XYZ	7

---

Setter

void set_follow_lock_axis(int value)

Example

pcam.set_follow_axis_lock(2)

Getter

int get_follow_lock_axis()

Example

pcam.get_follow_axis_lock()

Methods

bool is_following

Returns true if the PCam follow_mode is not set to NONE and has a valid follow_target.

Example

pcam.is_following()