SpringArm

A helper node, mostly used in 3rd person cameras.

The SpringArm node is a node that casts a ray (or collision shape) along its z axis and moves all its direct children to the collision point, minus a margin.

The most common use case for this is to make a 3rd person camera that reacts to collisions in the environment.

The SpringArm will either cast a ray, or if a shape is given, it will cast the shape in the direction of its z axis.

If you use the SpringArm as a camera controller for your player, you might need to exclude the player’s collider from the SpringArm’s collision check.

void	( RID RID )
void	( )
float	( )
bool	( RID RID )

collision_mask

float margin

Default
Setter	set_margin(value)
Getter	get_margin()

When the collision check is made, a candidate length for the SpringArm is given.

The margin is then subtracted to this length and the translation is applied to the child objects of the SpringArm.

This margin is useful for when the SpringArm has a as a child node: without the margin, the Camera would be placed on the exact point of collision, while with the margin the would be placed close to the point of collision.

The Shape to use for the SpringArm.

When the shape is set, the SpringArm will cast the on its z axis instead of performing a ray cast.

float spring_length

Default	`1.0`
Setter	set_length(value)
Getter	get_length()

To know more about how to perform a shape cast or a ray cast, please consult the documentation.

void add_excluded_object ( RID RID )

Adds the object with the given RID to the list of objects excluded from the collision check.

void clear_excluded_objects ( )

Clears the list of PhysicsBody objects excluded from the collision check.

Returns the spring arm’s current length.

remove_excluded_object ( RID RID )

Removes the given from the list of PhysicsBody objects excluded from the collision check.