mark serialize and deserialize as hidden instead of internal

Author: shakiba

.changeset/swift-eyes-cheat.md

@@ -0,0 +1,5 @@
+---
+"planck": patch
+---
+
+Mark serialize and deserialize functions as @hidden instead of @internal

src/collision/shape/ChainShape.ts

@@ -82,7 +82,7 @@ export class ChainShape extends Shape {
     }
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     const data = {
       type: this.m_type,
@@ -102,7 +102,7 @@ export class ChainShape extends Shape {
     return data;
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, fixture: any, restore: any): ChainShape {
     const vertices: Vec2[] = [];
     if (data.vertices) {

src/collision/shape/CircleShape.ts

@@ -68,7 +68,7 @@ export class CircleShape extends Shape {
     }
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -78,7 +78,7 @@ export class CircleShape extends Shape {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any): CircleShape {
     return new CircleShape(data.p, data.radius);
   }

src/collision/shape/EdgeShape.ts

@@ -73,7 +73,7 @@ export class EdgeShape extends Shape {
     this.m_hasVertex3 = false;
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -88,7 +88,7 @@ export class EdgeShape extends Shape {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any): EdgeShape {
     const shape = new EdgeShape(data.vertex1, data.vertex2);
     if (shape.m_hasVertex0) {

src/collision/shape/PolygonShape.ts

@@ -74,7 +74,7 @@ export class PolygonShape extends Shape {
     }
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -83,7 +83,7 @@ export class PolygonShape extends Shape {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, fixture: any, restore: any): PolygonShape {
     const vertices: Vec2[] = [];
     if (data.vertices) {

src/common/Vec2.ts

@@ -63,15 +63,15 @@ export class Vec2 {
     if (_ASSERT) Vec2.assert(this);
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       x: this.x,
       y: this.y
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any): Vec2 {
     const obj = Object.create(Vec2.prototype);
     obj.x = data.x;

src/common/Vec3.ts

@@ -61,7 +61,7 @@ export class Vec3 {
     if (_ASSERT) Vec3.assert(this);
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       x: this.x,
@@ -70,7 +70,7 @@ export class Vec3 {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any): Vec3 {
     const obj = Object.create(Vec3.prototype);
     obj.x = data.x;

src/dynamics/Body.ts

@@ -288,7 +288,7 @@ export class Body {
     }
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     const fixtures = [];
     for (let f = this.m_fixtureList; f; f = f.m_next) {
@@ -305,7 +305,7 @@ export class Body {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): Body {
     const body = new Body(world, data);
 

src/dynamics/Fixture.ts

@@ -190,7 +190,7 @@ export class Fixture {
     body.resetMassData();
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       friction: this.m_friction,
@@ -206,7 +206,7 @@ export class Fixture {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, body: any, restore: any): Fixture {
     const shape = restore(Shape, data.shape);
     const fixture = shape && new Fixture(body, shape, data);

src/dynamics/World.ts

@@ -190,7 +190,7 @@ export class World {
     this.m_step_callback = [];
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     const bodies = [];
     const joints = [];
@@ -213,7 +213,7 @@ export class World {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, context: any, restore: any): World {
     if (!data) {
       return new World();

src/dynamics/joint/DistanceJoint.ts

@@ -164,7 +164,7 @@ export class DistanceJoint extends Joint {
     // = invMass1 + invI1 * cross(r1, u)^2 + invMass2 + invI2 * cross(r2, u)^2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -185,7 +185,7 @@ export class DistanceJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): DistanceJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/FrictionJoint.ts

@@ -137,7 +137,7 @@ export class FrictionJoint extends Joint {
     // K = invI1 + invI2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -153,7 +153,7 @@ export class FrictionJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): FrictionJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/GearJoint.ts

@@ -232,7 +232,7 @@ export class GearJoint extends Joint {
     // K = J * invM * JT = invMass + invI * cross(r, ug)^2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -248,7 +248,7 @@ export class GearJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): GearJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/MotorJoint.ts

@@ -141,7 +141,7 @@ export class MotorJoint extends Joint {
     // K = invI1 + invI2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -158,7 +158,7 @@ export class MotorJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): MotorJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/MouseJoint.ts

@@ -160,7 +160,7 @@ export class MouseJoint extends Joint {
     // w k % (rx i + ry j) = w * (-ry i + rx j)
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -177,7 +177,7 @@ export class MouseJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): MouseJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/PrismaticJoint.ts

@@ -272,7 +272,7 @@ export class PrismaticJoint extends Joint {
     // df = f2 - f1
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -294,7 +294,7 @@ export class PrismaticJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): PrismaticJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/PulleyJoint.ts

@@ -163,7 +163,7 @@ export class PulleyJoint extends Joint {
     // cross(r2, u2)^2)
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -181,7 +181,7 @@ export class PulleyJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): PulleyJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/RevoluteJoint.ts

@@ -224,7 +224,7 @@ export class RevoluteJoint extends Joint {
     // K = invI1 + invI2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -245,7 +245,7 @@ export class RevoluteJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any):RevoluteJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/RopeJoint.ts

@@ -139,7 +139,7 @@ export class RopeJoint extends Joint {
     // = invMassA + invIA * cross(rA, u)^2 + invMassB + invIB * cross(rB, u)^2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -153,7 +153,7 @@ export class RopeJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): RopeJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/WeldJoint.ts

@@ -163,7 +163,7 @@ export class WeldJoint extends Joint {
     // K = invI1 + invI2
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -180,7 +180,7 @@ export class WeldJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): WeldJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);

src/dynamics/joint/WheelJoint.ts

@@ -218,7 +218,7 @@ export class WheelJoint extends Joint {
     // J = [0 0 -1 0 0 1]
   }
 
-  /** @internal */
+  /** @hidden */
   _serialize(): object {
     return {
       type: this.m_type,
@@ -238,7 +238,7 @@ export class WheelJoint extends Joint {
     };
   }
 
-  /** @internal */
+  /** @hidden */
   static _deserialize(data: any, world: any, restore: any): WheelJoint {
     data = {...data};
     data.bodyA = restore(Body, data.bodyA, world);