Skip to main content

ParticleEmitterUtils

Standard playback of particles using EmitDelay and EmitCount attributes that most standard particle editors emit.

Functions​

scaleSize​

</>
ParticleEmitterUtils.scaleSize(
adornee: Instance,
scale: number
) → ()

Scales the size of the particle emitter to a specified size

playFromTemplate​

</>
ParticleEmitterUtils.playFromTemplate(
template: Instance,
attachment: Attachment
) → Maid

Playes a particle emitter from a template in the parent

getParticleEmitters​

</>
ParticleEmitterUtils.getParticleEmitters(adornee: Instance) → {ParticleEmitter}

Retrieves particle emitters for the given adornee

Show raw api
{
    "functions": [
        {
            "name": "scaleSize",
            "desc": "Scales the size of the particle emitter to a specified size",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "scale",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/particles/src/Shared/ParticleEmitterUtils.lua"
            }
        },
        {
            "name": "playFromTemplate",
            "desc": "Playes a particle emitter from a template in the parent",
            "params": [
                {
                    "name": "template",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "attachment",
                    "desc": "",
                    "lua_type": "Attachment"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Maid"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/particles/src/Shared/ParticleEmitterUtils.lua"
            }
        },
        {
            "name": "getParticleEmitters",
            "desc": "Retrieves particle emitters for the given adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ ParticleEmitter }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/particles/src/Shared/ParticleEmitterUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ParticleEmitterUtils",
    "desc": "Standard playback of particles using `EmitDelay` and `EmitCount` attributes that\nmost standard particle editors emit.",
    "source": {
        "line": 8,
        "path": "src/particles/src/Shared/ParticleEmitterUtils.lua"
    }
}