sm.particle

The particle api allows you to create particle effects at a position.

If you require more control or complexity, please see the effect api.

Functions:

  • createParticle

  • sm.particle.createParticle(particle, position, rotation=nil, color=nil)

    Client only

    Create a particle effect at a given position and rotation.

    Note:

    If you start a looping particle effect through this method then the only way to get rid of it is by reloading the save.

    Parameters:

    TypeNameDescription
    stringparticleThe particle name.
    Vec3positionThe position.
    Quatrotation=nilThe rotation. (Defaults to no rotation)
    Colorcolor=nilThe blend color. (Defaults to white)