Skip to main content

HelperVFX

A utility class for managing visual effects (VFX) such as particle emissions, light tweens, and spatial queries for players.

Functions​

GetPlayersInRadius​

</>
HelperVFX.GetPlayersInRadius(
rootCharacter: Model,--

The character model to check around.

radius: number--

The search radius.

) → {Player}?--

A list of players found in the radius.

Finds all players within a specified radius of a character.

EmitChildren​

</>
HelperVFX.EmitChildren(
VFXObject: Attachment | BasePart,--

The parent object containing particles.

largestEmissionLifeTime: number--

Accumulator for determining the total VFX duration.

) → number--

The updated largest emission lifetime.

Emits all ParticleEmitter children of the provided object. Adjusts emission count based on the user's graphics quality settings.

EnableChildren​

</>
HelperVFX.EnableChildren(
VFXObject: Attachment | BasePart--

The parent object.

) → ()

Enables all ParticleEmitter children of the provided object.

TweenLight​

</>
HelperVFX.TweenLight(
VFXObject: Attachment | BasePart--

The parent object.

) → ()

Tweens the brightness of all PointLight children found in the object. Uses attributes TweenTime and PeakBrightness for configuration.

Show raw api
{
    "functions": [
        {
            "name": "GetPlayersInRadius",
            "desc": "Finds all players within a specified radius of a character.",
            "params": [
                {
                    "name": "rootCharacter",
                    "desc": "The character model to check around.",
                    "lua_type": "Model"
                },
                {
                    "name": "radius",
                    "desc": "The search radius.",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "A list of players found in the radius.",
                    "lua_type": "{Player}?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/HelperVFX.luau"
            }
        },
        {
            "name": "EmitChildren",
            "desc": "Emits all ParticleEmitter children of the provided object.\nAdjusts emission count based on the user's graphics quality settings.",
            "params": [
                {
                    "name": "VFXObject",
                    "desc": "The parent object containing particles.",
                    "lua_type": "Attachment | BasePart"
                },
                {
                    "name": "largestEmissionLifeTime",
                    "desc": "Accumulator for determining the total VFX duration.",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "The updated largest emission lifetime.",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 56,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/HelperVFX.luau"
            }
        },
        {
            "name": "EnableChildren",
            "desc": "Enables all ParticleEmitter children of the provided object.",
            "params": [
                {
                    "name": "VFXObject",
                    "desc": "The parent object.",
                    "lua_type": "Attachment | BasePart"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 84,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/HelperVFX.luau"
            }
        },
        {
            "name": "TweenLight",
            "desc": "Tweens the brightness of all PointLight children found in the object.\nUses attributes `TweenTime` and `PeakBrightness` for configuration.",
            "params": [
                {
                    "name": "VFXObject",
                    "desc": "The parent object.",
                    "lua_type": "Attachment | BasePart"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/HelperVFX.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HelperVFX",
    "desc": "A utility class for managing visual effects (VFX) such as particle emissions, \nlight tweens, and spatial queries for players.",
    "source": {
        "line": 12,
        "path": "global/ReplicatedStorage/Scripts/Modules/VFXHandler/HelperVFX.luau"
    }
}