Interface IParticleSystem

interface IParticleSystem {
    autoDestroy: boolean;
    duration: number;
    emissionState: EmissionState;
    emitter: IEmitter;
    looping: boolean;
    particleNum: number;
    particles: IParticle[];
    paused: boolean;
    rendererEmitterSettings: RendererEmitterSettings;
    worldSpace: boolean;
    addEventListener(
        event: ParticleSystemEventType,
        callback: (event: ParticleSystemEvent) => void,
    ): void;
    clone(): IParticleSystem;
    emit(delta: number, subEmissionState: EmissionState, matrix: Matrix4): void;
    endEmit(): void;
    pause(): void;
    play(): void;
    removeAllEventListeners(event: ParticleSystemEventType): void;
    removeEventListener(
        event: ParticleSystemEventType,
        callback: (event: ParticleSystemEvent) => void,
    ): void;
    restart(): void;
    stop(): void;
    toJSON(metaData: any, options: SerializationOptions): any;
}

Properties

autoDestroy

autoDestroy: boolean

Whether the ParticleSystem should be automatically disposed when it finishes emitting particles.

duration

duration: number

Duration of the system.

emissionState

emissionState: EmissionState

emitter

emitter: IEmitter

Emitter for the particles.

looping

looping: boolean

Whether the system is looping.

particleNum

particleNum: number

Number of particles.

particles

particles: IParticle[]

Array of particles.

paused

paused: boolean

rendererEmitterSettings

rendererEmitterSettings: RendererEmitterSettings

Optional renderer.

worldSpace

worldSpace: boolean

Whether the system is in world space.

Methods

addEventListener

addEventListener(
event: ParticleSystemEventType,
callback: (event: ParticleSystemEvent) => void,
): void
Parameters
- event: ParticleSystemEventType
- callback: (event: ParticleSystemEvent) => void
Returns void
- Defined in IParticleSystem.ts:162

clone

clone(): IParticleSystem
Returns IParticleSystem
- Defined in IParticleSystem.ts:156

emit

emit(delta: number, subEmissionState: EmissionState, matrix: Matrix4): void
Parameters
- delta: number
- subEmissionState: EmissionState
- matrix: Matrix4
Returns void
- Defined in IParticleSystem.ts:160

endEmit

endEmit(): void
Returns void
- Defined in IParticleSystem.ts:154

pause

pause(): void
Returns void
- Defined in IParticleSystem.ts:150

play

play(): void
Returns void
- Defined in IParticleSystem.ts:152

removeAllEventListeners

removeAllEventListeners(event: ParticleSystemEventType): void
Parameters
- event: ParticleSystemEventType
Returns void
- Defined in IParticleSystem.ts:164

removeEventListener

removeEventListener(
event: ParticleSystemEventType,
callback: (event: ParticleSystemEvent) => void,
): void
Parameters
- event: ParticleSystemEventType
- callback: (event: ParticleSystemEvent) => void
Returns void
- Defined in IParticleSystem.ts:163

restart

restart(): void
Returns void
- Defined in IParticleSystem.ts:153

stop

stop(): void
Returns void
- Defined in IParticleSystem.ts:151

toJSON

toJSON(metaData: any, options: SerializationOptions): any
Parameters
- metaData: any
- options: SerializationOptions
Returns any
- Defined in IParticleSystem.ts:158