# Sandbox.ParticleEffect

Defines and holds particles. This is the core of the particle system.

- Kind: class
- Namespace: `Sandbox`
- Assembly: `Sandbox.Engine`
- Inherits: [Sandbox.Component](/api/Sandbox.Component)
- Modifiers: sealed

## Constructors

- [`ParticleEffect`](/api/Sandbox.ParticleEffect/.ctor)

## Properties

- [`Alpha`](/api/Sandbox.ParticleEffect/Alpha): The alpha transparency of particles.
- [`ApplyAlpha`](/api/Sandbox.ParticleEffect/ApplyAlpha): Enables or disables alpha application for particles.
- [`ApplyColor`](/api/Sandbox.ParticleEffect/ApplyColor): Enables or disables color application for particles.
- [`ApplyRotation`](/api/Sandbox.ParticleEffect/ApplyRotation): Enables or disables rotation for particles.
- [`ApplyShape`](/api/Sandbox.ParticleEffect/ApplyShape): Enables or disables shape application for particles.
- [`Bounce`](/api/Sandbox.ParticleEffect/Bounce): The bounce factor applied to particles upon collision.
- [`Brightness`](/api/Sandbox.ParticleEffect/Brightness): The brightness multiplier applied to particles.
- [`Bumpiness`](/api/Sandbox.ParticleEffect/Bumpiness): The bumpiness factor applied to particles upon collision.
- [`Collision`](/api/Sandbox.ParticleEffect/Collision): Enables or disables collision behavior for particles.
- [`CollisionIgnore`](/api/Sandbox.ParticleEffect/CollisionIgnore): The set of tags to ignore during collision detection.
- [`CollisionPrefab`](/api/Sandbox.ParticleEffect/CollisionPrefab): Will choose a random prefab to spawn from this list.
- [`CollisionPrefabAlign`](/api/Sandbox.ParticleEffect/CollisionPrefabAlign): When true the collision prefab will be aligned with the surface it collides with.
- [`CollisionPrefabChance`](/api/Sandbox.ParticleEffect/CollisionPrefabChance): If 1 then we'll always spawn a prefab. If 0.5 then we'll spawn a prefab 50% of the time.
- [`CollisionPrefabRotation`](/api/Sandbox.ParticleEffect/CollisionPrefabRotation): We will by default align to the particle's angle, but we can also randomize that.
- [`CollisionRadius`](/api/Sandbox.ParticleEffect/CollisionRadius): The radius used for collision detection.
- [`ComponentVersion`](/api/Sandbox.ParticleEffect/ComponentVersion)
- [`ConstantMovement`](/api/Sandbox.ParticleEffect/ConstantMovement): Move this delta constantly. Ignores velocity, collisions and drag.
- [`Damping`](/api/Sandbox.ParticleEffect/Damping): The damping factor applied to particle velocity over time. This reduces the velocity of particles, simulating resistance or drag.
- [`DelayedParticles`](/api/Sandbox.ParticleEffect/DelayedParticles): Delayed particles in the effect. Delayed particles are those that have been emitted but are waiting to be activated based on their start delay.
- [`DieOnCollisionChance`](/api/Sandbox.ParticleEffect/DieOnCollisionChance): The chance that a particle will die upon collision.
- [`FollowerPrefab`](/api/Sandbox.ParticleEffect/FollowerPrefab): Will choose a random prefab to spawn from this list.
- [`FollowerPrefabChance`](/api/Sandbox.ParticleEffect/FollowerPrefabChance): If 1 then we'll always spawn a prefab. If 0.5 then we'll spawn a prefab 50% of the time.
- [`FollowerPrefabKill`](/api/Sandbox.ParticleEffect/FollowerPrefabKill): When true the prefab will be destroyed at the end of the particle's life.
- [`Force`](/api/Sandbox.ParticleEffect/Force): Enables or disables the application of forces to particles.
- [`ForceDirection`](/api/Sandbox.ParticleEffect/ForceDirection): The direction of the force applied to particles.
- [`ForceScale`](/api/Sandbox.ParticleEffect/ForceScale): The scale of the force applied to each particle. This multiplier determines the intensity of the force applied to particles.
- [`ForceSpace`](/api/Sandbox.ParticleEffect/ForceSpace): The simulation space in which forces are applied. Forces can be applied in either local space (relative to the emitter) or world space.
- [`Friction`](/api/Sandbox.ParticleEffect/Friction): The friction factor applied to particles upon collision.
- [`Gradient`](/api/Sandbox.ParticleEffect/Gradient): The gradient used to color particles over their lifetime.
- [`InitialPitch`](/api/Sandbox.ParticleEffect/InitialPitch): Pitch given to each particle when it is emitted, added to [Sandbox.ParticleEffect.Pitch](/api/Sandbox.ParticleEffect/Pitch).
- [`InitialRoll`](/api/Sandbox.ParticleEffect/InitialRoll): Roll given to each particle when it is emitted, added to [Sandbox.ParticleEffect.Roll](/api/Sandbox.ParticleEffect/Roll).
- [`InitialScale`](/api/Sandbox.ParticleEffect/InitialScale): Scale given to each particle when it is emitted, multiplied with [Sandbox.ParticleEffect.Scale](/api/Sandbox.ParticleEffect/Scale).
- [`InitialVelocity`](/api/Sandbox.ParticleEffect/InitialVelocity): The initial velocity of the particle when it is created. This is applied before any forces are applied.
- [`InitialYaw`](/api/Sandbox.ParticleEffect/InitialYaw): Yaw given to each particle when it is emitted, added to [Sandbox.ParticleEffect.Yaw](/api/Sandbox.ParticleEffect/Yaw).
- [`IsFull`](/api/Sandbox.ParticleEffect/IsFull): Whether the particle effect has reached its maximum capacity. This is determined by comparing the total particle count to the [Sandbox.ParticleEffect.MaxParticles](/api/Sandbox.ParticleEffect/MaxParticles) property.
- [`Lifetime`](/api/Sandbox.ParticleEffect/Lifetime): The lifetime of each particle, in seconds.
- [`LocalSpace`](/api/Sandbox.ParticleEffect/LocalSpace): When 1 particles will be moved in local space relative to the emitter GameObject's transform. This allows particles to be emitted in a local space, like a fire effect that moves with the player, but the particles can slowly move to world space.
- [`MaxParticles`](/api/Sandbox.ParticleEffect/MaxParticles): The maximum number of particles that can exist in this effect at once.
- [`MaxParticleSize`](/api/Sandbox.ParticleEffect/MaxParticleSize): The size of the largest particle in the effect. This is determined by the maximum scale of any particle along its x, y, or z axis.
- [`OnParticleCreated`](/api/Sandbox.ParticleEffect/OnParticleCreated): Called any time a particle is created.
- [`OnParticleDestroyed`](/api/Sandbox.ParticleEffect/OnParticleDestroyed): Called any time a particle is destroyed.
- [`OnPostStep`](/api/Sandbox.ParticleEffect/OnPostStep): Called after the particles are stepped. This allows custom logic to be executed after the simulation advances.
- [`OnPreStep`](/api/Sandbox.ParticleEffect/OnPreStep): Called before the particles are stepped. This allows custom logic to be executed before the simulation advances.
- [`OnStep`](/api/Sandbox.ParticleEffect/OnStep): Called after each particle is stepped. This provides an opportunity to modify individual particles during the simulation.
- [`OrbitalForce`](/api/Sandbox.ParticleEffect/OrbitalForce): The orbital force applied to particles, causing them to rotate around a point.
- [`OrbitalPull`](/api/Sandbox.ParticleEffect/OrbitalPull): The pull strength of the orbital force, drawing particles closer to the center.
- [`ParticleBounds`](/api/Sandbox.ParticleEffect/ParticleBounds): The bounding box that encompasses all active particles. This is useful for determining the spatial extent of the particle effect.
- [`ParticleCount`](/api/Sandbox.ParticleEffect/ParticleCount): The total number of particles in the effect, including both active and delayed particles.
- [`Particles`](/api/Sandbox.ParticleEffect/Particles): Active particles in the effect. Active particles are those currently being simulated and rendered.
- [`Paused`](/api/Sandbox.ParticleEffect/Paused): Whether the particle simulation is currently paused. When paused, particles will not update their positions, velocities, or other properties.
- [`PerParticleTimeScale`](/api/Sandbox.ParticleEffect/PerParticleTimeScale): Per-particle time scale multiplier. Allows each particle to have a unique simulation speed.
- [`Pitch`](/api/Sandbox.ParticleEffect/Pitch): The pitch rotation of the particles.
- [`PreWarm`](/api/Sandbox.ParticleEffect/PreWarm): How many seconds to pre-warm this effect by when creating.
- [`PushStrength`](/api/Sandbox.ParticleEffect/PushStrength): The strength of the push force applied to particles upon collision.
- [`Roll`](/api/Sandbox.ParticleEffect/Roll): The roll rotation of the particles.
- [`Scale`](/api/Sandbox.ParticleEffect/Scale): The scale of particles.
- [`SequenceFitToLifetime`](/api/Sandbox.ParticleEffect/SequenceFitToLifetime): Scale the sequence speed by the particle's lifetime, so at a [Sandbox.ParticleEffect.SequenceSpeed](/api/Sandbox.ParticleEffect/SequenceSpeed) of 1 a non-looping sequence finishes exactly as the particle dies, however long it lives.
- [`SequenceId`](/api/Sandbox.ParticleEffect/SequenceId): Which sequence to use.
- [`SequenceSpeed`](/api/Sandbox.ParticleEffect/SequenceSpeed): Increment the sequence time by this much.
- [`SequenceTime`](/api/Sandbox.ParticleEffect/SequenceTime): Allows control of the sequence time, which spans from 0 to 1 for one loop.
- [`SheetSequence`](/api/Sandbox.ParticleEffect/SheetSequence): Enables or disables the use of a sheet sequence for particles.
- [`SnapToFrame`](/api/Sandbox.ParticleEffect/SnapToFrame): When enabled, snap to the nearest whole frame instead of blending between frames.
- [`Space`](/api/Sandbox.ParticleEffect/Space)
- [`StartDelay`](/api/Sandbox.ParticleEffect/StartDelay): The delay before a particle starts after being emitted, in seconds.
- [`StartVelocity`](/api/Sandbox.ParticleEffect/StartVelocity): Apply an element of random velocity to the particle when it is created, in a random direction.
- [`Stretch`](/api/Sandbox.ParticleEffect/Stretch): The stretch factor of particles, affecting their aspect ratio.
- [`TimeScale`](/api/Sandbox.ParticleEffect/TimeScale): Scales the simulation time for this effect.
- [`Timing`](/api/Sandbox.ParticleEffect/Timing): How time is updated for this effect.
- [`Tint`](/api/Sandbox.ParticleEffect/Tint): The tint color applied to particles.
- [`UsePrefabFeature`](/api/Sandbox.ParticleEffect/UsePrefabFeature): Enables or disables the use of prefabs for particles.
- [`Yaw`](/api/Sandbox.ParticleEffect/Yaw): The yaw rotation of the particles.

## Methods

- [`Clear`](/api/Sandbox.ParticleEffect/Clear)
- [`Emit`](/api/Sandbox.ParticleEffect/Emit)
- [`ResetEmitters`](/api/Sandbox.ParticleEffect/ResetEmitters)
- [`Step`](/api/Sandbox.ParticleEffect/Step)
- [`Terminate`](/api/Sandbox.ParticleEffect/Terminate)