public class Sandbox.SceneParticles : Sandbox.SceneObjectObsolete
A SceneObject used to render particles. We need to be careful with what we do here, because this object is created for in-engine particles as well as custom scene object particles. With custom particles there's no automatic Simulate, or deletion.. You're completely on your own. This is perhaps a good thing though, it's maybe what you want to happen. To be completely isolated and completely in control. But at the same time maybe it's not and it's something we need to sort out.
Obsolete
This API type is obsolete.
Constructors
Showing 2 constructors
No results match this filter.
Methods
Showing 10 methods
public void Emit(int count)
Manually emit a bunch of particles
public Vector3 GetControlPointPosition(int index)
Returns the position set on a given control point.
Parameters
index: The control point index. Range is 0-63.
public bool IsControlPointSet(int index)
Whether given control point has any data set.
Parameters
index: The control point index. Range is 0-63.
public void SetNamedValue(string name, Vector3 value)
Set vector on given named value.
Parameters
name: The name of the key.value: The value to set.
public void Simulate(float f)
Simulate the particles for given amount of time.
Parameters
f: Amount of time has passed since last simulation.
No results match this filter.
Properties
Showing 8 properties
public int Sandbox.SceneParticles.ActiveParticlesSelf { get; set; }
The amount of particles
public int Sandbox.SceneParticles.ActiveParticlesTotal { get; set; }
The amount of particles including child systems
public bool Sandbox.SceneParticles.EmissionStopped { get; set; }
Stop (or start) the particle system emission.
public bool Sandbox.SceneParticles.Finished { get; set; }
True if particle system has reached the end
public int Sandbox.SceneParticles.MaximumParticles { get; set; }
The total allowed particle count
public Sandbox.PhysicsWorld Sandbox.SceneParticles.PhysicsWorld { get; set; }
Particle collisions use this physics world to perform traces.
public bool Sandbox.SceneParticles.RenderParticles { get; set; }
Whether to render the particles or not.
public float Sandbox.SceneParticles.SimulationTime { get; set; }
Get or set the simulation time
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.SceneParticles |