class ParticleEffect

in global :: Sandbox

Defines and holds particles. This is the core of the particle system.

public float PreWarm { get; set; }

How many seconds to pre-warm this effect by when creating

public ParticleFloat StartDelay { get; set; }

The particle can wait until it properly spawns.

public ParticleFloat SequenceId { get; set; }

Which sequence to use

public ParticleFloat SequenceTime { get; set; }

Allows control of the sequence time, which spans from 0 to 1 for one loop

public ParticleFloat SequenceSpeed { get; set; }

Increment the sequence time by this much

public List<GameObject> FollowerPrefab { get; set; }

Will choose a random prefab to spawn from this list

public ParticleFloat FollowerPrefabChance { get; set; }

If 1 then we'll always spawn a prefab. If 0.5 then we'll spawn a prefab 50% of the time.

public bool FollowerPrefabKill { get; set; }

When true the prefab will be destroyed at the end of the particle's life

public List<GameObject> CollisionPrefab { get; set; }

Will choose a random prefab to spawn from this list

public bool CollisionPrefabAlign { get; set; }

Will choose a random prefab to spawn from this list

public ParticleFloat CollisionPrefabRotation { get; set; }

We will by default align to the particle's angle, but we can also randomize that.

public ParticleFloat CollisionPrefabChance { get; set; }

If 1 then we'll always spawn a prefab. If 0.5 then we'll spawn a prefab 50% of the time.

public Action<Particle> OnParticleDestroyed { get; set; }

Called any time a particle is destroyed

public Action<Particle> OnParticleCreated { get; set; }

Called any time a particle is created

public bool Paused { get; set; }

Is the particle simulation paused?

public Action<float> OnPreStep { get; set; }

Called before the particles are stepped

public Action<float> OnPostStep { get; set; }

Called after the particles are stepped

public Action<Particle,float> OnStep { get; set; }

Called after the particles are stepped

public BBox ParticleBounds { get; }

The bounds of the current particles

public float MaxParticleSize { get; }

The biggest particle scale (x, y or z of scale)

public Particle Emit( Vector3 position, float delta )

Emit a particle at the given position.

  • position The position in which to spawn the particle
  • delta The time delta of the spawn. The first spawned particle is 0, the last spawned particle is 1. This is used to evaluate the spawn particles like lifetime and delay.
  • Returns A particle, will never be null. It's up to you to obey max particles.

public Action OnComponentDestroy { get; set; }

😔 No documentation found.

public Action OnComponentDisabled { get; set; }

😔 No documentation found.

public void DestroyGameObject( )

😔 No documentation found.

public void Destroy( )

😔 No documentation found.

public Action OnComponentStart { get; set; }

😔 No documentation found.

public Action OnComponentEnabled { get; set; }

😔 No documentation found.

public bool IsValid { get; }

😔 No documentation found.

public bool Active { get; }

😔 No documentation found.

public bool Enabled { get; set; }

😔 No documentation found.

public ComponentList Components { get; }

😔 No documentation found.

public GameObject GameObject { get; }

😔 No documentation found.

public Action OnComponentFixedUpdate { get; set; }

😔 No documentation found.

public Action OnComponentUpdate { get; set; }

😔 No documentation found.

public Scene Scene { get; }

😔 No documentation found.

public void Reset( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public Vector3 WorldScale { get; set; }

😔 No documentation found.

public Rotation WorldRotation { get; set; }

😔 No documentation found.

public Vector3 WorldPosition { get; set; }

😔 No documentation found.

public Transform WorldTransform { get; set; }

😔 No documentation found.

public void DeserializeImmediately( JsonObject node )

😔 No documentation found.

public void Deserialize( JsonObject node )

😔 No documentation found.

public JsonNode Serialize( GameObject.SerializeOptions options = null )

😔 No documentation found.

public bool IsProxy { get; }

😔 No documentation found.

public GameObject.NetworkAccessor Network { get; }

😔 No documentation found.

public Vector3 LocalScale { get; set; }

😔 No documentation found.

public Rotation LocalRotation { get; set; }

😔 No documentation found.

public Vector3 LocalPosition { get; set; }

😔 No documentation found.

public Transform LocalTransform { get; set; }

😔 No documentation found.

public Guid Id { get; }

😔 No documentation found.

public T GetComponentInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public IEnumerable<T> GetComponentsInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public T GetComponentInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public IEnumerable<T> GetComponentsInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public IEnumerable<T> GetComponents( bool includeDisabled = False )

😔 No documentation found.

public T GetComponent( bool includeDisabled = False )

😔 No documentation found.

public T GetOrAddComponent( bool startEnabled = True )

😔 No documentation found.

public T AddComponent( bool startEnabled = True )

😔 No documentation found.

public ComponentFlags Flags { get; set; }

😔 No documentation found.

public DebugOverlaySystem DebugOverlay { get; }

😔 No documentation found.

public void Invoke( float secondsDelay, Action action, CancellationToken ct = null )

😔 No documentation found.

public ITagSet Tags { get; }

😔 No documentation found.

public GameTransform Transform { get; }

😔 No documentation found.

public void EditLog( string name, object source )

😔 No documentation found.

public ParticleEffect( )

😔 No documentation found.

public int ComponentVersion { get; }

😔 No documentation found.

public bool Force { get; set; }

😔 No documentation found.

public ParticleFloat Stretch { get; set; }

😔 No documentation found.

public ParticleFloat Scale { get; set; }

😔 No documentation found.

public bool ApplyShape { get; set; }

😔 No documentation found.

public ParticleFloat Alpha { get; set; }

😔 No documentation found.

public ParticleFloat Brightness { get; set; }

😔 No documentation found.

public ParticleGradient Gradient { get; set; }

😔 No documentation found.

public Color Tint { get; set; }

😔 No documentation found.

public bool ApplyAlpha { get; set; }

😔 No documentation found.

public Vector3 ForceDirection { get; set; }

😔 No documentation found.

public bool ApplyColor { get; set; }

😔 No documentation found.

public ParticleFloat Yaw { get; set; }

😔 No documentation found.

public ParticleFloat Pitch { get; set; }

😔 No documentation found.

public bool ApplyRotation { get; set; }

😔 No documentation found.

public ParticleEffect.SimulationSpace Space { get; set; }

😔 No documentation found.

public ParticleFloat Damping { get; set; }

😔 No documentation found.

public ParticleFloat StartVelocity { get; set; }

😔 No documentation found.

public ParticleFloat PerParticleTimeScale { get; set; }

😔 No documentation found.

public float TimeScale { get; set; }

😔 No documentation found.

public ParticleFloat Lifetime { get; set; }

😔 No documentation found.

public ParticleFloat Roll { get; set; }

😔 No documentation found.

public int MaxParticles { get; set; }

😔 No documentation found.

public ParticleFloat ForceScale { get; set; }

😔 No documentation found.

public void Terminate( Particle p )

😔 No documentation found.

public Particle Emit( Vector3 position )

😔 No documentation found.

public void Step( float timeDelta )

😔 No documentation found.

public void ResetEmitters( )

😔 No documentation found.

public void Clear( )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public bool IsFull { get; }

😔 No documentation found.

public int ParticleCount { get; }

😔 No documentation found.

public List<Particle> DelayedParticles { get; }

😔 No documentation found.

public List<Particle> Particles { get; }

😔 No documentation found.

public ParticleVector3 OrbitalForce { get; set; }

😔 No documentation found.

public bool UsePrefabFeature { get; set; }

😔 No documentation found.

public ParticleFloat PushStrength { get; set; }

😔 No documentation found.

public ParticleFloat Bumpiness { get; set; }

😔 No documentation found.

public ParticleFloat Friction { get; set; }

😔 No documentation found.

public ParticleFloat Bounce { get; set; }

😔 No documentation found.

public TagSet CollisionIgnore { get; set; }

😔 No documentation found.

public float CollisionRadius { get; set; }

😔 No documentation found.

public ParticleFloat DieOnCollisionChance { get; set; }

😔 No documentation found.

public bool Collision { get; set; }

😔 No documentation found.

public ParticleEffect.SimulationSpace ForceSpace { get; set; }

😔 No documentation found.

public bool SheetSequence { get; set; }

😔 No documentation found.

public ParticleFloat OrbitalPull { get; set; }

😔 No documentation found.