Class SubEmittersModule

SubEmitter module

Export

SubEmittersModule

Date

2024.4.12

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system

Accessors

enable subEmittersCount system

Methods

_onDisable _onEnable _serialize _updateParticle addSubEmitter dispose emit fromJSON getSubEmitterEmitProbability getSubEmitterProperties getSubEmitterSystem getSubEmitterType off on once removeSubEmitter setSubEmitterEmitProbability setSubEmitterProperties setSubEmitterSystem setSubEmitterType toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

Accessors

enable

  • get enable(): boolean

  • Specifies whether enable the module.

    Returns boolean

    Memberof

    ParticleModule

  • set enable(value): void

  • Specifies whether enable the module.

    Parameters

    • value: boolean

    Returns void

    Memberof

    ParticleModule

subEmittersCount

  • get subEmittersCount(): number

  • The total number of sub-emitters.

    Returns number

    Memberof

    SubEmittersModule

system

Methods

Protected_onDisable

Protected_onEnable

  • _onEnable(): void
  • Protected

    Enable callback

    Returns void

    Memberof

    ParticleModule

Protected_serialize

  • _serialize(meta): void
  • Protected

    Serialize

    Parameters

    • meta: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

    Memberof

    ParticleModule

_updateParticle

  • _updateParticle(particle, deltaTime): void

  • Update particle

    Parameters

    • particle: Particle
    • deltaTime: number

    Returns void

    Memberof

    SubEmittersModule

addSubEmitter

  • addSubEmitter(subEmitter, type, properties, emitProbability?): void

  • Add a new sub-emitter.

    Parameters

    Returns void

    Memberof

    SubEmittersModule

dispose

emit

  • emit(event): void

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

fromJSON

  • fromJSON(json): void

  • Deserialize

    Parameters

    • json: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

    Memberof

    ParticleModule

getSubEmitterEmitProbability

  • getSubEmitterEmitProbability(index): number

  • Gets the probability that the sub-emitter emits particles.

    Parameters

    • index: number

      The index of the sub-emitter.

    Returns number

    Memberof

    SubEmittersModule

getSubEmitterProperties

getSubEmitterSystem

  • getSubEmitterSystem(index): ParticleSystem

  • Gets the sub - emitter Particle System at the given index.

    Parameters

    • index: number

      The index of the desired sub-emitter.

    Returns ParticleSystem

    Memberof

    SubEmittersModule

getSubEmitterType

off

  • off(type, callback?): void

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    • type: string
    • Optionalcallback: SubscriberCallbackFn

      subscriber callback

    Returns void

    Memberof

    EventDispatcher

on

  • on(type, callback, options?): void

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

once

  • once(type, callback, options?): void

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }
      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

removeSubEmitter

  • removeSubEmitter(index): void

  • Removes a sub-emitter from the given index in the array.

    Parameters

    • index: number

      The index from which to remove a sub-emitter.

    Returns void

    Memberof

    SubEmittersModule

setSubEmitterEmitProbability

  • setSubEmitterEmitProbability(index, emitProbability): 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

    Memberof

    SubEmittersModule

setSubEmitterProperties

  • setSubEmitterProperties(index, properties): void

  • Sets the properties of the sub - emitter at the given index.

    Parameters

    Returns void

    Memberof

    SubEmittersModule

setSubEmitterSystem

  • setSubEmitterSystem(index, subEmitter): void

  • Sets the Particle System to use as the sub-emitter at the given index.

    Parameters

    • index: number

      The index of the sub-emitter you want to modify.

    • subEmitter: ParticleSystem

      The Particle System to use as the sub-emitter at the specified index.

    Returns void

    Memberof

    SubEmittersModule

setSubEmitterType

  • setSubEmitterType(index, type): 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

    Memberof

    SubEmittersModule

toJSON

  • toJSON(): {
        [key: string]: any;
    }

  • Serialize

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    Memberof

    ParticleModule

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods