Skip to main content

TrajectoryBuilder

Sub-builder for trajectory position override. Opened via BehaviorBuilder:Trajectory. Call :Done() to return to the root BehaviorBuilder.

Functions

Provider

TrajectoryBuilder:Provider(value(elapsednumber) → Vector3?) → TrajectoryBuilder

Overrides bullet position each frame with a sampled curve. Return nil from the callback to end the override and terminate the cast.

Signature: (elapsed: number) -> Vector3?

Default: nil

Done

TrajectoryBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "Provider",
            "desc": "Overrides bullet position each frame with a sampled curve.\nReturn `nil` from the callback to end the override and terminate the cast.\n\nSignature: `(elapsed: number) -> Vector3?`\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "(elapsed: number) -> Vector3?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TrajectoryBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 1267,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 1273,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TrajectoryBuilder",
    "desc": "Sub-builder for trajectory position override. Opened via [BehaviorBuilder:Trajectory].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 1254,
        "path": "docs/SubBuilders.lua"
    }
}