public abstract class Sandbox.ParticleEmitter : Sandbox.Component
Creates particles. Should be attached to a `Sandbox.ParticleEffect`.
Related Guides
Broader workflow and conceptual references connected to this API.
Constructors
Showing 1 constructors
protected ParticleEmitter()
No results match this filter.
Methods
Showing 8 methods
public virtual bool Emit(Sandbox.ParticleEffect target)
Implementations
protected virtual void EmitOverDistance()
protected virtual int GetBurstCount()
Allows child emitters to override how many particles are in a burst
Implementations
protected virtual int GetRateCount()
Allows child emitters to override how many particles are in a rate
Implementations
protected virtual void OnBurst()
protected virtual void OnDisabled()
protected virtual void OnEnabled()
public void ResetEmitter()
No results match this filter.
Properties
Showing 10 properties
public Sandbox.ParticleFloat Sandbox.ParticleEmitter.Burst { get; set; }
How many particles to emit, in a burst
public Sandbox.ParticleFloat Sandbox.ParticleEmitter.Delay { get; set; }
How many seconds to wait before the emitter starts
public float Sandbox.ParticleEmitter.Delta { get; set; }
0-1, the life time of the emitter
public bool Sandbox.ParticleEmitter.DestroyOnEnd { get; set; }
Whether to destroy the GameObject when the emitter finishes (only applies when Loop is false)
public Sandbox.ParticleFloat Sandbox.ParticleEmitter.Duration { get; set; }
How long the emitter should run for, after the Delay
public float Sandbox.ParticleEmitter.EmitRandom { get; set; }
0-1, a random number to be used for this loop of the emitter
public bool Sandbox.ParticleEmitter.IsBursting { get; set; }
True if we're doing a burst
public bool Sandbox.ParticleEmitter.Loop { get; set; }
Whether the emitter should restart after finishing
public Sandbox.ParticleFloat Sandbox.ParticleEmitter.Rate { get; set; }
How many particles to emit over time
public Sandbox.ParticleFloat Sandbox.ParticleEmitter.RateOverDistance { get; set; }
How many particles to emit per 100 units moved
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.ParticleEmitter |