Exported docs and @types

b-g · Oct 2, 2024 · 863c686 · 863c686
1 parent 6075651
commit 863c686
Show file tree

Hide file tree

Showing 26 changed files with 1,230 additions and 1,230 deletions.
diff --git a/@types/classes/index.d.ts b/@types/classes/index.d.ts
@@ -112,18 +112,18 @@ declare class Block extends BlockCore {
      * @memberof Block
      * @example
      * // Rotate the block to 45 degrees
-     * block.rotateTo(PI / 4)
+     * block.rotate(PI / 4)
      *
      * // Rotate the block to 45 degrees around a specific point
-     * block.rotateTo(PI / 4, { x: 100, y: 100 })
+     * block.rotate(PI / 4, { x: 100, y: 100 })
      *
      * // Rotate the block to 45 degrees around a specific point and update the velocity
-     * block.rotateTo(PI / 4, { x: 100, y: 100 }, true)
+     * block.rotate(PI / 4, { x: 100, y: 100 }, true)
      *
      * // Rotate the block to 45 degrees around a specific point and update the velocity
-     * block.rotateTo(PI / 4, { x: 100, y: 100 }, true)
+     * block.rotate(PI / 4, { x: 100, y: 100 }, true)
      */
-    rotateTo(rotation: number, point?: Matter.Vector, updateVelocity?: boolean): void;
+    rotate(rotation: number, point?: Matter.Vector, updateVelocity?: boolean): void;
     /**
      * Rotates the block by a specific angle (relative)
      * adds the angle to the current angle of the block
@@ -132,21 +132,21 @@ declare class Block extends BlockCore {
      * @param {boolean} [updateVelocity] - Whether to update the velocity of the block
      * @memberof Block
      * @example
-     * // Rotate the block by 45 degrees
-     * block.rotate(PI / 4)
+     * // Increments the rotation of the block by 1 degrees
+     * block.rotateBy(PI / 180)
      *
-     * // Rotate the block by 45 degrees around a specific point
-     * block.rotate(PI / 4, { x: 100, y: 100 })
+     * // Increments the rotation of the block by 1 degrees around a specific point
+     * block.rotateBy(PI / 180, { x: 100, y: 100 })
      */
-    rotate(rotation: number, point?: Matter.Vector, updateVelocity?: boolean): void;
+    rotateBy(rotation: number, point?: Matter.Vector, updateVelocity?: boolean): void;
     /**
      * Sets the mass centre of the block to a specific offset
      * the offset is relative to the current mass centre
      * @param {Block} block
      * @param {Matter.Vector} offset
      * @memberof Block
      */
-    setMassCentre(offset: Matter.Vector): void;
+    offsetMassCentre(offset: Matter.Vector): void;
     /**
      * Draw an image "sprite" instead of the shape of the block.
      * Make sure to set attributes.image so that there is an image to draw.
@@ -544,4 +544,4 @@ declare class Stack extends Block {
 }
 
 
-// ./sample/generate-types.bash - Last created: Tue Oct  1 10:50:40 CEST 2024
+// ./sample/generate-types.bash - Last created: Wed Oct  2 07:54:28 CEST 2024
diff --git a/docs/Ball.html b/docs/Ball.html
diff --git a/docs/Ball.js.html b/docs/Ball.js.html
diff --git a/docs/Block.html b/docs/Block.html
diff --git a/docs/Block.js.html b/docs/Block.js.html
diff --git a/docs/BlockCore.html b/docs/BlockCore.html
diff --git a/docs/BlockCore.js.html b/docs/BlockCore.js.html
diff --git a/docs/BlocksFromSVG.html b/docs/BlocksFromSVG.html
diff --git a/docs/BlocksFromSVG.js.html b/docs/BlocksFromSVG.js.html
diff --git a/docs/Chain.html b/docs/Chain.html
diff --git a/docs/Chain.js.html b/docs/Chain.js.html
diff --git a/docs/Magnet.html b/docs/Magnet.html
diff --git a/docs/Magnet.js.html b/docs/Magnet.js.html
diff --git a/docs/Mouse.html b/docs/Mouse.html
diff --git a/docs/Mouse.js.html b/docs/Mouse.js.html
diff --git a/docs/Parts.html b/docs/Parts.html
diff --git a/docs/Parts.js.html b/docs/Parts.js.html
diff --git a/docs/Polygon.html b/docs/Polygon.html
diff --git a/docs/Polygon.js.html b/docs/Polygon.js.html
diff --git a/docs/PolygonFromPoints.html b/docs/PolygonFromPoints.html
diff --git a/docs/PolygonFromPoints.js.html b/docs/PolygonFromPoints.js.html
diff --git a/docs/PolygonFromSVG.html b/docs/PolygonFromSVG.html
diff --git a/docs/PolygonFromSVG.js.html b/docs/PolygonFromSVG.js.html
diff --git a/docs/Stack.html b/docs/Stack.html
diff --git a/docs/Stack.js.html b/docs/Stack.js.html
diff --git a/docs/index.html b/docs/index.html