s&box docs
API ReferenceSandbox

ParticleSystemclass

A particle effect system that allows for complex visual effects, such as explosions, muzzle flashes, impact effects, etc.

object→Resource→ParticleSystem
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.ParticleSystem : Sandbox.Resource

Obsolete

This API type is obsolete.

Constructors1

Showing 1 constructors

Methods3

Showing 3 methods

public Sandbox.ParticleSystem GetChild(int index)PUBLIC

Returns child particle at given index.

ParameterTypeDescription
indexintIndex of child particle system, starting at 0.
Returns:ParticleSystemParticle system

Exceptions

ExceptionCondition
ArgumentOutOfRangeExceptionThrown when given index exceeds range of [0,ChildCount-1]

public static Sandbox.ParticleSystem Load(string filename)PUBLICSTATICOBSOLETE

Loads a particle system from given file.

Obsolete: This API member is obsolete.

ParameterTypeDescription
filenamestring—
Returns:ParticleSystem—

public static System.Threading.Tasks.Task`1<Sandbox.ParticleSystem> LoadAsync(string filename)PUBLICSTATICOBSOLETE

Load a particle system by file path.

Obsolete: This API member is obsolete.

ParameterTypeDescription
filenamestringThe file path to load as a particle system.
Returns:Task<ParticleSystem>The loaded particle system, or null

Properties5

Showing 5 properties

public BBox Sandbox.ParticleSystem.Bounds { get; set; }PUBLICGETSET

Static bounding box of the resource.

Returns:BBox—

public int Sandbox.ParticleSystem.ChildCount { get; set; }PUBLICGETSET

How many child particle systems do we have

Returns:int—

public virtual bool Sandbox.ParticleSystem.IsError { get; set; }PUBLICVIRTUALGETSET

Whether the particle system is invalid, or has not yet loaded.

Returns:bool—

public virtual bool Sandbox.ParticleSystem.IsValid { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public string Sandbox.ParticleSystem.Name { get; set; }PUBLICGETSET

Particle system file name.

Returns:string—

SetAnimation()

Previous Page

Bounds

Next Page

On this page

Constructorspublic ParticleSystem()Methodspublic Sandbox.ParticleSystem GetChild(System.Int32 index)public static Sandbox.ParticleSystem Load(System.String filename)public static System.Threading.Tasks.Task`1<Sandbox.ParticleSystem> LoadAsync(System.String filename)Propertiespublic BBox Sandbox.ParticleSystem.Bounds { get; set; }public System.Int32 Sandbox.ParticleSystem.ChildCount { get; set; }public virtual System.Boolean Sandbox.ParticleSystem.IsError { get; set; }public virtual System.Boolean Sandbox.ParticleSystem.IsValid { get; set; }public System.String Sandbox.ParticleSystem.Name { get; set; }Metadata