Version: 2020.3
LanguageEnglish
  • C#

CollisionModule

struct in UnityEngine

/

Implemented in:UnityEngine.ParticleSystemModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Script interface for the CollisionMmodule of a Particle System.

Properties

bounceHow much force is applied to each particle after a collision.
bounceMultiplierA multiplier for ParticleSystem.CollisionModule.bounce.
colliderForceHow much force is applied to a Collider when hit by particles from this Particle System.
collidesWithControl which Layers this Particle System collides with.
dampenHow much speed does each particle lose after a collision.
dampenMultiplierChange the dampen multiplier.
enabledSpecifies whether the CollisionModule is enabled or disabled.
enableDynamicCollidersAllow particles to collide with dynamic colliders when using world collision mode.
lifetimeLossHow much a collision reduces a particle's lifetime.
lifetimeLossMultiplierChange the lifetime loss multiplier.
maxCollisionShapesThe maximum number of collision shapes Unity considers for particle collisions. It ignores excess shapes. Terrains take priority.
maxKillSpeedKill particles whose speed goes above this threshold, after a collision.
minKillSpeedKill particles whose speed falls below this threshold, after a collision.
modeChoose between 2D and 3D world collisions.
multiplyColliderForceByCollisionAngleSpecifies whether the physics system considers the collision angle when it applies forces from particles to Colliders.
multiplyColliderForceByParticleSizeSpecifies whether the physics system considers particle sizes when it applies forces to Colliders.
multiplyColliderForceByParticleSpeedSpecifies whether the physics system considers particle speeds when it applies forces to Colliders.
planeCountShows the number of planes currently set as Colliders.
qualitySpecifies the accuracy of particle collisions against colliders in the Scene.
radiusScaleA multiplier that Unity applies to the size of each particle before collisions are processed.
sendCollisionMessagesSend collision callback messages.
typeThe type of particle collision to perform.
voxelSizeSize of voxels in the collision cache.

Public Methods

AddPlaneAdds a collision plane to use with this Particle System.
GetPlaneGet a collision plane associated with this Particle System.
RemovePlaneRemoves a collision plane associated with this Particle System.
SetPlaneSet a collision plane to use with this Particle System.