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

Switch to Manual
public static function GetCollisionEvents(ps: ParticleSystem, go: GameObject, collisionEvents: ParticleCollisionEvent[]): int;

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.