ParticleSpawnTrigger Class

    Namespace: Stride.Particles.Spawners
    Assembly: Stride.Particles.dll
    ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent
    System.Object → ParticleSpawnTrigger
    Derived from ParticleSpawnTrigger: ParticleSpawnTrigger<T> 

    public abstract class ParticleSpawnTrigger
    Name Description
    Methods
    AddRequiredParentFields(ParticleEmitter)

    Override to add the required fields to the parent emitter
    HasTriggered(Particle)

    For positive values, shows if the condition was met and how much is the magnitude
    PrepareFromPool(ParticlePool)

    Prepares fields accessors before the

    RemoveRequiredParentFields(ParticleEmitter)

    Override to remove the required fields from the parent emitter
    | Improve this Doc View Source

    Methods

    AddRequiredParentFields(ParticleEmitter)

    Override to add the required fields to the parent emitter

    public virtual void AddRequiredParentFields(ParticleEmitter parentEmitter)
    Parameters
    Type Name Description
    ParticleEmitter parentEmitter

    Parent emitter to which required fields should be added

    HasTriggered(Particle)

    For positive values, shows if the condition was met and how much is the magnitude

    public abstract float HasTriggered(Particle parentParticle)
    Parameters
    Type Name Description
    Particle parentParticle

    Parent particle which attributes are used for testing
    Returns
    Type Description
    System.Single

    0f if it hasn't triggered, positive value otherwise, which also indicates the magnitude of the trigger

    PrepareFromPool(ParticlePool)

    Prepares fields accessors before the 

    public abstract void PrepareFromPool(ParticlePool pool)
    Parameters
    Type Name Description
    ParticlePool pool

    RemoveRequiredParentFields(ParticleEmitter)

    Override to remove the required fields from the parent emitter

    public virtual void RemoveRequiredParentFields(ParticleEmitter parentEmitter)
    Parameters
    Type Name Description
    ParticleEmitter parentEmitter

    Parent emitter from which required fields should be removed

    Extension Methods