Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

ParticleSystem.GetCollisionEvents

Switch to Manual
public function GetCollisionEvents(go: GameObject, collisionEvents: CollisionEvent[]): int;

Parameters

go The GameObject for which to retrieve collision events.
collisionEvents Array 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.