Skip to main content

SpeedProfileBuilder

Inner builder for a single speed-regime profile (supersonic or subsonic). Opened via SpeedProfilesBuilder:Supersonic or SpeedProfilesBuilder:Subsonic. Call :Done() to commit the profile and return to SpeedProfilesBuilder.

All fields are optional, omitted fields continue using the base behavior values.

Functions​

DragCoefficient​

</>
SpeedProfileBuilder:DragCoefficient(value: number) → SpeedProfileBuilder

Drag coefficient override for this regime.

DragModel​

</>
SpeedProfileBuilder:DragModel(value: DragModel) → SpeedProfileBuilder

Drag model override for this regime. Use BehaviorBuilder.DragModel values.

NormalPerturbation​

</>
SpeedProfileBuilder:NormalPerturbation(value: number) → SpeedProfileBuilder

Bounce normal perturbation override for this regime.

Restitution​

</>
SpeedProfileBuilder:Restitution(value: number) → SpeedProfileBuilder

Base restitution override for this regime.

MaterialRestitution​

</>
SpeedProfileBuilder:MaterialRestitution(value: {[Enum.Material]: number}) → SpeedProfileBuilder

Per-material restitution overrides for this regime.

Done​

</>
SpeedProfileBuilder:Done() → SpeedProfilesBuilder

Commits the profile to the parent config and returns SpeedProfilesBuilder.

Show raw api
{
    "functions": [
        {
            "name": "DragCoefficient",
            "desc": "Drag coefficient override for this regime.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 977,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "DragModel",
            "desc": "Drag model override for this regime. Use `BehaviorBuilder.DragModel` values.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "DragModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 985,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "NormalPerturbation",
            "desc": "Bounce normal perturbation override for this regime.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 993,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Restitution",
            "desc": "Base restitution override for this regime.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 1001,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "MaterialRestitution",
            "desc": "Per-material restitution overrides for this regime.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "{ [Enum.Material]: number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 1009,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Commits the profile to the parent config and returns [SpeedProfilesBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfilesBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 1015,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SpeedProfileBuilder",
    "desc": "Inner builder for a single speed-regime profile (supersonic or subsonic).\nOpened via [SpeedProfilesBuilder:Supersonic] or [SpeedProfilesBuilder:Subsonic].\nCall `:Done()` to commit the profile and return to [SpeedProfilesBuilder].\n\nAll fields are optional, omitted fields continue using the base behavior values.",
    "source": {
        "line": 969,
        "path": "docs/SubBuilders.lua"
    }
}