Skip to main content

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, color )
Client-Only

Creates a particle effect at a given position and rotation.

note

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

Arguments:
  • particle [ string ]: The particle name.
  • position [ Vec3 ]: The position.
  • rotation [ Quat ]: The rotation (defaults to none).
  • color [ Color ]: The color (defaults to white).