Class CollisionModule

constructor

• new CollisionModule(): CollisionModule

• Returns CollisionModule

bounce

dampen

lifetimeLoss

maxKillSpeed

minKillSpeed

bounceMultiplier

• get bounceMultiplier(): number

• A multiplier for ParticleSystem.CollisionModule.bounce.

  Returns number

  Memberof

  CollisionModule

• set bounceMultiplier(value): void

• A multiplier for ParticleSystem.CollisionModule.bounce.

  Parameters

  • value: number

  Returns void

  Memberof

  CollisionModule

dampenMultiplier

• get dampenMultiplier(): number

• Change the dampen multiplier.

  Returns number

  Memberof

  CollisionModule

• set dampenMultiplier(value): void

• Change the dampen multiplier.

  Parameters

  • value: number

  Returns void

  Memberof

  CollisionModule

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

lifetimeLossMultiplier

• get lifetimeLossMultiplier(): number

• Change the lifetime loss multiplier.

  Returns number

  Memberof

  CollisionModule

• set lifetimeLossMultiplier(value): void

• Change the lifetime loss multiplier.

  Parameters

  • value: number

  Returns void

  Memberof

  CollisionModule

radiusScale

• get radiusScale(): number

• A multiplier that Unity applies to the size of each particle before collisions are processed.

  Returns number

  Memberof

  CollisionModule

• set radiusScale(value): void

• A multiplier that Unity applies to the size of each particle before collisions are processed.

  Parameters

  • value: number

  Returns void

  Memberof

  CollisionModule

system

• get system(): ParticleSystem

• Get the particle system.

  Returns ParticleSystem

  Memberof

  ParticleModule

addPlane

• addPlane(transform): void

• Adds a collision plane to use with this Particle System.

  Parameters

  • transform: Transform

    The plane to add.

  Returns void

  Memberof

  CollisionModule

dispose

• dispose(): void

• Dispose module.

  Returns void

  Memberof

  ParticleModule

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

getPlane

• getPlane(index): Transform

• Get a collision plane associated with this Particle System.

  Parameters

  • index: number

    The plane to return.

  Returns Transform

  Memberof

  CollisionModule

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

removePlane

• removePlane(index): void

• Removes a collision plane associated with this Particle System by index.

  Parameters

  • index: number

    The collision plane index to remove.

  Returns void

  Memberof

  CollisionModule

• removePlane(transform): void

• Removes a collision plane associated with this Particle System.

  Parameters

  • transform: Transform

    The collision plane to remove.

  Returns void

  Memberof

  CollisionModule

toJSON

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

• Serialize

  Returns {
      [key: string]: any;
  }

  • [key: string]: any

  Memberof

  ParticleModule