Version: 2019.3
LanguageEnglish
  • C#

ParticlePhysicsExtensions.GetCollisionEvents

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

Obsolete public static int GetCollisionEvents(ParticleSystem ps, GameObject go, ParticleCollisionEvent[] collisionEvents);

Parameters

goThe GameObject for which to retrieve collision events.
collisionEventsArray to write collision events to.

Description

Get the particle collision events for a GameObject. Returns the number of events written to the array.

This method is typically called from MonoBehaviour.OnParticleCollision in response to a collision callback.

If the array used is too short, the list of collision events will be truncated. This means you will not have every event that occurred. To avoid this use ParticleSystem.GetSafeCollisionEventSize to determine an appropriate array size prior the call.

See Also: MonoBehaviour.OnParticleCollision.

Did you find this page useful? Please give it a rating: