Class ParticleSystem

Inheritance
Object
Object
Component
ParticleSystem
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
[RequireComponent(typeof(Transform))]
[RequireComponent(typeof(Transform))]
public sealed class ParticleSystem : Component

Properties

| Improve this Doc View Source

automaticCullingEnabled

Declaration
[Obsolete("automaticCullingEnabled property is deprecated. Use proceduralSimulationSupported instead (UnityUpgradable) -> proceduralSimulationSupported", true)]
public bool automaticCullingEnabled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

collision

Declaration
public ParticleSystem.CollisionModule collision { get; }
Property Value
Type Description
ParticleSystem.CollisionModule
| Improve this Doc View Source

colorBySpeed

Declaration
public ParticleSystem.ColorBySpeedModule colorBySpeed { get; }
Property Value
Type Description
ParticleSystem.ColorBySpeedModule
| Improve this Doc View Source

colorOverLifetime

Declaration
public ParticleSystem.ColorOverLifetimeModule colorOverLifetime { get; }
Property Value
Type Description
ParticleSystem.ColorOverLifetimeModule
| Improve this Doc View Source

customData

Declaration
public ParticleSystem.CustomDataModule customData { get; }
Property Value
Type Description
ParticleSystem.CustomDataModule
| Improve this Doc View Source

duration

Declaration
[Obsolete("duration property is deprecated. Use main.duration instead.", false)]
public float duration { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

emission

Declaration
public ParticleSystem.EmissionModule emission { get; }
Property Value
Type Description
ParticleSystem.EmissionModule
| Improve this Doc View Source

emissionRate

Declaration
[Obsolete("emissionRate property is deprecated. Use emission.rateOverTime, emission.rateOverDistance, emission.rateOverTimeMultiplier or emission.rateOverDistanceMultiplier instead.", false)]
public float emissionRate { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

enableEmission

Declaration
[Obsolete("enableEmission property is deprecated. Use emission.enabled instead.", false)]
public bool enableEmission { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

externalForces

Declaration
public ParticleSystem.ExternalForcesModule externalForces { get; }
Property Value
Type Description
ParticleSystem.ExternalForcesModule
| Improve this Doc View Source

forceOverLifetime

Declaration
public ParticleSystem.ForceOverLifetimeModule forceOverLifetime { get; }
Property Value
Type Description
ParticleSystem.ForceOverLifetimeModule
| Improve this Doc View Source

gravityModifier

Declaration
[Obsolete("gravityModifier property is deprecated. Use main.gravityModifier or main.gravityModifierMultiplier instead.", false)]
public float gravityModifier { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

inheritVelocity

Declaration
public ParticleSystem.InheritVelocityModule inheritVelocity { get; }
Property Value
Type Description
ParticleSystem.InheritVelocityModule

isEmitting

Declaration
public bool isEmitting { get; }
Property Value
Type Description
Boolean

isPaused

Declaration
public bool isPaused { get; }
Property Value
Type Description
Boolean

isPlaying

Declaration
public bool isPlaying { get; }
Property Value
Type Description
Boolean

isStopped

Declaration
public bool isStopped { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

lights

Declaration
public ParticleSystem.LightsModule lights { get; }
Property Value
Type Description
ParticleSystem.LightsModule
| Improve this Doc View Source

limitVelocityOverLifetime

Declaration
public ParticleSystem.LimitVelocityOverLifetimeModule limitVelocityOverLifetime { get; }
Property Value
Type Description
ParticleSystem.LimitVelocityOverLifetimeModule
| Improve this Doc View Source

loop

Declaration
[Obsolete("loop property is deprecated. Use main.loop instead.", false)]
public bool loop { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

main

Declaration
public ParticleSystem.MainModule main { get; }
Property Value
Type Description
ParticleSystem.MainModule
| Improve this Doc View Source

maxParticles

Declaration
[Obsolete("maxParticles property is deprecated. Use main.maxParticles instead.", false)]
public int maxParticles { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

noise

Declaration
public ParticleSystem.NoiseModule noise { get; }
Property Value
Type Description
ParticleSystem.NoiseModule

particleCount

Declaration
public int particleCount { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

playbackSpeed

Declaration
[Obsolete("playbackSpeed property is deprecated. Use main.simulationSpeed instead.", false)]
public float playbackSpeed { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

playOnAwake

Declaration
[Obsolete("playOnAwake property is deprecated. Use main.playOnAwake instead.", false)]
public bool playOnAwake { get; set; }
Property Value
Type Description
Boolean

proceduralSimulationSupported

Declaration
public bool proceduralSimulationSupported { get; }
Property Value
Type Description
Boolean

randomSeed

Declaration
public uint randomSeed { get; set; }
Property Value
Type Description
UInt32
| Improve this Doc View Source

rotationBySpeed

Declaration
public ParticleSystem.RotationBySpeedModule rotationBySpeed { get; }
Property Value
Type Description
ParticleSystem.RotationBySpeedModule
| Improve this Doc View Source

rotationOverLifetime

Declaration
public ParticleSystem.RotationOverLifetimeModule rotationOverLifetime { get; }
Property Value
Type Description
ParticleSystem.RotationOverLifetimeModule
| Improve this Doc View Source

safeCollisionEventSize

Declaration
[Obsolete("safeCollisionEventSize has been deprecated. Use GetSafeCollisionEventSize() instead (UnityUpgradable) -> ParticlePhysicsExtensions.GetSafeCollisionEventSize(UnityEngine.ParticleSystem)", false)]
public int safeCollisionEventSize { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

scalingMode

Declaration
[Obsolete("scalingMode property is deprecated. Use main.scalingMode instead.", false)]
public ParticleSystemScalingMode scalingMode { get; set; }
Property Value
Type Description
ParticleSystemScalingMode
| Improve this Doc View Source

shape

Declaration
public ParticleSystem.ShapeModule shape { get; }
Property Value
Type Description
ParticleSystem.ShapeModule
| Improve this Doc View Source

simulationSpace

Declaration
[Obsolete("simulationSpace property is deprecated. Use main.simulationSpace instead.", false)]
public ParticleSystemSimulationSpace simulationSpace { get; set; }
Property Value
Type Description
ParticleSystemSimulationSpace
| Improve this Doc View Source

sizeBySpeed

Declaration
public ParticleSystem.SizeBySpeedModule sizeBySpeed { get; }
Property Value
Type Description
ParticleSystem.SizeBySpeedModule
| Improve this Doc View Source

sizeOverLifetime

Declaration
public ParticleSystem.SizeOverLifetimeModule sizeOverLifetime { get; }
Property Value
Type Description
ParticleSystem.SizeOverLifetimeModule
| Improve this Doc View Source

startColor

Declaration
[Obsolete("startColor property is deprecated. Use main.startColor instead.", false)]
public Color startColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

startDelay

Declaration
[Obsolete("startDelay property is deprecated. Use main.startDelay or main.startDelayMultiplier instead.", false)]
public float startDelay { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

startLifetime

Declaration
[Obsolete("startLifetime property is deprecated. Use main.startLifetime or main.startLifetimeMultiplier instead.", false)]
public float startLifetime { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

startRotation

Declaration
[Obsolete("startRotation property is deprecated. Use main.startRotation or main.startRotationMultiplier instead.", false)]
public float startRotation { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

startRotation3D

Declaration
[Obsolete("startRotation3D property is deprecated. Use main.startRotationX, main.startRotationY and main.startRotationZ instead. (Or main.startRotationXMultiplier, main.startRotationYMultiplier and main.startRotationZMultiplier).", false)]
public Vector3 startRotation3D { get; set; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

startSize

Declaration
[Obsolete("startSize property is deprecated. Use main.startSize or main.startSizeMultiplier instead.", false)]
public float startSize { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

startSpeed

Declaration
[Obsolete("startSpeed property is deprecated. Use main.startSpeed or main.startSpeedMultiplier instead.", false)]
public float startSpeed { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

subEmitters

Declaration
public ParticleSystem.SubEmittersModule subEmitters { get; }
Property Value
Type Description
ParticleSystem.SubEmittersModule
| Improve this Doc View Source

textureSheetAnimation

Declaration
public ParticleSystem.TextureSheetAnimationModule textureSheetAnimation { get; }
Property Value
Type Description
ParticleSystem.TextureSheetAnimationModule

time

Declaration
public float time { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

trails

Declaration
public ParticleSystem.TrailModule trails { get; }
Property Value
Type Description
ParticleSystem.TrailModule
| Improve this Doc View Source

trigger

Declaration
public ParticleSystem.TriggerModule trigger { get; }
Property Value
Type Description
ParticleSystem.TriggerModule

useAutoRandomSeed

Declaration
public bool useAutoRandomSeed { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

velocityOverLifetime

Declaration
public ParticleSystem.VelocityOverLifetimeModule velocityOverLifetime { get; }
Property Value
Type Description
ParticleSystem.VelocityOverLifetimeModule

Methods

| Improve this Doc View Source

Clear()

Declaration
public void Clear()

Clear(Boolean)

Declaration
public void Clear(bool withChildren)
Parameters
Type Name Description
Boolean withChildren
| Improve this Doc View Source

Emit(Int32)

Declaration
public void Emit(int count)
Parameters
Type Name Description
Int32 count

Emit(ParticleSystem.EmitParams, Int32)

Declaration
public void Emit(ParticleSystem.EmitParams emitParams, int count)
Parameters
Type Name Description
ParticleSystem.EmitParams emitParams
Int32 count
| Improve this Doc View Source

Emit(ParticleSystem.Particle)

Declaration
[Obsolete("Emit with a single particle structure is deprecated. Pass a ParticleSystem.EmitParams parameter instead, which allows you to override some/all of the emission properties", false)]
public void Emit(ParticleSystem.Particle particle)
Parameters
Type Name Description
ParticleSystem.Particle particle
| Improve this Doc View Source

Emit(Vector3, Vector3, Single, Single, Color32)

Declaration
[Obsolete("Emit with specific parameters is deprecated. Pass a ParticleSystem.EmitParams parameter instead, which allows you to override some/all of the emission properties", false)]
public void Emit(Vector3 position, Vector3 velocity, float size, float lifetime, Color32 color)
Parameters
Type Name Description
Vector3 position
Vector3 velocity
Single size
Single lifetime
Color32 color
| Improve this Doc View Source

GetCustomParticleData(List<Vector4>, ParticleSystemCustomData)

Declaration
public int GetCustomParticleData(List<Vector4> customData, ParticleSystemCustomData streamIndex)
Parameters
Type Name Description
List<Vector4> customData
ParticleSystemCustomData streamIndex
Returns
Type Description
Int32
| Improve this Doc View Source

GetParticles(ParticleSystem.Particle[])

Declaration
public int GetParticles(ParticleSystem.Particle[] particles)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
Returns
Type Description
Int32
| Improve this Doc View Source

GetParticles(ParticleSystem.Particle[], Int32)

Declaration
public int GetParticles(ParticleSystem.Particle[] particles, int size)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
Int32 size
Returns
Type Description
Int32

GetParticles(ParticleSystem.Particle[], Int32, Int32)

Declaration
public int GetParticles(ParticleSystem.Particle[] particles, int size, int offset)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
Int32 size
Int32 offset
Returns
Type Description
Int32
| Improve this Doc View Source

IsAlive()

Declaration
public bool IsAlive()
Returns
Type Description
Boolean

IsAlive(Boolean)

Declaration
public bool IsAlive(bool withChildren)
Parameters
Type Name Description
Boolean withChildren
Returns
Type Description
Boolean
| Improve this Doc View Source

Pause()

Declaration
public void Pause()

Pause(Boolean)

Declaration
public void Pause(bool withChildren)
Parameters
Type Name Description
Boolean withChildren
| Improve this Doc View Source

Play()

Declaration
public void Play()

Play(Boolean)

Declaration
public void Play(bool withChildren)
Parameters
Type Name Description
Boolean withChildren

ResetPreMappedBufferMemory()

Declaration
public static void ResetPreMappedBufferMemory()
| Improve this Doc View Source

SetCustomParticleData(List<Vector4>, ParticleSystemCustomData)

Declaration
public void SetCustomParticleData(List<Vector4> customData, ParticleSystemCustomData streamIndex)
Parameters
Type Name Description
List<Vector4> customData
ParticleSystemCustomData streamIndex
| Improve this Doc View Source

SetParticles(ParticleSystem.Particle[])

Declaration
public void SetParticles(ParticleSystem.Particle[] particles)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
| Improve this Doc View Source

SetParticles(ParticleSystem.Particle[], Int32)

Declaration
public void SetParticles(ParticleSystem.Particle[] particles, int size)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
Int32 size

SetParticles(ParticleSystem.Particle[], Int32, Int32)

Declaration
public void SetParticles(ParticleSystem.Particle[] particles, int size, int offset)
Parameters
Type Name Description
ParticleSystem.Particle[] particles
Int32 size
Int32 offset
| Improve this Doc View Source

Simulate(Single)

Declaration
public void Simulate(float t)
Parameters
Type Name Description
Single t
| Improve this Doc View Source

Simulate(Single, Boolean)

Declaration
public void Simulate(float t, bool withChildren)
Parameters
Type Name Description
Single t
Boolean withChildren
| Improve this Doc View Source

Simulate(Single, Boolean, Boolean)

Declaration
public void Simulate(float t, bool withChildren, bool restart)
Parameters
Type Name Description
Single t
Boolean withChildren
Boolean restart

Simulate(Single, Boolean, Boolean, Boolean)

Declaration
public void Simulate(float t, bool withChildren, bool restart, bool fixedTimeStep)
Parameters
Type Name Description
Single t
Boolean withChildren
Boolean restart
Boolean fixedTimeStep
| Improve this Doc View Source

Stop()

Declaration
public void Stop()
| Improve this Doc View Source

Stop(Boolean)

Declaration
public void Stop(bool withChildren)
Parameters
Type Name Description
Boolean withChildren

Stop(Boolean, ParticleSystemStopBehavior)

Declaration
public void Stop(bool withChildren, ParticleSystemStopBehavior stopBehavior)
Parameters
Type Name Description
Boolean withChildren
ParticleSystemStopBehavior stopBehavior
| Improve this Doc View Source

TriggerSubEmitter(Int32)

Declaration
public void TriggerSubEmitter(int subEmitterIndex)
Parameters
Type Name Description
Int32 subEmitterIndex
| Improve this Doc View Source

TriggerSubEmitter(Int32, List<ParticleSystem.Particle>)

Declaration
public void TriggerSubEmitter(int subEmitterIndex, List<ParticleSystem.Particle> particles)
Parameters
Type Name Description
Int32 subEmitterIndex
List<ParticleSystem.Particle> particles

TriggerSubEmitter(Int32, ref ParticleSystem.Particle)

Declaration
public void TriggerSubEmitter(int subEmitterIndex, ref ParticleSystem.Particle particle)
Parameters
Type Name Description
Int32 subEmitterIndex
ParticleSystem.Particle particle

Extension Methods