Force

Force

Abstract base class for environmental forces. Forces apply external influences to particle motion.

Constructor

(abstract) new Force(configopt)

Description:
  • Initializes an environmental force.
Source:
Parameters:
Name Type Attributes Default Description
config ForceConfig <optional>
{} Force configuration options.
Throws:
TypeError

Classes

Force

Members

id :string

Description:
  • Unique identifier. Defaults to a generated UUID.
Source:
Unique identifier. Defaults to a generated UUID.
Type:
  • string

Methods

(abstract) apply(_particle, _dt) → {void}

Description:
  • Applies acceleration to a particle's velocity.
Source:
Parameters:
Name Type Description
_particle Particle Particle instance to affect.
_dt number Time elapsed since the last frame (in seconds).
Throws:
Error
Returns:
Type
void