Skip to main content

GyroDriftBuilder

Sub-builder for gyroscopic drift. Opened via BehaviorBuilder:GyroDrift. Call :Done() to return to the root BehaviorBuilder.

Functions​

Rate​

</>
GyroDriftBuilder:Rate(value: number) → GyroDriftBuilder

Lateral drift acceleration magnitude in studs/s². Setting this enables drift.

Default: nil (disabled)

Axis​

</>
GyroDriftBuilder:Axis(value: Vector3) → GyroDriftBuilder

Reference axis for drift direction. nil = world UP (right-hand rifling).

Default: nil

Done​

</>
GyroDriftBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "Rate",
            "desc": "Lateral drift acceleration magnitude in studs/s². Setting this enables drift.\n\nDefault: `nil` (disabled)",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GyroDriftBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 784,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Axis",
            "desc": "Reference axis for drift direction. `nil` = world UP (right-hand rifling).\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GyroDriftBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 794,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 800,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GyroDriftBuilder",
    "desc": "Sub-builder for gyroscopic drift. Opened via [BehaviorBuilder:GyroDrift].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 774,
        "path": "docs/SubBuilders.lua"
    }
}