Skip to main content

FragmentationBuilder

Sub-builder for fragmentation on pierce. Opened via BehaviorBuilder:Fragmentation. Call :Done() to return to the root BehaviorBuilder.

Functions​

OnPierce​

</>
FragmentationBuilder:OnPierce(value: boolean) → FragmentationBuilder

Enable or disable fragment child bullet spawning on pierce.

Default: false

Count​

</>
FragmentationBuilder:Count(value: number) → FragmentationBuilder

Number of fragment child bullets spawned per pierce.

Default: 3

Deviation​

</>
FragmentationBuilder:Deviation(value: number) → FragmentationBuilder

Angular half-angle spread of the fragment cone in degrees. Must be in [0, 180].

Default: 15

Done​

</>
FragmentationBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "OnPierce",
            "desc": "Enable or disable fragment child bullet spawning on pierce.\n\nDefault: `false`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FragmentationBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 887,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Count",
            "desc": "Number of fragment child bullets spawned per pierce.\n\nDefault: `3`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FragmentationBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 897,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Deviation",
            "desc": "Angular half-angle spread of the fragment cone in degrees. Must be in `[0, 180]`.\n\nDefault: `15`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FragmentationBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 907,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 913,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FragmentationBuilder",
    "desc": "Sub-builder for fragmentation on pierce. Opened via [BehaviorBuilder:Fragmentation].\nCall `:Done()` to return to the root [BehaviorBuilder].",
    "source": {
        "line": 877,
        "path": "docs/SubBuilders.lua"
    }
}