Version: 2021.1
LanguageEnglish
  • C#

TrailModule

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

This module adds trails to your particles. For example, you can make the trails stay in the wake of particles as they move, or make them connect each particle in the system together.

See Also: ParticleSystem, ParticleSystem.trails.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { ParticleSystem ps = GetComponent<ParticleSystem>(); var trails = ps.trails; trails.enabled = true; trails.ratio = 0.5f; } }

Properties

attachRibbonsToTransformAdds an extra position to each ribbon, connecting it to the location of the Transform Component.
colorOverLifetimeThe gradient that controls the trail colors during the lifetime of the attached particle.
colorOverTrailThe gradient that controls the trail colors over the length of the trail.
dieWithParticlesSpecifies whether trails disappear immediately when their owning particle dies. When false, each trail persists until all its points have naturally expired, based on its lifetime.
enabledSpecifies whether the TrailModule is enabled or disabled.
generateLightingDataConfigures the trails to generate Normals and Tangents. With this data, Scene lighting can affect the trails via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders.
inheritParticleColorToggle whether the trail inherits the particle color as its starting color.
lifetimeThe curve describing the trail lifetime, throughout the lifetime of the particle.
lifetimeMultiplierA multiplier for ParticleSystem.TrailModule.lifetime.
minVertexDistanceSet the minimum distance each trail can travel before the system adds a new vertex to it.
modeChoose how the system generates the particle trails.
ratioChoose what proportion of particles receive a trail.
ribbonCountSelect how many lines to create through the Particle System.
shadowBiasApply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the trail width at each segment.
sizeAffectsLifetimeSet whether the particle size acts as a multiplier on top of the trail lifetime.
sizeAffectsWidthSet whether the particle size acts as a multiplier on top of the trail width.
splitSubEmitterRibbonsSpecifies whether, if you use this system as a sub-emitter, ribbons connect particles from each parent particle independently.
textureModeChoose whether the U coordinate of the trail Texture is tiled or stretched.
widthOverTrailThe curve describing the width of each trail point.
widthOverTrailMultiplierA multiplier for ParticleSystem.TrailModule.widthOverTrail.
worldSpaceDrop new trail points in world space, regardless of Particle System Simulation Space.