Api Sandbox ParticleSystem
class

ParticleSystem

public sealed class ParticleSystem : Resource

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

Attributes

[ Obsolete ]

Constructors

ParticleSystem()

Properties

Name Type Description
IsValid virtual Boolean
IsError Boolean Whether the particle system is invalid, or has not yet loaded.
Name String Particle system file name.
Bounds BBox Static bounding box of the resource.
ChildCount Int32 How many child particle systems do we have

Methods

ParticleSystem GetChild(Int32 index)

Returns child particle at given index.

index — Index of child particle system, starting at 0.
returns — Particle system
ArgumentOutOfRangeException — Thrown when given index exceeds range of [0,ChildCount-1]
static ParticleSystem Load(String filename)

Loads a particle system from given file.

static Task<ParticleSystem> LoadAsync(String filename)

Load a particle system by file path.

filename — The file path to load as a particle system.
returns — The loaded particle system, or null
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.ParticleSystem