Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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
public static function GetCollisionEvents(ps: ParticleSystem, go: GameObject, collisionEvents: ParticleCollisionEvent[]): int;
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 events may be truncated. To avoid this use ParticleSystem.safeCollisionEventSize to determine an appropriate array size prior the call.

See Also: MonoBehaviour.OnParticleCollision.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download