Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

CollisionModule

struct in UnityEngine

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 Collision module.

Properties

bounceHow much force is applied to each particle after a collision.
bounceMultiplierChange the bounce multiplier.
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 is lost from each particle after a collision.
dampenMultiplierChange the dampen multiplier.
enabledEnable/disable the Collision module.
enableDynamicCollidersAllow particles to collide with dynamic colliders when using world collision mode.
lifetimeLossHow much a particle's lifetime is reduced after a collision.
lifetimeLossMultiplierChange the lifetime loss multiplier.
maxCollisionShapesThe maximum number of collision shapes that will be considered for particle collisions. Excess shapes will be ignored. Terrains take priority.
maxKillSpeedKill particles whose speed goes above this threshold, after a collision.
maxPlaneCountThe maximum number of planes it is possible to set as colliders.
minKillSpeedKill particles whose speed falls below this threshold, after a collision.
modeChoose between 2D and 3D world collisions.
multiplyColliderForceByCollisionAngleIf true, the collision angle is considered when applying forces from particles to Colliders.
multiplyColliderForceByParticleSizeIf true, particle sizes are considered when applying forces to Colliders.
multiplyColliderForceByParticleSpeedIf true, particle speeds are considered when applying forces to Colliders.
qualitySpecifies the accuracy of particle collisions against colliders in the scene.
radiusScaleA multiplier applied 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

GetPlaneGet a collision plane associated with this particle system.
SetPlaneSet a collision plane to be used with this particle system.