Skip to main content

TumbleBuilder

Sub-builder for bullet tumble. Opened via BehaviorBuilder:Tumble. Call :Done() to return to the root BehaviorBuilder.

Functions​

SpeedThreshold​

</>
TumbleBuilder:SpeedThreshold(value: number) → TumbleBuilder

Speed (studs/s) below which tumbling begins. Setting this enables speed-based onset.

Default: nil (disabled)

DragMultiplier​

</>
TumbleBuilder:DragMultiplier(value: number) → TumbleBuilder

Drag multiplied by this factor while tumbling. Must be >= 1.

Default: 3.0

LateralStrength​

</>
TumbleBuilder:LateralStrength(value: number) → TumbleBuilder

Chaotic lateral acceleration magnitude in studs/s² applied while tumbling.

Default: 0

OnPierce​

</>
TumbleBuilder:OnPierce(value: boolean) → TumbleBuilder

If true, bullet begins tumbling on first pierce regardless of speed.

Default: false

RecoverySpeed​

</>
TumbleBuilder:RecoverySpeed(value: number) → TumbleBuilder

Speed above which tumbling ends. nil = permanent once triggered. Must be > SpeedThreshold if both are set.

Default: nil

Done​

</>
TumbleBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "SpeedThreshold",
            "desc": "Speed (studs/s) below which tumbling begins. Setting this enables speed-based onset.\n\nDefault: `nil` (disabled)",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TumbleBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 820,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "DragMultiplier",
            "desc": "Drag multiplied by this factor while tumbling. Must be `>= 1`.\n\nDefault: `3.0`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TumbleBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 830,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "LateralStrength",
            "desc": "Chaotic lateral acceleration magnitude in studs/s² applied while tumbling.\n\nDefault: `0`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TumbleBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 840,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "OnPierce",
            "desc": "If `true`, bullet begins tumbling on first pierce regardless of speed.\n\nDefault: `false`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TumbleBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 850,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "RecoverySpeed",
            "desc": "Speed above which tumbling ends. `nil` = permanent once triggered.\nMust be `> SpeedThreshold` if both are set.\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TumbleBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 861,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 867,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TumbleBuilder",
    "desc": "Sub-builder for bullet tumble. Opened via [BehaviorBuilder:Tumble].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 810,
        "path": "docs/SubBuilders.lua"
    }
}