Class Behaviour

constructor

• new Behaviour(
      life?: number,
      easing?: EasingFunction,
      type?: string,
      isEnabled?: boolean,
  ): Behaviour

  Parameters

  • life: number = Infinity
  • easing: EasingFunction = DEFAULT_BEHAVIOUR_EASING
  • type: string = BEHAVIOUR_TYPE_ABSTRACT
  • isEnabled: boolean = true

  Returns Behaviour

_life

age

dead

easing

energy

id

isEnabled

type

life

• get life(): number

  Gets the behaviour's life.

  Returns number

• set life(life: number): void

  Ensures that life is infinity if an invalid value is supplied.

  Parameters

  • life: number

  Returns void

applyBehaviour

• applyBehaviour(target: Particle | Emitter, time: number, index?: number): void

  Apply behaviour to the target as a factor of time.

  Parameters

  • target: Particle | Emitter
  • time: number
  • Optionalindex: number

  Returns void

Abstractdestroy

• destroy(): void

  Destroy this behaviour.

  Returns void

energize

• energize(particle: Particle, time: number, index?: number): void

  Compares the age of the behaviour vs integration time and determines if the behaviour should be set to dead or not.

  Parameters

  • particle: Particle
  • time: number
  • Optionalindex: number

  Returns void

AbstractfromJSON

• fromJSON(json: Record<string, unknown>): void

  Returns a new instance of the behaviour from the JSON object passed.

  Parameters

  • json: Record<string, unknown>

  Returns void

Abstractinitialize

• initialize(particle: Particle): void

  Set the behaviour's initial properties on the particle.

  Parameters

  • particle: Particle

  Returns void

Abstractmutate

• mutate(target: Particle | Emitter, time: number, index?: number): void

  Change the target's properties according to specific behaviour logic.

  Parameters

  • target: Particle | Emitter
  • time: number
  • Optionalindex: number

  Returns void

normalizeForce

• normalizeForce(force: Vector3D): Vector3D

  Normalize a force by 1:100.

  Parameters

  • force: Vector3D

  Returns Vector3D

normalizeValue

• normalizeValue(value: number): number

  Normalize a value by 1:100.

  Parameters

  • value: number

  Returns number

reset

• reset(life?: unknown, easing?: unknown, ...args: unknown[]): void

  Reset this behaviour's parameters.

  Parameters

  • life: unknown = DEFAULT_LIFE
  • easing: unknown = DEFAULT_BEHAVIOUR_EASING
  • ...args: unknown[]

  Returns void