Class Joint

constructor

• new Joint(spriteA: Sprite, spriteB: Sprite, type?: string): Joint

  Don't use the Joint constructor directly, use one of these joint constructors instead:

  GlueJoint, DistanceJoint, WheelJoint, HingeJoint, SliderJoint, or GrabberJoint.

  Parameters

  • spriteA: Sprite
  • spriteB: Sprite
  • Optionaltype: string

  Returns Joint

jID

spriteA

spriteB

type

visible

true
Copy

collideConnected

• get collideConnected(): boolean

  Set to true if you want the joint's sprites to collide with each other.

  Returns boolean

  Default

  false
  Copy

• set collideConnected(val: boolean): void

  Parameters

  • val: boolean

  Returns void

draw

• get draw(): Function

  Function that draws the joint. Can be overridden by the user.

  Returns Function

• set draw(val: Function): void

  Parameters

  • val: Function

  Returns void

forceThreshold

• get forceThreshold(): number

  The amount of force that must be applied to the joint before it breaks.

  Setting the threshold too high leads to instability. Use sprite.addCollider to simulate unbreakable bonds between shapes.

  Returns number

  Default

  500
  Copy

• set forceThreshold(val: number): void

  Parameters

  • val: number

  Returns void

offsetA

• get offsetA(): Vector

  Offset to the joint's anchorA position from the center of spriteA.

  Only distance and hinge joints have an offsetA.

  Returns Vector

  Default

  {x: 0, y: 0}
  Copy

• set offsetA(val: [] | Vector | { x: number; y: number }): void

  Parameters

  • val: [] | Vector | { x: number; y: number }

  Returns void

offsetB

• get offsetB(): Vector

  Offset to the joint's anchorB position from the center of spriteB.

  Only distance, hinge, and wheel joints have an offsetB.

  Returns Vector

  Default

  {x: 0, y: 0}
  Copy

• set offsetB(val: [] | Vector | { x: number; y: number }): void

  Parameters

  • val: [] | Vector | { x: number; y: number }

  Returns void

reactionForce

• get reactionForce(): any

  How much force the joint is applying to keep the two sprites together.

  Returns any

reactionTorque

• get reactionTorque(): any

  How much torque the joint is applying to keep the two sprites together.

  Returns any

torqueThreshold

• get torqueThreshold(): number

  The amount of torque that must be applied to the joint before it breaks.

  Setting the threshold too high leads to instability. Use sprite.addCollider to simulate unbreakable bonds between shapes.

  Returns number

  Default

  500
  Copy

• set torqueThreshold(val: number): void

  Parameters

  • val: number

  Returns void

delete

• delete(): void

  Deletes the joint from the world and from each of the associated sprites' joints arrays.

  Returns void

onStrain

• onStrain(): void

  This function is run when the joint's reaction force exceeds the force threshold or its reaction torque exceeds the torque threshold.

  By default, the sprites' speed and rotation speed are set to 0 and the joint is deleted, simulating a break.

  Returns void