Improve API reference and code quality

fibbojs · Jul 31, 2024 · 3bfecee · 3bfecee
1 parent 1078739
commit 3bfecee
Show file tree

Hide file tree

Showing 24 changed files with 402 additions and 243 deletions.
diff --git a/docs/api/2d/classes/FCircle.md b/docs/api/2d/classes/FCircle.md
@@ -41,7 +41,7 @@ scene.addComponent(square)
 
 #### Defined in
 
-[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/polygons/FCircle.ts#L20)
+[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L20)
 
 ## Methods
 
@@ -93,7 +93,7 @@ component.initCollider(
 
 #### Defined in
 
-[packages/2d/src/polygons/FCircle.ts:43](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/polygons/FCircle.ts#L43)
+[packages/2d/src/polygons/FCircle.ts:43](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L43)
 
 ***
 
@@ -143,7 +143,7 @@ component.initRigidBody(
 
 #### Defined in
 
-[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/polygons/FCircle.ts#L32)
+[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L32)
 
 ***
 
@@ -170,7 +170,7 @@ Should be called every frame.
 
 #### Defined in
 
-[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/polygons/FCircle.ts#L28)
+[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/polygons/FCircle.ts#L28)
 
 ***
 
@@ -208,7 +208,7 @@ component.setPosition(0, 0)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:78](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L78)
+[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L100)
 
 ***
 
@@ -242,7 +242,7 @@ component.setRotation(Math.PI / 2)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:109](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L109)
+[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L131)
 
 ***
 
@@ -276,7 +276,7 @@ component.setRotationDegree(90)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:122](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L122)
+[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L144)
 
 ***
 
@@ -314,104 +314,116 @@ component.setScale(1, 1)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:92](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L92)
+[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L114)
 
 ## Properties
 
 ### collider?
 
 > `optional` **collider**: `Collider`
 
+RAPIER Collider
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`collider`](FComponent2d.md#collider)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:25](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L25)
+[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L46)
 
 ***
 
 ### container
 
 > **container**: `Container`\<`ContainerChild`\>
 
-container is the PIXI container that holds the component (can be a square or circle for exemple).
+PIXI container
 
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`container`](FComponent2d.md#container)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:19](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L19)
+[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L22)
 
 ***
 
 ### position
 
 > **position**: `PointData`
 
+Position of the component.
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`position`](FComponent2d.md#position)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:20](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L20)
+[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L28)
 
 ***
 
 ### rigidBody?
 
 > `optional` **rigidBody**: `RigidBody`
 
+RAPIER RigidBody
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`rigidBody`](FComponent2d.md#rigidbody)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:24](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L24)
+[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L42)
 
 ***
 
 ### rotation
 
 > **rotation**: `number`
 
+Rotation of the component.
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`rotation`](FComponent2d.md#rotation)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L22)
+[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L36)
 
 ***
 
 ### scale
 
 > **scale**: `PointData`
 
+Scale of the component.
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`scale`](FComponent2d.md#scale)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:21](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L21)
+[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L32)
 
 ***
 
 ### scene
 
 > **scene**: [`FScene2d`](FScene2d.md)
 
+The scene which the component is in.
+
 #### Inherited from
 
 [`FComponent2d`](FComponent2d.md).[`scene`](FComponent2d.md#scene)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:15](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L15)
+[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L17)
diff --git a/docs/api/2d/classes/FComponent2d.md b/docs/api/2d/classes/FComponent2d.md
@@ -38,7 +38,7 @@ The 2D scene where the component will be added.
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:30](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L30)
+[packages/2d/src/FComponent2d.ts:51](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L51)
 
 ## Methods
 
@@ -86,7 +86,7 @@ component.initCollider(
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:217](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L217)
+[packages/2d/src/FComponent2d.ts:238](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L238)
 
 ***
 
@@ -132,7 +132,7 @@ component.initRigidBody(
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:142](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L142)
+[packages/2d/src/FComponent2d.ts:163](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L163)
 
 ***
 
@@ -159,7 +159,7 @@ Should be called every frame.
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:47](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L47)
+[packages/2d/src/FComponent2d.ts:68](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L68)
 
 ***
 
@@ -193,7 +193,7 @@ component.setPosition(0, 0)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:78](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L78)
+[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L100)
 
 ***
 
@@ -223,7 +223,7 @@ component.setRotation(Math.PI / 2)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:109](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L109)
+[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L131)
 
 ***
 
@@ -253,7 +253,7 @@ component.setRotationDegree(90)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:122](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L122)
+[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L144)
 
 ***
 
@@ -287,76 +287,88 @@ component.setScale(1, 1)
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:92](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L92)
+[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L114)
 
 ## Properties
 
 ### collider?
 
 > `optional` **collider**: `Collider`
 
+RAPIER Collider
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:25](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L25)
+[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L46)
 
 ***
 
 ### container
 
 > **container**: `Container`\<`ContainerChild`\>
 
-container is the PIXI container that holds the component (can be a square or circle for exemple).
+PIXI container
 
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:19](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L19)
+[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L22)
 
 ***
 
 ### position
 
 > **position**: `PointData`
 
+Position of the component.
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:20](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L20)
+[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L28)
 
 ***
 
 ### rigidBody?
 
 > `optional` **rigidBody**: `RigidBody`
 
+RAPIER RigidBody
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:24](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L24)
+[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L42)
 
 ***
 
 ### rotation
 
 > **rotation**: `number`
 
+Rotation of the component.
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L22)
+[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L36)
 
 ***
 
 ### scale
 
 > **scale**: `PointData`
 
+Scale of the component.
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:21](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L21)
+[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L32)
 
 ***
 
 ### scene
 
 > **scene**: [`FScene2d`](FScene2d.md)
 
+The scene which the component is in.
+
 #### Defined in
 
-[packages/2d/src/FComponent2d.ts:15](https://github.com/fibbojs/fibbo/blob/b264675ff74b82d5f50dfe9ebf6225959734103c/packages/2d/src/FComponent2d.ts#L15)
+[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/10787392517d7c42542c836b0fad578d96d8c1ac/packages/2d/src/FComponent2d.ts#L17)