Skip to content

Commit

Permalink
Internal variables should be UPPERCASED / Improve API Reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Gugustinette committed Aug 1, 2024
1 parent 80b6fdf commit b0ef6c5
Show file tree
Hide file tree
Showing 24 changed files with 275 additions and 264 deletions.
30 changes: 15 additions & 15 deletions docs/api/2d/classes/FCircle.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ scene.addComponent(circle)

#### Defined in

[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/polygons/FCircle.ts#L20)
[packages/2d/src/polygons/FCircle.ts:20](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/polygons/FCircle.ts#L20)

## Methods

Expand Down Expand Up @@ -97,7 +97,7 @@ component.initCollider({

#### Defined in

[packages/2d/src/polygons/FCircle.ts:44](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/polygons/FCircle.ts#L44)
[packages/2d/src/polygons/FCircle.ts:44](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/polygons/FCircle.ts#L44)

***

Expand Down Expand Up @@ -152,7 +152,7 @@ component.initRigidBody({

#### Defined in

[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/polygons/FCircle.ts#L32)
[packages/2d/src/polygons/FCircle.ts:32](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/polygons/FCircle.ts#L32)

***

Expand All @@ -179,7 +179,7 @@ Should be called every frame.

#### Defined in

[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/polygons/FCircle.ts#L28)
[packages/2d/src/polygons/FCircle.ts:28](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/polygons/FCircle.ts#L28)

***

Expand Down Expand Up @@ -217,7 +217,7 @@ component.setPosition(0, 0)

#### Defined in

[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L100)
[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L100)

***

Expand Down Expand Up @@ -251,7 +251,7 @@ component.setRotation(Math.PI / 2)

#### Defined in

[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L131)
[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L131)

***

Expand Down Expand Up @@ -285,7 +285,7 @@ component.setRotationDegree(90)

#### Defined in

[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L144)
[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L144)

***

Expand Down Expand Up @@ -323,7 +323,7 @@ component.setScale(1, 1)

#### Defined in

[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L114)
[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L114)

## Properties

Expand All @@ -339,7 +339,7 @@ RAPIER Collider

#### Defined in

[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L46)
[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L46)

***

Expand All @@ -355,7 +355,7 @@ PIXI container

#### Defined in

[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L22)
[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L22)

***

Expand All @@ -371,7 +371,7 @@ Position of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L28)
[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L28)

***

Expand All @@ -387,7 +387,7 @@ RAPIER RigidBody

#### Defined in

[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L42)
[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L42)

***

Expand All @@ -403,7 +403,7 @@ Rotation of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L36)
[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L36)

***

Expand All @@ -419,7 +419,7 @@ Scale of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L32)
[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L32)

***

Expand All @@ -435,4 +435,4 @@ The scene which the component is in.

#### Defined in

[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L17)
[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L17)
30 changes: 15 additions & 15 deletions docs/api/2d/classes/FComponent2d.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The 2D scene where the component will be added.

#### Defined in

[packages/2d/src/FComponent2d.ts:51](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L51)
[packages/2d/src/FComponent2d.ts:51](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L51)

## Methods

Expand Down Expand Up @@ -90,7 +90,7 @@ component.initCollider({

#### Defined in

[packages/2d/src/FComponent2d.ts:219](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L219)
[packages/2d/src/FComponent2d.ts:219](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L219)

***

Expand Down Expand Up @@ -141,7 +141,7 @@ component.initRigidBody({

#### Defined in

[packages/2d/src/FComponent2d.ts:165](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L165)
[packages/2d/src/FComponent2d.ts:165](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L165)

***

Expand All @@ -168,7 +168,7 @@ Should be called every frame.

#### Defined in

[packages/2d/src/FComponent2d.ts:68](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L68)
[packages/2d/src/FComponent2d.ts:68](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L68)

***

Expand Down Expand Up @@ -202,7 +202,7 @@ component.setPosition(0, 0)

#### Defined in

[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L100)
[packages/2d/src/FComponent2d.ts:100](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L100)

***

Expand Down Expand Up @@ -232,7 +232,7 @@ component.setRotation(Math.PI / 2)

#### Defined in

[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L131)
[packages/2d/src/FComponent2d.ts:131](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L131)

***

Expand Down Expand Up @@ -262,7 +262,7 @@ component.setRotationDegree(90)

#### Defined in

[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L144)
[packages/2d/src/FComponent2d.ts:144](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L144)

***

Expand Down Expand Up @@ -296,7 +296,7 @@ component.setScale(1, 1)

#### Defined in

[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L114)
[packages/2d/src/FComponent2d.ts:114](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L114)

## Properties

Expand All @@ -308,7 +308,7 @@ RAPIER Collider

#### Defined in

[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L46)
[packages/2d/src/FComponent2d.ts:46](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L46)

***

Expand All @@ -320,7 +320,7 @@ PIXI container

#### Defined in

[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L22)
[packages/2d/src/FComponent2d.ts:22](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L22)

***

Expand All @@ -332,7 +332,7 @@ Position of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L28)
[packages/2d/src/FComponent2d.ts:28](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L28)

***

Expand All @@ -344,7 +344,7 @@ RAPIER RigidBody

#### Defined in

[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L42)
[packages/2d/src/FComponent2d.ts:42](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L42)

***

Expand All @@ -356,7 +356,7 @@ Rotation of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L36)
[packages/2d/src/FComponent2d.ts:36](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L36)

***

Expand All @@ -368,7 +368,7 @@ Scale of the component.

#### Defined in

[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L32)
[packages/2d/src/FComponent2d.ts:32](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L32)

***

Expand All @@ -380,4 +380,4 @@ The scene which the component is in.

#### Defined in

[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FComponent2d.ts#L17)
[packages/2d/src/FComponent2d.ts:17](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FComponent2d.ts#L17)
28 changes: 14 additions & 14 deletions docs/api/2d/classes/FScene2d.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ import { FScene2d, FSquare } from '@fibbojs/2d'

#### Defined in

[packages/2d/src/FScene2d.ts:42](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L42)
[packages/2d/src/FScene2d.ts:42](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L42)

## Methods

Expand All @@ -74,7 +74,7 @@ Add a component to the scene.

#### Defined in

[packages/2d/src/FScene2d.ts:161](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L161)
[packages/2d/src/FScene2d.ts:161](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L161)

***

Expand All @@ -88,7 +88,7 @@ Add a component to the scene.

#### Defined in

[packages/2d/src/FScene2d.ts:196](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L196)
[packages/2d/src/FScene2d.ts:196](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L196)

***

Expand All @@ -109,7 +109,7 @@ and the root stage PIXI.Container.

#### Defined in

[packages/2d/src/FScene2d.ts:63](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L63)
[packages/2d/src/FScene2d.ts:63](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L63)

***

Expand All @@ -123,7 +123,7 @@ and the root stage PIXI.Container.

#### Defined in

[packages/2d/src/FScene2d.ts:144](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L144)
[packages/2d/src/FScene2d.ts:144](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L144)

***

Expand Down Expand Up @@ -167,7 +167,7 @@ packages/core/dist/index.d.ts:78

#### Defined in

[packages/2d/src/FScene2d.ts:192](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L192)
[packages/2d/src/FScene2d.ts:192](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L192)

## Properties

Expand All @@ -177,7 +177,7 @@ packages/core/dist/index.d.ts:78
#### Defined in

[packages/2d/src/FScene2d.ts:38](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L38)
[packages/2d/src/FScene2d.ts:38](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L38)

***

Expand All @@ -187,7 +187,7 @@ packages/core/dist/index.d.ts:78
#### Defined in

[packages/2d/src/FScene2d.ts:40](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L40)
[packages/2d/src/FScene2d.ts:40](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L40)

***

Expand All @@ -197,7 +197,7 @@ packages/core/dist/index.d.ts:78
#### Defined in

[packages/2d/src/FScene2d.ts:31](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L31)
[packages/2d/src/FScene2d.ts:31](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L31)

***

Expand Down Expand Up @@ -225,7 +225,7 @@ packages/core/dist/index.d.ts:62

#### Defined in

[packages/2d/src/FScene2d.ts:28](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L28)
[packages/2d/src/FScene2d.ts:28](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L28)

***

Expand All @@ -251,7 +251,7 @@ packages/core/dist/index.d.ts:62

#### Defined in

[packages/2d/src/FScene2d.ts:34](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L34)
[packages/2d/src/FScene2d.ts:34](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L34)

***

Expand All @@ -275,7 +275,7 @@ packages/core/dist/index.d.ts:69
#### Defined in

[packages/2d/src/FScene2d.ts:36](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L36)
[packages/2d/src/FScene2d.ts:36](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L36)

***

Expand All @@ -285,7 +285,7 @@ packages/core/dist/index.d.ts:69
#### Defined in

[packages/2d/src/FScene2d.ts:32](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L32)
[packages/2d/src/FScene2d.ts:32](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L32)

***

Expand All @@ -299,4 +299,4 @@ packages/core/dist/index.d.ts:69

#### Defined in

[packages/2d/src/FScene2d.ts:29](https://github.com/fibbojs/fibbo/blob/854b295adc4e4ce7db9ffee939bdf1bce33bc12e/packages/2d/src/FScene2d.ts#L29)
[packages/2d/src/FScene2d.ts:29](https://github.com/fibbojs/fibbo/blob/80b6fdf057f7308259e47b328813060ab5ca7088/packages/2d/src/FScene2d.ts#L29)
Loading

0 comments on commit b0ef6c5

Please sign in to comment.