Skip to main content

SpeedProfilesBuilder

Sub-builder for supersonic/subsonic speed profile configuration. Opened via BehaviorBuilder:SpeedProfiles. Call :Done() to return to the root BehaviorBuilder.

Functions​

Thresholds​

</>
SpeedProfilesBuilder:Thresholds(value: {number}) → SpeedProfilesBuilder

Sorted list of speeds (studs/s) that fire OnSpeedThresholdCrossed.

Default: {}

Supersonic​

</>
SpeedProfilesBuilder:Supersonic() → SpeedProfileBuilder

Opens a SpeedProfileBuilder for the supersonic regime (speed >= 343 studs/s). Call :Done() on the profile builder to commit it and return here.

Subsonic​

</>
SpeedProfilesBuilder:Subsonic() → SpeedProfileBuilder

Opens a SpeedProfileBuilder for the subsonic regime (speed < 343 studs/s). Call :Done() on the profile builder to commit it and return here.

Done​

</>
SpeedProfilesBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "Thresholds",
            "desc": "Sorted list of speeds (studs/s) that fire `OnSpeedThresholdCrossed`.\n\nDefault: `{}`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "{ number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfilesBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 934,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Supersonic",
            "desc": "Opens a [SpeedProfileBuilder] for the supersonic regime (speed >= 343 studs/s).\nCall `:Done()` on the profile builder to commit it and return here.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 942,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Subsonic",
            "desc": "Opens a [SpeedProfileBuilder] for the subsonic regime (speed < 343 studs/s).\nCall `:Done()` on the profile builder to commit it and return here.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpeedProfileBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 950,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 956,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SpeedProfilesBuilder",
    "desc": "Sub-builder for supersonic/subsonic speed profile configuration.\nOpened via [BehaviorBuilder:SpeedProfiles]. Call `:Done()` to return to\nthe root [BehaviorBuilder].",
    "source": {
        "line": 924,
        "path": "docs/SubBuilders.lua"
    }
}