angry-pixel 2.0.6 → 2.0.7

package/lib/index.d.ts

@@ -1917,14 +1917,16 @@ declare class PolygonCollider implements Collider {
 
 /**
  * The type of the rigid body to create:
- * - Dynamic: This type of body is affected by gravity and velocity.
- * - Static: This type of body is immovable, is unaffected by velocity and gravity.
+ * - **Dynamic:** This type of body is affected by gravity and velocity and can be moved by other rigid bodies.
+ * - **Kinematic:** This type of body is not affected by gravity and cannot be moved by other rigid bodies, but can be velocity applied.
+ * - **Static:** This type of body is immobile, is not affected by velocity or gravity and cannot be moved by other rigid bodies.
  * @category Components
  * @public
  */
 declare enum RigidBodyType {
     Dynamic = 0,
-    Static = 1
+    Kinematic = 1,
+    Static = 2
 }
 /**
  * RigidBody configuration options
@@ -1940,6 +1942,14 @@ declare enum RigidBodyType {
   });
  * ```
  * @example
+ * ```js
+  const rigidBody = new RigidBody({
+    rigidBodyType: RigidBodyType.Kinematic,
+    velocity: new Vector2(1, 0),
+    acceleration: new Vector2(1, 0)
+  });
+ * ```
+ * @example
  * ```js
   const rigidBody = new RigidBody({
     rigidBodyType: RigidBodyType.Static,
@@ -1949,32 +1959,36 @@ declare enum RigidBodyType {
 interface RigidBodyOptions {
     /**
      * The type of the rigid body to create:
-     * - Dynamic: This type of body is affected by gravity and velocity.
-     * - Static: This type of body is immovable, is unaffected by velocity and gravity.
+     * - **Dynamic:** This type of body is affected by gravity and velocity and can be moved by other rigid bodies.
+     * - **Kinematic:** This type of body is not affected by gravity and cannot be moved by other rigid bodies, but can be velocity applied.
+     * - **Static:** This type of body is immobile, is not affected by velocity or gravity and cannot be moved by other rigid bodies.
      * @public
      */
     type: RigidBodyType;
     /**
-     * Velocity applied to the x-axis and y-axis expressed in pixels per second. Only for Dynamic bodies
+     * Velocity applied to the x-axis and y-axis expressed in pixels per second. For Dynamic and Kinematic bodies.
      * @public
      */
     velocity: Vector2;
     /**
-     * Gravity expressed in pixels per second squared. Only for Dynamic bodies
+     * Gravity expressed in pixels per second squared. Only for Dynamic bodies.
      * @public
      */
     gravity: number;
     /**
-     * Acceleration expressed in pixels per second squared. Only for Dynamic bodies
+     * Acceleration expressed in pixels per second squared. For Dynamic and Kinematic bodies.
      * @public
      */
     acceleration: Vector2;
 }
 /**
  * The RigidBody component puts the entity under simulation of the physics engine, where it will interact with other objects that have a RigidBody.\
- * There are two types of bodies:
- * - Dynamic = This type of body is affected by gravity, can be velocity-applied and collides with other rigid bodies.
- * - Static = This type of body is immovable, no velocity can be applied to it and it is not affected by gravity. It is the body type that consumes the least processing resources.
+ * There are three types of bodies:
+ * - **Dynamic:** This type of body is affected by gravity and velocity and can be moved by other rigid bodies.
+ * - **Kinematic:** This type of body is not affected by gravity and cannot be moved by other rigid bodies, but can be velocity applied.\
+ *   This type of body consumes less processing resources than the Dynamic.
+ * - **Static:** This type of body is immobile, is not affected by velocity or gravity and cannot be moved by other rigid bodies.\
+ *   This is the body type that consumes the least processing resources.
  * @public
  * @category Components
  * @example
@@ -1987,6 +2001,14 @@ interface RigidBodyOptions {
   });
  * ```
  * @example
+ * ```js
+  const rigidBody = new RigidBody({
+    rigidBodyType: RigidBodyType.Kinematic,
+    velocity: new Vector2(1, 0),
+    acceleration: new Vector2(1, 0)
+  });
+ * ```
+ * @example
  * ```js
   const rigidBody = new RigidBody({
     rigidBodyType: RigidBodyType.Static,