Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

TriggerModule

struct in UnityEngine

/

Implemented in:UnityEngine.ParticleSystemModule

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

Switch to Manual

Description

Script interface for the Trigger module.

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.

Properties

enabledEnable/disable the Trigger module.
enterChoose what action to perform when particles enter the trigger volume.
exitChoose what action to perform when particles leave the trigger volume.
insideChoose what action to perform when particles are inside the trigger volume.
maxColliderCountThe maximum number of collision shapes that can be attached to this particle system trigger.
outsideChoose what action to perform when particles are outside the trigger volume.
radiusScaleA multiplier applied to the size of each particle before overlaps are processed.

Public Methods

GetColliderGet a collision shape associated with this particle system trigger.
SetColliderSet a collision shape associated with this particle system trigger.

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