babylon.quarks - v1.0.0
    Preparing search index...

    Class EmitSubParticleSystem

    Emit a sub particle system from particles.

    Implements

    Index
    • Parameters

      • particleSystem: IParticleSystem

        The system this behavior belongs to (the parent).

      • useVelocityAsBasis: boolean

        Orient the sub emitter along the parent particle's velocity instead of by its rotation.

      • subParticleSystem: string | IEmitter | undefined

        The emitter of the system to emit into, or the uuid of one a loader has yet to link.

      • Optionalmode: SubParticleEmitMode

        When to emit, see SubParticleEmitMode; every step by default.

      • OptionalemitProbability: number

        Chance in [0, 1] that a parent particle emits at all; 1 by default.

      • Optionalinherit: SubEmitterInheritance[]

        See the property.

      Returns EmitSubParticleSystem

    emitProbability: number

    Which of the parent particle's properties the sub particles start from: its current colour and size multiply theirs, its rotation adds to theirs, and its remaining lifetime fraction scales theirs. A Death sub emitter ignores lifetime, since the parent has none left; Unity would give its particles no life at all.

    particleSystem: IParticleSystem
    subParticleSystem: string | IEmitter | undefined
    type: string

    The name the behavior is registered under in BehaviorTypes.

    useVelocityAsBasis: boolean
    • get targetSystem(): IParticleSystem | undefined

      The system this behavior emits into, when it is set, linked and not disposed.

      Returns IParticleSystem | undefined

    • Drops the emissions still running, as when the parent system restarts or stops: a Death emission would otherwise keep emitting where a particle of the last play died.

      Returns void

    • A copy with the same settings that shares nothing mutable with this one.

      Returns Behavior

    • Called once per step before this behavior updates the particles, with the step's length in seconds.

      Parameters

      • delta: number

      Returns void

    • Whether emissions that parent particles started into the target are still running, so the target has more particles to come. The parent is not finished while it has any.

      Returns boolean

    • Called once per particle when it is emitted; see the interface's description for when.

      Parameters

      Returns void

    • Drops the emissions still running (clearEmissions), as the parent system restarts.

      Returns void

    • Called once per live particle per step, with the step's length in seconds.

      Parameters

      Returns void