Skip to main content

CosmeticBuilder

Sub-builder for cosmetic bullet configuration. Opened via BehaviorBuilder:Cosmetic. Call :Done() to return to the root BehaviorBuilder.

CAUTION

:Provider() and :Template() are mutually exclusive. Provider takes priority if both are set, and a warning is logged.

Functions​

Template​

</>
CosmeticBuilder:Template(value: BasePart) → CosmeticBuilder

A BasePart cloned once per fire call. Mutually exclusive with :Provider().

Default: nil

Container​

</>
CosmeticBuilder:Container(value: Instance) → CosmeticBuilder

Parent Instance for the cosmetic bullet object. Defaults to workspace.

Default: nil

Provider​

</>
CosmeticBuilder:Provider(callback: (context: BulletContext) → Instance?) → CosmeticBuilder

Factory function called once per fire call. Takes priority over :Template().

Signature: (context: BulletContext) -> Instance?

Default: nil

AutoDelete​

</>
CosmeticBuilder:AutoDelete(value: boolean) → CosmeticBuilder

Controls whether the cosmetic bullet Instance is destroyed automatically when the cast terminates.

When true (default), the solver calls :Destroy() on the cosmetic object at termination. Set to false to take ownership of cleanup, useful when you want to play a death animation or pool the object yourself.

Default: true

Done​

</>
CosmeticBuilder:Done() → BehaviorBuilder

Returns the root BehaviorBuilder.

Show raw api
{
    "functions": [
        {
            "name": "Template",
            "desc": "A `BasePart` cloned once per fire call. Mutually exclusive with `:Provider()`.\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CosmeticBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 565,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Container",
            "desc": "Parent `Instance` for the cosmetic bullet object. Defaults to `workspace`.\n\nDefault: `nil`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CosmeticBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 575,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Provider",
            "desc": "Factory function called once per fire call. Takes priority over `:Template()`.\n\nSignature: `(context: BulletContext) -> Instance?`\n\nDefault: `nil`",
            "params": [
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(context: BulletContext) -> Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CosmeticBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 587,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "AutoDelete",
            "desc": "Controls whether the cosmetic bullet Instance is destroyed automatically\nwhen the cast terminates.\n\nWhen `true` (default), the solver calls `:Destroy()` on the cosmetic object\nat termination. Set to `false` to take ownership of cleanup, useful when\nyou want to play a death animation or pool the object yourself.\n\nDefault: `true`",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CosmeticBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 602,
                "path": "docs/SubBuilders.lua"
            }
        },
        {
            "name": "Done",
            "desc": "Returns the root [BehaviorBuilder].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BehaviorBuilder"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 608,
                "path": "docs/SubBuilders.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CosmeticBuilder",
    "desc": "Sub-builder for cosmetic bullet configuration. Opened via [BehaviorBuilder:Cosmetic].\nCall `:Done()` to return to the root [BehaviorBuilder].\n\n:::caution\n`:Provider()` and `:Template()` are mutually exclusive. Provider takes\npriority if both are set, and a warning is logged.\n:::",
    "source": {
        "line": 555,
        "path": "docs/SubBuilders.lua"
    }
}