ClearParticles

Category: Particle
Since engine version: 5.1 OC

Description

Removes all particles of the specified type.

Syntax

bool ClearParticles(string name, object obj);

Parameters

name:
[opt] Name of the particle definition of which you want to delete all particles. If not specified, all particles of all types will be removed.
obj:
[opt] If specified, only the particles local to that object are removed.

Example

ClearParticles("Smoke");
Removes all smoke.
See also: CreateParticle, PushParticles
Sven2, 2002-04