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 )

    ( )

    float

    ( )

    bool

    ( RID RID )

    • int collision_mask

    The layers against which the collision check shall be done. See in the documentation for more information.

    Default

    Setter

    set_margin(value)

    Getter

    get_margin()

    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.

    Default

    1.0

    Setter

    set_length(value)

    Getter

    get_length()

    The maximum extent of the SpringArm. This is used as a length for both the ray and the shape cast used internally to calculate the desired position of the SpringArm’s child nodes.

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

    • void add_excluded_object ( RID )

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

    • void clear_excluded_objects ( )

    Clears the list of objects excluded from the collision check.

    • bool remove_excluded_object ( RID )

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