Version: 2021.2
LanguageEnglish
  • C#

SubEmittersModule

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 SubEmittersModule.

The sub-emitters module allows you to spawn particles in child emitters from the positions of particles in the parent system.

This module triggers child particle emission on events such as the birth, death, and collision of particles in the parent system.

See Also: ParticleSystem, ParticleSystem.subEmitters.

Properties

enabledSpecifies whether the SubEmittersModule is enabled or disabled.
subEmittersCountThe total number of sub-emitters.

Public Methods

AddSubEmitterAdd a new sub-emitter.
GetSubEmitterEmitProbabilityGets the probability that the sub-emitter emits particles.
GetSubEmitterPropertiesGets the properties of the sub-emitter at the given index.
GetSubEmitterSystemGets the sub-emitter Particle System at the given index.
GetSubEmitterTypeGets the type of the sub-emitter at the given index.
RemoveSubEmitterRemoves a sub-emitter from the given index in the array.
SetSubEmitterEmitProbabilitySets the probability that the sub-emitter emits particles.
SetSubEmitterPropertiesSets the properties of the sub-emitter at the given index.
SetSubEmitterSystemSets the Particle System to use as the sub-emitter at the given index.
SetSubEmitterTypeSets the type of the sub-emitter at the given index.