Class ParticleSubEmittersModule

Script interface for the SubEmittersModule.

The sub-emitters module allows you to spawn particles in child emitters from the positions of particles in the parent system.

This module triggers child particle emission on events such as the birth, death, and collision of particles in the parent system.

Hierarchy

ParticleModule
- ParticleSubEmittersModule

Constructors

constructor

new ParticleSubEmittersModule(target?: any): ParticleSubEmittersModule
Parameters
- Optional target: any
Returns ParticleSubEmittersModule
Inherited from ParticleModule.constructor
- Defined in src/event/EventEmitter.ts:56

Properties

enabled

enabled: boolean = false

是否开启

particleSystem

particleSystem: ParticleSystem3D

粒子系统

`Private` subEmitters

subEmitters: {
    emitProbability: number;
    properties: ParticleSystemSubEmitterProperties;
    subEmitter: ParticleSystem3D;
    type: ParticleSystemSubEmitterType;
}[] = []

Accessors

subEmittersCount

get subEmittersCount(): number
The total number of sub-emitters.

Returns number
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:21

Methods

AddSubEmitter

AddSubEmitter(subEmitter: ParticleSystem3D, type: ParticleSystemSubEmitterType, properties: ParticleSystemSubEmitterProperties, emitProbability: number): void
Add a new sub-emitter.
Parameters
- subEmitter: ParticleSystem3D
- type: ParticleSystemSubEmitterType
- properties: ParticleSystemSubEmitterProperties
- emitProbability: number
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:31

GetSubEmitterEmitProbability

GetSubEmitterEmitProbability(index: number): number
Gets the probability that the sub-emitter emits particles.
Parameters
- index: number
  
  The index of the sub-emitter.
Returns number
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:43

GetSubEmitterProperties

GetSubEmitterProperties(index: number): ParticleSystemSubEmitterProperties
Gets the properties of the sub - emitter at the given index.
Parameters
- index: number
  
  The index of the sub-emitter.
Returns ParticleSystemSubEmitterProperties
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:55

GetSubEmitterSystem

GetSubEmitterSystem(index: number): ParticleSystem3D
Gets the sub - emitter Particle System at the given index.
Parameters
- index: number
  
  The index of the desired sub-emitter.
Returns ParticleSystem3D
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:67

GetSubEmitterType

GetSubEmitterType(index: number): ParticleSystemSubEmitterType
Gets the type of the sub - emitter at the given index.
Parameters
- index: number
  
  The index of the desired sub-emitter.
Returns ParticleSystemSubEmitterType
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:79

RemoveSubEmitter

RemoveSubEmitter(index: number): void
Removes a sub - emitter from the given index in the array.
Parameters
- index: number
  
  The index of the desired sub-emitter.
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:91

SetSubEmitterEmitProbability

SetSubEmitterEmitProbability(index: number, emitProbability: number): void
Sets the probability that the sub - emitter emits particles.
Parameters
- index: number
  
  The index of the sub-emitter you want to modify.
- emitProbability: number
  
  The probability value.
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:103

SetSubEmitterProperties

SetSubEmitterProperties(index: number, properties: ParticleSystemSubEmitterProperties): void
Sets the properties of the sub - emitter at the given index.
Parameters
- index: number
  
  The index of the sub-emitter you want to modify.
- properties: ParticleSystemSubEmitterProperties
  
  The new properties to assign to this sub-emitter.
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:115

SetSubEmitterSystem

SetSubEmitterSystem(index: number, subEmitter: ParticleSystem3D): void
Sets the Particle System to use as the sub - emitter at the given index.
Parameters
- index: number
- subEmitter: ParticleSystem3D
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:124

SetSubEmitterType

SetSubEmitterType(index: number, type: ParticleSystemSubEmitterType): void
Sets the type of the sub - emitter at the given index.
Parameters
- index: number
  
  The index of the sub-emitter you want to modify.
- type: ParticleSystemSubEmitterType
  
  The new spawning type to assign to this sub-emitter.
Returns void
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:136

broadcast

broadcast<K>(type: K, data?: any): IEvent<any>
将事件广播到下级对象中。

Returns
返回广播后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
Inherited from ParticleModule.broadcast
- Defined in src/event/EventEmitter.ts:176

bubbles

bubbles<K>(type: K, data?: any): IEvent<any>
将事件冒泡到上级对象中。

Returns
返回冒泡后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
Returns IEvent<any>
Inherited from ParticleModule.bubbles
- Defined in src/event/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
Inherited from ParticleModule.dispose
- Defined in src/event/EventEmitter.ts:535

emit

emit<K>(type: K, data?: any, bubbles?: boolean, broadcast?: boolean, share?: boolean): IEvent<any>
发射事件。

Returns
返回发射后的事件。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: any
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<any>
Inherited from ParticleModule.emit
- Defined in src/event/EventEmitter.ts:145

emitEvent

emitEvent<K>(event: IEvent<any>): IEvent<any>
发射事件。

当事件重复流向一个对象时将不会被处理。

Returns
返回事件是否被处理
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件对象
Returns IEvent<any>
Inherited from ParticleModule.emitEvent
- Defined in src/event/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends string
Returns K[]
Inherited from ParticleModule.eventNames
- Defined in src/event/EventEmitter.ts:70

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event: IEvent<any>): void
向下级广播事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventBroadcast
- Defined in src/event/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event: IEvent<any>): void
向上级报告事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventBubbles
- Defined in src/event/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event: IEvent<any>): void
向平级分享事件
Type Parameters
- K extends string
Parameters
- event: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handelEventShare
- Defined in src/event/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e: IEvent<any>): void
处理事件
Type Parameters
- K extends string
Parameters
- e: IEvent<any>
  
  事件
Returns void
Inherited from ParticleModule.handleEvent
- Defined in src/event/EventEmitter.ts:389

has

has<K>(type: K): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.

Returns
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns boolean
Inherited from ParticleModule.has
- Defined in src/event/EventEmitter.ts:200

initParticleState

initParticleState(_particle: Particle): void
初始化粒子状态
Parameters
- _particle: Particle
  
  粒子
Returns void
Inherited from ParticleModule.initParticleState
- Defined in src/3d/particlesystem/modules/ParticleModule.ts:53

listenerCount

listenerCount<K>(type: K): number
返回指定事件类型的监听数量。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from ParticleModule.listenerCount
- Defined in src/event/EventEmitter.ts:82

off

off<K>(type?: K, listener?: ((event: IEvent<any>) => void), thisObject?: any): ParticleSubEmittersModule
移除监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event: IEvent<any>) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.off
- Defined in src/event/EventEmitter.ts:253

offAll

offAll<K>(type?: K): ParticleSubEmittersModule
移除所有监听
Type Parameters
- K extends string
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.offAll
- Defined in src/event/EventEmitter.ts:303

offAny

offAny<K>(listener?: ((event: IEvent<any>) => void), thisObject?: any): ParticleSubEmittersModule
移除监听对象的任意事件。
Type Parameters
- K extends string
Parameters
- Optional listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.offAny
- Defined in src/event/EventEmitter.ts:353

on

on<K>(type: K, listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number, once?: boolean): ParticleSubEmittersModule
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.on
- Defined in src/event/EventEmitter.ts:214

onAny

onAny<K>(listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number, once?: boolean): ParticleSubEmittersModule
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends string
Parameters
- listener: ((event: IEvent<any>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.onAny
- Defined in src/event/EventEmitter.ts:318

once

once<K>(type: K, listener: ((event: IEvent<any>) => void), thisObject?: any, priority?: number): ParticleSubEmittersModule
监听一次事件后将会被移除
Type Parameters
- K extends string
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<any>) => void)
  
  处理事件的侦听器函数。
  - - (event: IEvent<any>): void
    - Parameters
      
      event: IEvent<any>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns ParticleSubEmittersModule
Inherited from ParticleModule.once
- Defined in src/event/EventEmitter.ts:95

update

update(_interval: number): void
更新
Parameters
- _interval: number
Returns void
Inherited from ParticleModule.update
- Defined in src/3d/particlesystem/modules/ParticleModule.ts:72

updateParticleState

updateParticleState(particle: Particle): void
更新粒子状态
Parameters
- particle: Particle
  
  粒子
Returns void
Overrides ParticleModule.updateParticleState
- Defined in src/3d/particlesystem/modules/ParticleSubEmittersModule.ts:146

`Static` getEventEmitter

getEventEmitter(target: any): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from ParticleModule.getEventEmitter
- Defined in src/event/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target: any): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from ParticleModule.getOrCreateEventEmitter
- Defined in src/event/EventEmitter.ts:44

Class ParticleSubEmittersModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional target: any

Returns ParticleSubEmittersModule

Properties

enabled

particleSystem

Private subEmitters

Accessors

subEmittersCount

Returns number

Methods

AddSubEmitter

Parameters

subEmitter: ParticleSystem3D

type: ParticleSystemSubEmitterType

properties: ParticleSystemSubEmitterProperties

emitProbability: number

Returns void

GetSubEmitterEmitProbability

Parameters

index: number

Returns number

GetSubEmitterProperties

Parameters

index: number

Returns ParticleSystemSubEmitterProperties

GetSubEmitterSystem

Parameters

index: number

Returns ParticleSystem3D

GetSubEmitterType

Parameters

index: number

Returns ParticleSystemSubEmitterType

RemoveSubEmitter

Parameters

index: number

Returns void

SetSubEmitterEmitProbability

Parameters

index: number

emitProbability: number

Returns void

SetSubEmitterProperties

Parameters

index: number

properties: ParticleSystemSubEmitterProperties

Returns void

SetSubEmitterSystem

Parameters

index: number

subEmitter: ParticleSystem3D

Returns void

SetSubEmitterType

Parameters

index: number

type: ParticleSystemSubEmitterType

Returns void

broadcast

Returns

Type Parameters

K extends string

Parameters

type: K

Optional data: any

Returns IEvent<any>

bubbles

Returns

Type Parameters

K extends string

Parameters

`Optional` target: any

`Private` subEmitters

`Optional` data: any

`Optional` data: any

`Optional` data: any

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent