class SceneParticles

in global :: Sandbox

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.

public SceneParticles( SceneWorld world, string particleSystem )

Create scene particles.

  • world The scene world to create the particles in.
  • particleSystem Path to the particle system file.

public SceneParticles( SceneWorld world, ParticleSystem particleSystem )

Create scene particles.

  • world The scene world to create the particles in.
  • particleSystem Particle system resource.

public bool RenderParticles { get; set; }

Whether to render the particles or not.

public bool EmissionStopped { get; set; }

Stop (or start) the particle system emission.

public PhysicsWorld PhysicsWorld { set; }

Particle collisions use this physics world to perform traces.

public bool IsControlPointSet( int index )

Whether given control point has any data set.

  • index The control point index. Range is 0-63.

public Vector3 GetControlPointPosition( int index )

Returns the position set on a given control point.

  • index The control point index. Range is 0-63.

public void SetControlPoint( int i, Vector3 position )

Set position on given control point.

  • i The control point index. Range is 0-63.
  • position The position to set.

public void SetControlPoint( int i, Rotation rotation )

Set rotation on given control point.

  • i The control point index. Range is 0-63.
  • rotation The rotation to set.

public void SetControlPoint( int i, Transform transform )

Set transform on given control point.

  • i The control point index. Range is 0-63.
  • transform The transform to set.

public void SetControlPoint( int i, ParticleSnapshot snapshot )

Set snapshot on given control point.

  • i The control point index. Range is 0-63.
  • snapshot The snapshot to set.

public void SetControlPoint( int i, Model model )

Set model on given control point.

  • i The control point index. Range is 0-63.
  • model The model to set.

public void SetNamedValue( string name, Vector3 value )

Set vector on given named value.

  • name The name of the key.
  • value The value to set.

public void Simulate( float f )

Simulate the particles for given amount of time.

  • f Amount of time has passed since last simulation.

public int ActiveParticlesSelf { get; }

The amount of particles

public int ActiveParticlesTotal { get; }

The amount of particles including child systems

public int MaximumParticles { get; }

The total allowed particle count

public void Emit( int count )

Manually emit a bunch of particles

public bool Finished { get; }

True if particle system has reached the end

public float SimulationTime { get; set; }

Get or set the simulation time

public void ClearMaterialOverride( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public ITagSet Tags { get; }

😔 No documentation found.

public SceneRenderLayer RenderLayer { get; set; }

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public SceneObject.SceneObjectFlagAccessor Flags { get; }

😔 No documentation found.

public bool Batchable { get; set; }

😔 No documentation found.

public void SetMaterialGroup( string name )

😔 No documentation found.

public void SetMaterialOverride( Material material, string attributeName, int attributeValue = 1 )

😔 No documentation found.

public void SetMaterialOverride( Material material )

😔 No documentation found.

public bool ClipPlaneEnabled

😔 No documentation found.

public Model Model { get; set; }

😔 No documentation found.

public void RemoveChild( SceneObject child )

😔 No documentation found.

public void AddChild( string name, SceneObject child )

😔 No documentation found.

public SceneObject Parent { get; }

😔 No documentation found.

public Color ColorTint { get; set; }

😔 No documentation found.

public bool RenderingEnabled { get; set; }

😔 No documentation found.

public BBox LocalBounds { get; set; }

😔 No documentation found.

public Plane ClipPlane

😔 No documentation found.

public Vector3 Position { get; set; }

😔 No documentation found.

public Rotation Rotation { get; set; }

😔 No documentation found.

public Transform Transform { get; set; }

😔 No documentation found.

public void Delete( )

😔 No documentation found.

public SceneWorld World { get; }

😔 No documentation found.

public RenderAttributes Attributes { get; }

😔 No documentation found.

public ulong MeshGroupMask { get; set; }

😔 No documentation found.

public BBox Bounds { get; set; }

😔 No documentation found.