Class Gravity

_life

age

dead

easing

energy

force

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

mutate

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

  Mutates the particle.acceleration property.

  Parameters

  • particle: Particle

    the particle to apply the behaviour to

  • time: number

    engine time

  • Optionalindex: number

    the particle index

  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(fx?: number, fy?: number, fz?: number): void

  Resets the behaviour properties.

  Parameters

  • Optionalfx: number

    the x axis force

  • Optionalfy: number

    the y axis force

  • Optionalfz: number

    the z axis force

  Returns void