SpringJoint2D

Physics 2DScripts: SpringJoint2DComponentFeature: 2D Physics (≈45 KB)

Optional feature

SpringJoint2D is part of 2D Physics. A build includes it only when a scene, prefab or script uses it — see Feature cropping.

From a script

import { SpringJoint2DComponent } from "mmpx";

const springJoint2D = this.entity.TryGetComponent(SpringJoint2DComponent);

Full API: SpringJoint2DComponent.

Fields

Field	Type	Default	Description
Connected Body connectedBody	Rigidbody2D	—	The other Rigidbody2D — empty ties it to the world
Enable Collision enableCollision	boolean	false	Whether the two connected bodies still collide with each other
Anchor X anchorX	number	0
Anchor Y anchorY	number	0
Auto Connected Anchor autoConfigureConnectedAnchor	boolean	true	Puts the connected anchor where this anchor is when the joint is created
Connected Anchor X connectedAnchorX	number	0
Connected Anchor Y connectedAnchorY	number	0
Auto Distance autoConfigureDistance	boolean	true	The rest length is the distance between the anchors when the joint is created
Distance distance	number (0 … ∞) (px)	100
Frequency frequency	number (0.01 … ∞) (Hz)	2	Stiffness — oscillations per second
Damping Ratio dampingRatio	number (0 … 1)	0.2	0 = bounces forever, 1 = no bounce

Breaking

Field	Type	Default	Description
Break Force breakForce	number (0 … ∞)	0	Breaks when pulled harder than this (kg·px/s²) — 0 = never
Break Torque breakTorque	number (0 … ∞)	0	Breaks when twisted harder than this (kg·px²/s²) — 0 = never