Skip to main content

MagnusBuilder

Sub-builder for the Magnus effect. Opened via BehaviorBuilder:Magnus. Call :Done() to return to the root BehaviorBuilder.

Functions​

SpinVector​

</>
MagnusBuilder:SpinVector(value: Vector3) → MagnusBuilder

Spin axis x angular velocity in rad/s. Vector3.zero disables the effect.

Default: Vector3.zero

Coefficient​

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

Magnus lift coefficient. Typical range: 0.00005–0.001.

Default: 0

SpinDecayRate​

</>
MagnusBuilder:SpinDecayRate(value: number) → MagnusBuilder

Rate at which SpinVector magnitude decreases per second. 0 = no decay.

Default: 0

Done​

</>
MagnusBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "SpinVector",
            "desc": "Spin axis x angular velocity in rad/s. `Vector3.zero` disables the effect.\n\nDefault: `Vector3.zero`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MagnusBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 738,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Coefficient",
            "desc": "Magnus lift coefficient. Typical range: `0.00005`–`0.001`.\n\nDefault: `0`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MagnusBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 748,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "SpinDecayRate",
            "desc": "Rate at which `SpinVector` magnitude decreases per second. `0` = no decay.\n\nDefault: `0`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MagnusBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 758,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 764,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MagnusBuilder",
    "desc": "Sub-builder for the Magnus effect. Opened via [BehaviorBuilder:Magnus].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 728,
        "path": "docs/SubBuilders.lua"
    }
}