Skip to content

Collision Properties

The system lets you to control how particles interact with the environment through collision. This part covers properties that manage how particles detect and respond to collisions, whether they bounce, stop, or pass through objects.

Performance heavy

Particles using smart collision use raycasting to determine when they hit something, this can be laggy, so it's not the best idea to use many particles with collision when going for compatibility on lower-end devices

CanCollide

  • Description: Controls if particles are collidable with physics objects, such as players
  • Default: false
  • Example: 
    emitter:Create({ -- Physics objects will collide with particles
    CanCollide = true
})

EnableCollision

  • Description: Enables collision detection for particles, allowing them to interact with objects in the world.
  • Default: false
  • Example: 
    emitter:Create({ -- Particles will collide with objects
    EnableCollision = true
})

ParticlesAreSolid

  • Description: When enabled, particles will treat itself on collision as a solid object, for example, a bouncy ball is a solid object, while fire is not. When this is false, the particles will spread out around the surface of the hit object, when this is true, the particles will bounce.
  • Default: false
  • Example: 
    emitter:Create({ -- Particles will bounce on collision
    EnableCollision = true,
    ParticlesAreSolid = true
})

CollisionRange

  • Description: When provided, this number will be the range of raycasting around particles in studs.
  • Default: nil
  • Example: 
    emitter:Create({ -- Particles will check for collision within 5 studs
    EnableCollision = true,
    CollisionRange = 5
})

OnCollision

  • Description: Lets you to use a function that is called whenever a particle collides with an object. This can be used to trigger specific effects, such as particles changing color's on impact or creating explosive rockets/objects.
  • Default: nil
  • Example: 
    emitter:Create({ -- Particles will destroy themselves on collision
    EnableCollision = true,
    OnCollision = function(particle, velocity)
      print("Hit with " .. velocity.Magnitude)
    end
})

idk what to put here