Skip to main content

DragBuilder

Sub-builder for aerodynamic drag. Opened via BehaviorBuilder:Drag. Call :Done() to return to the root BehaviorBuilder.

Functions​

Coefficient​

</>
DragBuilder:Coefficient(value: number) → DragBuilder

Drag coefficient. 0 = no drag.

Default: 0

Model​

</>
DragBuilder:Model(value: DragModel) → DragBuilder

Drag model. Use BehaviorBuilder.DragModel enum values.

Default: BehaviorBuilder.DragModel.Quadratic

SegmentInterval​

</>
DragBuilder:SegmentInterval(value: number) → DragBuilder

Seconds between drag and Magnus recalculation steps.

Default: 0.05

CustomMachTable​

</>
DragBuilder:CustomMachTable(value: {{number}}) → DragBuilder

Required when Model = BehaviorBuilder.DragModel.Custom. Table of {mach, cd} pairs, sorted ascending by Mach number.

Default: nil

Done​

</>
DragBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "Coefficient",
            "desc": "Drag coefficient. `0` = no drag.\n\nDefault: `0`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DragBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 654,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Model",
            "desc": "Drag model. Use `BehaviorBuilder.DragModel` enum values.\n\nDefault: `BehaviorBuilder.DragModel.Quadratic`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "DragModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DragBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 664,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "SegmentInterval",
            "desc": "Seconds between drag and Magnus recalculation steps.\n\nDefault: `0.05`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DragBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 674,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "CustomMachTable",
            "desc": "Required when `Model = BehaviorBuilder.DragModel.Custom`.\nTable of `{mach, cd}` pairs, sorted ascending by Mach number.\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "{ { number } }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DragBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 685,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 691,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DragBuilder",
    "desc": "Sub-builder for aerodynamic drag. Opened via [BehaviorBuilder:Drag].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 644,
        "path": "docs/SubBuilders.lua"
    }
}