Class ColorBySpeedModule

Color by speed module

Export

ColorBySpeedModule

Date

2024.4.3

Author

yisky

Hierarchy (view full)

ParticleModule
- ColorBySpeedModule

Index

Constructors

Properties

_enable _system color range

Accessors

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

new ColorBySpeedModule(): ColorBySpeedModule
Returns ColorBySpeedModule
Inherited from ParticleModule.constructor

Properties

`Protected`_enable

_enable: boolean = false

`Protected`_system

_system: ParticleSystem

color

color: MinMaxGradient = ...

The gradient that controls the particle colors.

Memberof

ColorBySpeedModule

range

range: Vector2 = ...

Apply the color gradient between these minimum and maximum speeds.

Memberof

ColorBySpeedModule

Accessors

enable

get enable(): boolean
Specifies whether enable the module.

Returns boolean
Memberof
ParticleModule

Inherited from ParticleModule.enable
set enable(value): void
Specifies whether enable the module.
Parameters
- value: boolean
Returns void
Memberof
ParticleModule

Inherited from ParticleModule.enable

system

get system(): ParticleSystem
Get the particle system.

Returns ParticleSystem
Memberof
ParticleModule

Inherited from ParticleModule.system

Methods

`Protected`_onDisable

_onDisable(): void
Protected
Disable callback

Returns void
Memberof
ParticleModule

Inherited from ParticleModule._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable callback

Returns void
Memberof
ParticleModule

Inherited from ParticleModule._onEnable

`Protected`_serialize

_serialize(meta): void
Protected
Serialize
Parameters
- meta: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void
Memberof
ColorBySpeedModule

Overrides ParticleModule._serialize

dispose

dispose(): void
Dispose module.

Returns void
Memberof
ParticleModule

Inherited from ParticleModule.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from ParticleModule.emit

fromJSON

fromJSON(json): void
Deserialize
Parameters
- json: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void
Memberof
ColorBySpeedModule

Overrides ParticleModule.fromJSON

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

Inherited from ParticleModule.off

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

Inherited from ParticleModule.on

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

Inherited from ParticleModule.once

toJSON

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

Returns {
[key: string]: any;
}
- [key: string]: any
Memberof
ParticleModule

Inherited from ParticleModule.toJSON