Script interface for the TriggerModule.
This module is useful for killing particles when they touch a set of collision shapes, or for calling a script command to let you apply custom particle behaviors when the trigger is activated.
The example code for MonoBehaviour.OnParticleTrigger shows how the callback type action works.
See Also: ParticleSystem, ParticleSystem.trigger.
colliderCount | Indicates the number of collision shapes attached to this Particle System trigger. |
colliderQueryMode | Determines whether collider information is available when calling [[ParticleSystem::GetTriggerParticles]]. |
enabled | Specifies whether the TriggerModule is enabled or disabled. |
enter | Choose what action to perform when particles enter the trigger volume. |
exit | Choose what action to perform when particles leave the trigger volume. |
inside | Choose what action to perform when particles are inside the trigger volume. |
outside | Choose what action to perform when particles are outside the trigger volume. |
radiusScale | A multiplier Unity applies to the size of each particle before it processes overlaps. |
AddCollider | Adds a Collision shape associated with this Particle System trigger. |
GetCollider | Gets a collision shape associated with this Particle System trigger. |
RemoveCollider | Removes a collision shape associated with this Particle System trigger. |
SetCollider | Sets a Collision shape associated with this Particle System trigger. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.