Skip to main content

HighFidelityBuilder

Sub-builder for high-fidelity sub-segment raycasting. Opened via BehaviorBuilder:HighFidelity. Call :Done() to return.

Functions​

SegmentSize​

</>
HighFidelityBuilder:SegmentSize(value: number) → HighFidelityBuilder

Sub-segment length in studs (starting value, shrinks adaptively).

Default: 0.5

FrameBudget​

</>
HighFidelityBuilder:FrameBudget(value: number) → HighFidelityBuilder

Millisecond budget per cast per frame for sub-segment raycasts.

Default: 4

AdaptiveScale​

</>
HighFidelityBuilder:AdaptiveScale(value: number) → HighFidelityBuilder

Adaptive sizing multiplier. Must be > 1.

Default: 1.5

MinSegmentSize​

</>
HighFidelityBuilder:MinSegmentSize(value: number) → HighFidelityBuilder

Hard floor for adaptive segment size in studs. Must be <= SegmentSize.

Default: 0.1

MaxBouncesPerFrame​

</>
HighFidelityBuilder:MaxBouncesPerFrame(value: number) → HighFidelityBuilder

Per-frame bounce cap across all sub-segments.

Default: 10

Done​

</>
HighFidelityBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "SegmentSize",
            "desc": "Sub-segment length in studs (starting value, shrinks adaptively).\n\nDefault: `0.5`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HighFidelityBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 402,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "FrameBudget",
            "desc": "Millisecond budget per cast per frame for sub-segment raycasts.\n\nDefault: `4`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HighFidelityBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 412,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "AdaptiveScale",
            "desc": "Adaptive sizing multiplier. Must be `> 1`.\n\nDefault: `1.5`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HighFidelityBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 422,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "MinSegmentSize",
            "desc": "Hard floor for adaptive segment size in studs. Must be `<= SegmentSize`.\n\nDefault: `0.1`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HighFidelityBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 432,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "MaxBouncesPerFrame",
            "desc": "Per-frame bounce cap across all sub-segments.\n\nDefault: `10`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HighFidelityBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 442,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 448,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HighFidelityBuilder",
    "desc": "Sub-builder for high-fidelity sub-segment raycasting.\nOpened via [BehaviorBuilder:HighFidelity]. Call `:Done()` to return.",
    "source": {
        "line": 392,
        "path": "docs/SubBuilders.lua"
    }
}