---
generated_by: gdlink-build
generated_at: 2026-06-23T12:34:28Z
do_not_edit: true
title: SpringArm3D
brick_type: executor
tier: Plus
generated: true
---

# SpringArm3D

**Category:** Executor
**Tier:** Plus

## Purpose

The SpringArm3D Executor provides a native interface to control a SpringArm3D node's collision behavior and length.

## Visual Reference

```{raw} html
<div class="illustration-container"><div class="illustration-box"><div class="box-header">As added to your scene</div><img src="https://gdlink.solventech.ca/guide/assets/images/bricks/springarm3d_executor.png" alt="SpringArm3D brick as it appears in the GDLink editor" loading="lazy" style="max-width:100%;height:auto;display:block;margin:0 auto;border-radius:8px;" /></div></div>
```

## Runtime Behavior

**Inputs**
- **Activate** (Boolean): When true, the executor updates properties and handles movement smoothing.
- **Target Length** (Float): A dynamic input to drive `spring_length` via variable binding.

**Outputs**
None

**Properties**

**Core Configuration**
- **Spring Length** (Float, 2.0): The maximum distance the arm extends if no collision is hit.
- **Margin** (Float, 0.01): The offset from the collision point to prevent the camera from clipping inside geometry.
- **Collision Mask** (Integer Bitmask): Defines which physics layers the arm should collide with.

**Smoothing And Catch-Up Logic**
- **Enable Smoothing** (Boolean, false): When true, the arm follows its tree parent using the authored local transform as the target.
- **Smoothing Mode** (Option: `Location`, `Rotation`, `Both`; default `Location`): Chooses which channels interpolate while detached. Channels not selected by the mode snap directly to the authored follow target each tick.
- **Rotation Follow Mode** (Option: `Absolute`, `Additive`; default `Absolute`): When rotation smoothing is active, `Absolute` lets the executor fully own the arm's rotation, while `Additive` preserves extra local camera-look rotation applied to the same `SpringArm3D` and composes it on top of the parent-follow pose.
- **Smoothing Speed** (Float, 5.0): How quickly the arm catches up to the parent.
- **Auto Top-Level** (Boolean, true): If enabled, the executor automatically enables **Top Level** at runtime so the arm can move independently.

**Debug And UX (v0.8.98.1-dev11)**

...

```{raw} html
<div class="illustration-container">
        <div class="illustration-box">
            <div class="box-header">Generated UI Mockup — showing expanded properties</div>
            <div class="real-node brick-executor">
                <div class="real-header">
                    <div class="real-title"><span class="brick-icon-fallback"></span> <span>SpringArm3D</span></div>
                    <div class="real-controls"><div class="real-checkbox"></div><div class="real-btn">-</div><div class="real-btn">x</div></div>
                </div>
                <div class="real-inner-panel"><div class="real-row name-row" style="position:relative;"><span class="real-label">Name:</span><div class="real-input" style="color:#666; font-style:italic;">Label this brick...</div><div class="real-port" style="left:-15px;"></div></div><div class="real-row"><span class="real-label">Mask:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>1</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-inline-row" style="margin-top:4px;"><span class="real-inline-label">Length</span><div class="real-inline-input "><span>2.0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div><span class="real-inline-label">Margin</span><div class="real-inline-input "><span>0.01</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-inline-row" style="margin-top:4px;"><div class="real-inline-btn" style="background:#2f343d;">Smoothing</div></div><div class="real-inline-row" style="margin-top:4px;"><span class="real-inline-label">Smooth Mode</span><div class="real-inline-dropdown">Location</div></div><div class="real-inline-row" style="margin-top:4px;"><span class="real-inline-label">Rot Follow</span><div class="real-inline-dropdown">Absolute</div></div><div class="real-inline-row" style="margin-top:4px;"><span class="real-inline-label">Smooth Spd</span><div class="real-inline-input "><span>5.0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-inline-row" style="margin-top:4px;"><div class="real-inline-btn" style="background:#2f5c2f;">Auto TopLvl</div><div class="real-inline-btn" style="background:#2f343d;">Verbose</div></div></div>
            </div>
        </div>
    </div>
```

## Properties

| Property | Type | Default | Notes |
|---|---|---|---|
| Length | float | 2.0 | Maximum arm length when unobstructed |
| Margin | float | 0.01 | Offset from collision point to avoid clipping |
| Mask | int | 1 | Raw physics layer bitmask used by SpringArm3D collision checks |
| Smoothing | bool | False | Enable detached positional catch-up smoothing |
| Smooth Mode | option | Location | Which follow channels interpolate while detached. Unselected channels snap to the authored follow transform. |
| Rot Follow | option | Absolute | When smoothing rotation, choose whether the spring arm owns rotation outright or preserves extra local look input on top of the follow pose. |
| Smooth Spd | float | 5.0 | Catch-up speed when smoothing is enabled |
| Auto TopLvl | bool | True | Temporarily enable Top Level at runtime so the arm can lag behind its parent |
| Verbose | bool | False | Log SpringArm3D target, hit length, compression, and smoothing state (controlled by ladybug button) |