Version: 2021.3
LanguageEnglish
  • C#

ParticleSystem.GetTrails

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

Declaration

public ParticleSystem.Trails GetTrails();

Returns

Trails The variable to populate with the Trails that currently belong to the Particle System..

Description

Returns all the data relating to the current internal state of the Particle System Trails.

If you want to restore the Particle System to its current state in the future, store the Trails this function returns along with ParticleSystem.GetParticles and ParticleSystem.GetPlaybackState.

Additional resources: Trails, SetTrails, GetPlaybackState.


Declaration

public int GetTrails(ref ParticleSystem.Trails trailData);

Parameters

trailData The current Trails belonging to the Particle System.

Returns

int The number of trails.

Description

If you want to restore the Particle System to its current state in the future, store the Trails this function returns along with ParticleSystem.GetParticles and ParticleSystem.GetPlaybackState.

This method allows you to get the trail data without creating any garbage, if you presize the trail data.

Additional resources: Trails, SetTrails, GetPlaybackState.