Class ParticleSpawnTrigger

Namespace

Stride.Particles.Spawners

Assembly

Stride.Particles.dll

ParticleSpawnTrigger governs the condition under which particle emission is triggered for spawners like SpawnerFromParent

public abstract class ParticleSpawnTrigger

Inheritance

object

ParticleSpawnTrigger

Derived

ParticleSpawnTrigger<T>

Methods

AddRequiredParentFields(ParticleEmitter)

Override to add the required fields to the parent emitter

public virtual void AddRequiredParentFields(ParticleEmitter parentEmitter)

Parameters

parentEmitter ParticleEmitter

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

parentParticle Particle

Parent particle which attributes are used for testing

Returns

float

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

pool ParticlePool

RemoveRequiredParentFields(ParticleEmitter)

Override to remove the required fields from the parent emitter

public virtual void RemoveRequiredParentFields(ParticleEmitter parentEmitter)

Parameters

parentEmitter ParticleEmitter

Parent emitter from which required fields should be removed