Class DistanceJoint

A Joint is used to constrain the movement of two sprites relative to each other, which can lead to nuanced physics interactions.

Hierarchy (View Summary)

Joint
- DistanceJoint

Index

Constructors

constructor

new DistanceJoint(spriteA: Sprite, spriteB: Sprite): DistanceJoint
Distance joints are used to constrain the distance between two sprites.
Parameters
- spriteA: Sprite
- spriteB: Sprite
Returns DistanceJoint
Overrides Joint.constructor
- Defined in dev/web/q5play-web/q5play.d.ts:3270

Properties

jID

jID: b2JointId

The Box2D joint ID. Don't change it!

spriteA

spriteA: Sprite

The first sprite in the joint.

spriteB

spriteB: Sprite

The second sprite in the joint.

type

type: string

The type of joint. Can be one of:

"glue", "distance", "wheel", "hinge", "slider", or "grabber".

Can't be changed after the joint is created.

visible

visible: boolean

Determines whether to draw the joint if spriteA or spriteB is drawn.

Default

true

Accessors

collideConnected

get collideConnected(): boolean
Set to true if you want the joint's sprites to collide with each other.

Returns boolean
Default
```
false
```
Inherited from Joint.collideConnected
- Defined in dev/web/q5play-web/q5play.d.ts:3192
set collideConnected(val: boolean): void
Parameters
- val: boolean
Returns void
Inherited from Joint.collideConnected
- Defined in dev/web/q5play-web/q5play.d.ts:3193

currentLength

get currentLength(): number
The current distance between the two joint anchors.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3276

damping

get damping(): number
Damping is a 0-1 ratio describing how quickly the joint loses vibrational energy.

0.0 means no damping, 1.0 means critical damping, which will stop the joint from vibrating at all.

Damping only effects joints that have a springiness greater than 0.

Returns number
Default
```
0.0
```
- Defined in dev/web/q5play-web/q5play.d.ts:3340
set damping(val: number): void
Parameters
- val: number
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3341

draw

get draw(): Function
Function that draws the joint. Can be overridden by the user.

Returns Function
Inherited from Joint.draw
- Defined in dev/web/q5play-web/q5play.d.ts:3184
set draw(val: Function): void
Parameters
- val: Function
Returns void
Inherited from Joint.draw
- Defined in dev/web/q5play-web/q5play.d.ts:3185

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
```
Inherited from Joint.forceThreshold
- Defined in dev/web/q5play-web/q5play.d.ts:3214
set forceThreshold(val: number): void
Parameters
- val: number
Returns void
Inherited from Joint.forceThreshold
- Defined in dev/web/q5play-web/q5play.d.ts:3215

length

get length(): number
The target length of the joint between the two joint anchors.

It's set to the current distance between the two sprites when the joint is created.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3284
set length(val: number): void
Parameters
- val: number
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3285

limitsEnabled

get limitsEnabled(): boolean
Whether the joint's length limits are enabled. When enabled a min/max length range constrains the joint.

Returns boolean
Default
```
false
```
- Defined in dev/web/q5play-web/q5play.d.ts:3292
set limitsEnabled(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3293

maxLength

get maxLength(): number
The maximum length allowed when limits are enabled.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3305

maxPower

get maxPower(): number
Maximum motor force the motor can apply.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3360
set maxPower(val: number): void
Parameters
- val: number
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3361

minLength

get minLength(): number
The minimum length allowed when limits are enabled.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3299

motorEnabled

get motorEnabled(): boolean
Whether the joint's motor is enabled.

Returns boolean
Default
```
false
```
- Defined in dev/web/q5play-web/q5play.d.ts:3347
set motorEnabled(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3348

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}
```
Inherited from Joint.offsetA
- Defined in dev/web/q5play-web/q5play.d.ts:3169
set offsetA(val: [] | Vector | { x: number; y: number }): void
Parameters
- val: [] | Vector | { x: number; y: number }
Returns void
Inherited from Joint.offsetA
- Defined in dev/web/q5play-web/q5play.d.ts:3170

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}
```
Inherited from Joint.offsetB
- Defined in dev/web/q5play-web/q5play.d.ts:3178
set offsetB(val: [] | Vector | { x: number; y: number }): void
Parameters
- val: [] | Vector | { x: number; y: number }
Returns void
Inherited from Joint.offsetB
- Defined in dev/web/q5play-web/q5play.d.ts:3179

power

get power(): number
The current motor force being applied by the joint.

Returns number
- Defined in dev/web/q5play-web/q5play.d.ts:3367

range

set range(val: number | [number, number]): void
Accepts a number to set a symmetric range or an array with the minimum and maximum length limits.
Parameters
- val: number | [number, number]
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3311

reactionForce

get reactionForce(): any
How much force the joint is applying to keep the two sprites together.

Returns any
Inherited from Joint.reactionForce
- Defined in dev/web/q5play-web/q5play.d.ts:3199

reactionTorque

get reactionTorque(): any
How much torque the joint is applying to keep the two sprites together.

Returns any
Inherited from Joint.reactionTorque
- Defined in dev/web/q5play-web/q5play.d.ts:3205

speed

get speed(): number
Motor speed.

Returns number
Default
```
0
```
- Defined in dev/web/q5play-web/q5play.d.ts:3354
set speed(val: number): void
Parameters
- val: number
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3355

springEnabled

get springEnabled(): boolean
Whether spring behavior is enabled for the joint.

Returns boolean
Default
```
true
```
- Defined in dev/web/q5play-web/q5play.d.ts:3317
set springEnabled(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3318

springiness

get springiness(): number
The springiness of the joint, a 0-1 ratio.

0 is rigid, 0.5 is bouncy, 1 is loose.

Returns number
Default
```
0
```
- Defined in dev/web/q5play-web/q5play.d.ts:3326
set springiness(val: number): void
Parameters
- val: number
Returns void
- Defined in dev/web/q5play-web/q5play.d.ts:3327

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
```
Inherited from Joint.torqueThreshold
- Defined in dev/web/q5play-web/q5play.d.ts:3224
set torqueThreshold(val: number): void
Parameters
- val: number
Returns void
Inherited from Joint.torqueThreshold
- Defined in dev/web/q5play-web/q5play.d.ts:3225

Methods

delete

delete(): void
Deletes the joint from the world and from each of the associated sprites' joints arrays.

Returns void
Inherited from Joint.delete
- Defined in dev/web/q5play-web/q5play.d.ts:3240

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
Inherited from Joint.onStrain
- Defined in dev/web/q5play-web/q5play.d.ts:3234

Class DistanceJoint

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DistanceJoint

Properties

jID

spriteA

spriteB

type

visible

Default

Accessors

collideConnected

Returns boolean

Default

Parameters

Returns void

currentLength

Returns number

damping

Returns number

Default

Parameters

Returns void

draw

Returns Function

Parameters

Returns void

forceThreshold

Returns number

Default

Parameters

Returns void

length

Returns number

Parameters

Returns void

limitsEnabled

Returns boolean

Default

Parameters

Returns void

maxLength

Returns number

maxPower

Returns number

Parameters

Returns void

minLength

Returns number

motorEnabled

Returns boolean

Default

Parameters

Returns void

offsetA

Returns Vector

Default

Parameters

Returns void

offsetB

Returns Vector

Default

Parameters

Returns void

power

Returns number

range

Parameters

Returns void

reactionForce

Returns any

reactionTorque