Phaser API Documentation

  Version: 
MatterConstraintConfig
Properties:
name type arguments Default description
label string <optional> 'Constraint'

An arbitrary string-based name to help identify this constraint.

bodyA MatterJS.BodyType <optional>

The first possible Body that this constraint is attached to.

bodyB MatterJS.BodyType <optional>

The second possible Body that this constraint is attached to.

pointA Phaser.Types.Math.Vector2Like <optional>

A Vector that specifies the offset of the constraint from center of the constraint.bodyA if defined, otherwise a world-space position.

pointB Phaser.Types.Math.Vector2Like <optional>

A Vector that specifies the offset of the constraint from center of the constraint.bodyB if defined, otherwise a world-space position.

stiffness number <optional> 1

A Number that specifies the stiffness of the constraint, i.e. the rate at which it returns to its resting constraint.length. A value of 1 means the constraint should be very stiff. A value of 0.2 means the constraint acts like a soft spring.

angularStiffness number <optional> 0

A Number that specifies the angular stiffness of the constraint.

angleA number <optional> 0

The angleA of the constraint. If bodyA is set, the angle of bodyA is used instead.

angleB number <optional> 0

The angleB of the constraint. If bodyB is set, the angle of bodyB is used instead.

damping number <optional> 0

A Number that specifies the damping of the constraint, i.e. the amount of resistance applied to each body based on their velocities to limit the amount of oscillation. Damping will only be apparent when the constraint also has a very low stiffness. A value of 0.1 means the constraint will apply heavy damping, resulting in little to no oscillation. A value of 0 means the constraint will apply no damping.

length number <optional>

A Number that specifies the target resting length of the constraint. It is calculated automatically in Constraint.create from initial positions of the constraint.bodyA and constraint.bodyB.

plugin any <optional>

An object reserved for storing plugin-specific properties.

render Phaser.Types.Physics.Matter.MatterConstraintRenderConfig <optional>

The Debug Render configuration object for this constraint.

Type:
object