Skip to main content

sm.particle​

The particle library allows for creating particle effects at a position.

If more control or complexity is required, please see the Effect library.

Functions​

createParticle​

sm.particle.createParticle(name, position, rotation, color)

Client-Only

Creates a particle effect at a given position and rotation.

note

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

Parameters:

  • name (string): The particle name.
  • position (Vec3): The position.
  • rotation (Quat, optional): The rotation. Defaults to identity.
  • color (Color, optional): The color. Defaults to white.