API ReferenceSandbox
public sealed class Sandbox.ParticleSystem : Sandbox.ResourceObsolete
A particle effect system that allows for complex visual effects, such as explosions, muzzle flashes, impact effects, etc.
Obsolete
This API type is obsolete.
Constructors
Showing 1 constructors
public ParticleSystem()
No results match this filter.
Methods
Showing 3 methods
public Sandbox.ParticleSystem GetChild(int index)
Returns child particle at given index.
Parameters
index: Index of child particle system, starting at 0.
Returns
Particle system
Exceptions
| Exception | Condition |
|---|---|
ArgumentOutOfRangeException | Thrown when given index exceeds range of [0,ChildCount-1] |
public static Sandbox.ParticleSystem Load(string filename)Obsolete
Loads a particle system from given file.
Obsolete: This API member is obsolete.
public static System.Threading.Tasks.Task`1<Sandbox.ParticleSystem> LoadAsync(string filename)Obsolete
Load a particle system by file path.
Obsolete: This API member is obsolete.
Parameters
filename: The file path to load as a particle system.
Returns
The loaded particle system, or null
No results match this filter.
Properties
Showing 5 properties
public BBox Sandbox.ParticleSystem.Bounds { get; set; }
Static bounding box of the resource.
public int Sandbox.ParticleSystem.ChildCount { get; set; }
How many child particle systems do we have
public bool Sandbox.ParticleSystem.IsError { get; set; }
Whether the particle system is invalid, or has not yet loaded.
public virtual bool Sandbox.ParticleSystem.IsValid { get; set; }
public string Sandbox.ParticleSystem.Name { get; set; }
Particle system file name.
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.ParticleSystem |