Skip to main content

VFXHandler

Manages the loading and execution of visual effect modules.

Functions​

PlayEffect​

</>
VFXHandler.PlayEffect(
effectName: string,--

The name of the effect module.

target: Model | BasePart,--

The target object for the effect.

args: {[string]: any}?--

Optional parameters passed to the effect's Spawn function.

) → any?--

The result of the effect's Spawn method.

Plays a specific visual effect by name on a target.

PlaySequence​

</>
VFXHandler.PlaySequence(
sequence: {{
name: string,
target: Model | BasePart,
params: {[string]: any}?
}}--

The sequence table.

) → ()

Plays a sequence of visual effects in order.

Show raw api
{
    "functions": [
        {
            "name": "PlayEffect",
            "desc": "Plays a specific visual effect by name on a target.",
            "params": [
                {
                    "name": "effectName",
                    "desc": "The name of the effect module.",
                    "lua_type": "string"
                },
                {
                    "name": "target",
                    "desc": "The target object for the effect.",
                    "lua_type": "Model | BasePart"
                },
                {
                    "name": "args",
                    "desc": "Optional parameters passed to the effect's Spawn function.",
                    "lua_type": "{ [string]: any }?"
                }
            ],
            "returns": [
                {
                    "desc": "The result of the effect's Spawn method.",
                    "lua_type": "any?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/init.luau"
            }
        },
        {
            "name": "PlaySequence",
            "desc": "Plays a sequence of visual effects in order.",
            "params": [
                {
                    "name": "sequence",
                    "desc": "The sequence table.",
                    "lua_type": "{ { name: string, target: Model | BasePart, params: { [string]: any }? } }"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 51,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "VFXHandler",
    "desc": "Manages the loading and execution of visual effect modules.",
    "source": {
        "line": 16,
        "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/init.luau"
    }
}