Skip to content

Commit c389d97

Browse files
willeastcottclaude
andcommitted
refactor(joint): keep the constraint getter off the public API
The constraint getter returned a raw Ammo (Bullet) object as documented public API, baking the current physics backend into the permanent contract - awkward ahead of multi-backend support. Mark it @ignore so it is excluded from the public API surface, matching RigidBodyComponent.body (which is likewise undocumented). It remains reachable at runtime as an unsupported escape hatch. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 4d8d335 commit c389d97

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

src/framework/components/joint/component.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -608,11 +608,13 @@ class JointComponent extends Component {
608608
}
609609

610610
/**
611-
* Gets the underlying Ammo (Bullet) constraint, or null if it has not been created or has
612-
* broken. Use this to access native constraint functionality that is not exposed by the
613-
* component.
611+
* The underlying Ammo (Bullet) constraint, or null if it has not been created or has broken.
612+
* An unsupported escape hatch for native functionality the component does not yet expose - it
613+
* is deliberately kept off the public, backend-agnostic API surface, mirroring
614+
* {@link RigidBodyComponent#body}.
614615
*
615616
* @type {object|null}
617+
* @ignore
616618
*/
617619
get constraint() {
618620
return this._constraint;

0 commit comments

Comments
 (0)