API Docs for: GoblinPhysics
Show:

ForceGenerator Class

Defined in: src\classes\ForceGenerator.js:1
Module: Goblin

adds a constant force to associated objects

Constructor

ForceGenerator

(
  • force
)

Defined in src\classes\ForceGenerator.js:1

Parameters:

  • force Vec3

    [optional] force the generator applies

Item Index

Methods

Properties

Methods

affect

(
  • object
)

Defined in src\classes\ForceGenerator.js:68

adds an object to be affected by the generator

Parameters:

  • object Mixed

    object to be affected, must have applyForce method

applyForce

()

Defined in src\classes\ForceGenerator.js:37

applies force to the associated objects

disable

()

Defined in src\classes\ForceGenerator.js:60

disables the force generator

enable

()

Defined in src\classes\ForceGenerator.js:52

enables the force generator

unaffect

(
  • object
)

Defined in src\classes\ForceGenerator.js:85

removes an object from being affected by the generator

Parameters:

  • object Mixed

    object to be affected, must have applyForce method

Properties

affected

Array private

Defined in src\classes\ForceGenerator.js:27

array of objects affected by the generator

Default: []

enabled

Boolean

Defined in src\classes\ForceGenerator.js:18

whether or not the force generator is enabled

Default: true

force

Vec3

Defined in src\classes\ForceGenerator.js:9

force which will be applied to affected objects

Default: [ 0, 0, 0 ]