Rapier 2D JavaScript

https://rapier.rs/javascript2d
Admin
Rapier 2D is a physics engine library for JavaScript that provides rigid body dynamics, collision...
Tokens:151,591
Snippets:1,844
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### setUp

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Sets the up vector.

```APIDOC
## Method: setUp

### Description
Sets the up vector.

### Parameters
- **up** (Vector) - Required - The new up vector.
```

--------------------------------

### setUp(vector)

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Sets the up direction for the character controller.

```APIDOC
## setUp(vector)

### Description
Sets the direction that goes "up". Used to determine where the floor is, and the floor's angle.

### Method
setUp

### Parameters
- **vector** (Vector) - Required - The up direction vector.

### Returns
void
```

--------------------------------

### get

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Gets a soft body by its handle.

```APIDOC
## get

### Description
Gets a soft body by its handle.

### Parameters
- **handle** (type) - Required - The handle of the soft body.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript2d/classes/ImpulseJointSet.html

Gets all joints in the list.

```APIDOC
## getAll

### Description
Gets all joints in the list.

### Method
getAll

### Parameters
None

### Returns
ImpulseJoint[] - joint list.

```

--------------------------------

### get

Source: https://rapier.rs/javascript2d/classes/ColliderSet.html

Retrieves a collider by its handle.

```APIDOC
## get(handle)

### Description
Gets the collider with the given handle.

### Parameters
- **handle** (number) - Required - The handle of the collider to retrieve.

### Returns
- **Collider** - The collider with the given handle.
```

--------------------------------

### userForce

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the user-applied force on the body.

```APIDOC
## userForce

### Description
Gets the user-applied force on the body.

### Method
userForce

### Parameters
None

### Returns
Vector2
```

--------------------------------

### up()

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Gets the up direction vector.

```APIDOC
## up()

### Description
The direction that goes "up". Used to determine where the floor is, and the floor's angle.

### Method
up

### Returns
Vector - The up direction vector.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Gets all soft bodies in the list.

```APIDOC
## getAll(): SoftBody[]

### Description
Gets all soft bodies in the list.

### Method
getAll

### Parameters
None

### Returns
- **SoftBody[]** - An array of all soft bodies.
```

--------------------------------

### getAll

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Gets all soft bodies in the set.

```APIDOC
## getAll

### Description
Gets all soft bodies in the set.
```

--------------------------------

### get

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Gets the soft body with the given handle.

```APIDOC
## get(handle): SoftBody

### Description
Gets the soft body with the given handle.

### Method
get

### Parameters
- **handle** (number) - Required - The handle of the soft body.

### Returns
- **SoftBody** - The soft body with the given handle.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/NarrowPhase.html

Creates a new NarrowPhase instance.

```APIDOC
## constructor

### Description
Creates a new NarrowPhase instance. If a raw narrow-phase is provided, it wraps it; otherwise, a new one is created.

### Parameters
- `raw` (RawNarrowPhase, optional) - The raw narrow-phase to wrap.

### Returns
- `NarrowPhase` - The new narrow-phase instance.
```

--------------------------------

### get

Source: https://rapier.rs/javascript2d/classes/ImpulseJointSet.html

Gets the joint with the given handle. Returns null if no joint with the specified handle exists.

```APIDOC
## get

### Description
Gets the joint with the given handle. Returns `null` if no joint with the specified handle exists.

### Method
get

### Parameters
- **handle** (number) - Required - The integer handle of the joint to retrieve.

### Returns
ImpulseJoint

```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/BroadPhase.html

Creates a new BroadPhase instance.

```APIDOC
## constructor

### Description
Creates a new BroadPhase instance. Optionally accepts a raw RawBroadPhase object.

### Method
constructor

### Parameters
- `raw` (RawBroadPhase) - Optional - The raw broad-phase object.

### Returns
BroadPhase

```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/VectorOps.html

Creates a new VectorOps instance.

```APIDOC
## constructor

### Description
Creates a new VectorOps instance.

### Returns
VectorOps
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/HalfSpace.html

Constructor for creating a new HalfSpace instance.

```APIDOC
## new HalfSpace(normal)

### Description
Creates a new halfspace delimited by an infinite plane.

### Parameters
- **normal** (Vector) - Required - The outward normal of the plane.

### Returns
- **HalfSpace** - The newly created halfspace.
```

--------------------------------

### rotation

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the rotation of the body.

```APIDOC
## rotation

### Description
Gets the rotation of the body.

### Method
rotation

### Parameters
None

### Returns
number
```

--------------------------------

### mass

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the mass of the body.

```APIDOC
## mass

### Description
Gets the mass of the body.

### Method
mass

### Parameters
None

### Returns
number
```

--------------------------------

### Methods

Source: https://rapier.rs/javascript2d/classes/RigidBodyDesc.html

Methods to configure the RigidBodyDesc instance.

```APIDOC
## Methods

### enabledTranslations
- **Description**: Enables or disables translations along the X and Y axes.
- **Parameters**:
  - `x` (boolean) - Whether translation along X is enabled.
  - `y` (boolean) - Whether translation along Y is enabled.
- **Returns**: RigidBodyDesc - The modified description.

### lockRotations
- **Description**: Locks rotations, preventing the rigid body from rotating.
- **Returns**: RigidBodyDesc - The modified description.

### lockTranslations
- **Description**: Locks translations, preventing the rigid body from moving.
- **Returns**: RigidBodyDesc - The modified description.

### restrictTranslations
- **Description**: Restricts translations to the X and Y axes.
- **Parameters**:
  - `x` (boolean) - Whether translation along X is allowed.
  - `y` (boolean) - Whether translation along Y is allowed.
- **Returns**: RigidBodyDesc - The modified description.

### setAdditionalMass
- **Description**: Sets additional mass for the rigid body.
- **Parameters**:
  - `mass` (number) - The additional mass.
- **Returns**: RigidBodyDesc - The modified description.

### setAdditionalMassProperties
- **Description**: Sets additional mass properties (mass and inertia).
- **Parameters**:
  - `mass` (number) - The additional mass.
  - `inertia` (number) - The additional angular inertia.
- **Returns**: RigidBodyDesc - The modified description.

### setAdditionalPgsIterations
- **Description**: Sets additional PGS iterations.
- **Parameters**:
  - `iterations` (number) - The number of additional iterations.
- **Returns**: RigidBodyDesc - The modified description.

### setAdditionalSolverIterations
- **Description**: Sets additional solver iterations.
- **Parameters**:
  - `iterations` (number) - The number of additional iterations.
- **Returns**: RigidBodyDesc - The modified description.

### setAngularDamping
- **Description**: Sets the angular damping coefficient.
- **Parameters**:
  - `damping` (number) - The angular damping coefficient.
- **Returns**: RigidBodyDesc - The modified description.

### setAngvel
- **Description**: Sets the angular velocity.
- **Parameters**:
  - `vel` (number) - The angular velocity.
- **Returns**: RigidBodyDesc - The modified description.

### setCanSleep
- **Description**: Sets whether the rigid body can sleep.
- **Parameters**:
  - `canSleep` (boolean) - Whether the rigid body can sleep.
- **Returns**: RigidBodyDesc - The modified description.

### setCcdEnabled
- **Description**: Enables or disables continuous collision detection.
- **Parameters**:
  - `enabled` (boolean) - Whether CCD is enabled.
- **Returns**: RigidBodyDesc - The modified description.

### setDominanceGroup
- **Description**: Sets the dominance group.
- **Parameters**:
  - `group` (number) - The dominance group.
- **Returns**: RigidBodyDesc - The modified description.

### setEnabled
- **Description**: Sets whether the rigid body is enabled.
- **Parameters**:
  - `enabled` (boolean) - Whether the rigid body is enabled.
- **Returns**: RigidBodyDesc - The modified description.

### setGravityScale
- **Description**: Sets the gravity scale factor.
- **Parameters**:
  - `scale` (number) - The gravity scale.
- **Returns**: RigidBodyDesc - The modified description.

### setLinearDamping
- **Description**: Sets the linear damping coefficient.
- **Parameters**:
  - `damping` (number) - The linear damping coefficient.
- **Returns**: RigidBodyDesc - The modified description.

### setLinvel
- **Description**: Sets the linear velocity.
- **Parameters**:
  - `vel` (Vector) - The linear velocity.
- **Returns**: RigidBodyDesc - The modified description.

### setRotation
- **Description**: Sets the rotation angle.
- **Parameters**:
  - `angle` (number) - The rotation angle in radians.
- **Returns**: RigidBodyDesc - The modified description.

### setSleeping
- **Description**: Sets whether the rigid body is initially sleeping.
- **Parameters**:
  - `sleeping` (boolean) - Whether the rigid body is sleeping.
- **Returns**: RigidBodyDesc - The modified description.

### setSoftCcdPrediction
- **Description**: Sets the soft CCD prediction distance.
- **Parameters**:
  - `prediction` (number) - The prediction distance.
- **Returns**: RigidBodyDesc - The modified description.

### setTranslation
- **Description**: Sets the translation (position) of the rigid body.
- **Parameters**:
  - `x` (number) - The X coordinate.
  - `y` (number) - The Y coordinate.
- **Returns**: RigidBodyDesc - The modified description.

### setUserData
- **Description**: Sets user-defined data.
- **Parameters**:
  - `data` (unknown) - The user data.
- **Returns**: RigidBodyDesc - The modified description.

### dynamic
- **Description**: Creates a dynamic rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### fixed
- **Description**: Creates a fixed (static) rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### kinematicPositionBased
- **Description**: Creates a kinematic position-based rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### kinematicVelocityBased
- **Description**: Creates a kinematic velocity-based rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### newDynamic
- **Description**: Creates a new dynamic rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### newKinematicPositionBased
- **Description**: Creates a new kinematic position-based rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### newKinematicVelocityBased
- **Description**: Creates a new kinematic velocity-based rigid body description.
- **Returns**: RigidBodyDesc - The new description.

### newStatic
- **Description**: Creates a new static rigid body description.
- **Returns**: RigidBodyDesc - The new description.
```

--------------------------------

### shape

Source: https://rapier.rs/javascript2d/classes/Collider.html

Gets the shape of this collider.

```APIDOC
## shape

### Description
Gets the shape of this collider.

### Accessor
`get shape(): Shape`

### Returns
- **Shape** - The shape of this collider.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/SerializationPipeline.html

Creates a new SerializationPipeline instance. The raw parameter is optional and is used internally.

```APIDOC
## new SerializationPipeline(raw?)

### Description
Creates a new serialization pipeline. The `raw` parameter is optional and is used internally.

### Method
constructor

### Parameters
- `raw` (RawSerializationPipeline) - Optional - The raw serialization pipeline.

### Returns
SerializationPipeline

```

--------------------------------

### new SoftRecoverySettings()

Source: https://rapier.rs/javascript2d/classes/SoftRecoverySettings.html

Creates a new SoftRecoverySettings instance with default settings.

```APIDOC
## new SoftRecoverySettings()

### Description
Creates a new SoftRecoverySettings instance.

### Constructor
`new SoftRecoverySettings(): SoftRecoverySettings`

### Returns
- **SoftRecoverySettings** - A new instance of SoftRecoverySettings.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/SoftBodyMaterial.html

Creates a new SoftBodyMaterial instance.

```APIDOC
## new SoftBodyMaterial()

### Description
Creates a new instance of the SoftBodyMaterial class.

### Returns
- **SoftBodyMaterial** - The newly created material object.
```

--------------------------------

### World Accessors

Source: https://rapier.rs/javascript2d/classes/World.html

Accessors for the World class in the Rapier JavaScript 2D physics engine. These properties allow getting and setting simulation parameters such as length unit, CCD substeps, solver iterations, profiling, and timestep.

```APIDOC
## [GET] World.lengthUnit

### Description
Gets the approximate size of most dynamic objects in the scene. This value is used internally to estimate length-based tolerances.

### Method
GET

### Endpoint
World.lengthUnit

### Returns
- **number** - The approximate size of most dynamic objects in the scene.

## [SET] World.lengthUnit

### Description
Sets the approximate size of most dynamic objects in the scene. This value is used internally to estimate length-based tolerances.

### Method
SET

### Endpoint
World.lengthUnit

### Parameters
- **unitsPerMeter** (number) - Required - The number of units per meter in your physical world.

### Returns
- **void** - No return value.

## [GET] World.maxCcdSubsteps

### Description
Gets the number of substeps continuous collision-detection can run (default: 1).

### Method
GET

### Endpoint
World.maxCcdSubsteps

### Returns
- **number** - The number of substeps.

## [SET] World.maxCcdSubsteps

### Description
Sets the number of substeps continuous collision-detection can run (default: 1).

### Method
SET

### Endpoint
World.maxCcdSubsteps

### Parameters
- **substeps** (number) - Required - The new number of substeps.

### Returns
- **void** - No return value.

## [GET] World.numInternalPgsIterations

### Description
Gets the number of internal Project Gauss Seidel (PGS) iterations run at each solver iteration (default: 1).

### Method
GET

### Endpoint
World.numInternalPgsIterations

### Returns
- **number** - The number of internal PGS iterations.

## [SET] World.numInternalPgsIterations

### Description
Sets the number of internal Project Gauss Seidel (PGS) iterations run at each solver iteration (default: 1).

### Method
SET

### Endpoint
World.numInternalPgsIterations

### Parameters
- **niter** (number) - Required - The new number of internal PGS iterations.

### Returns
- **void** - No return value.

## [GET] World.numSolverIterations

### Description
Gets the number of solver iterations run by the constraints solver for calculating forces (default: 4).

### Method
GET

### Endpoint
World.numSolverIterations

### Returns
- **number** - The number of solver iterations.

## [SET] World.numSolverIterations

### Description
Sets the number of solver iterations run by the constraints solver for calculating forces (default: 4).

### Method
SET

### Endpoint
World.numSolverIterations

### Parameters
- **niter** (number) - Required - The new number of solver iterations.

### Returns
- **void** - No return value.

## [GET] World.profilerEnabled

### Description
Indicates if the internal performance profiling is enabled. Only works if the internal profiler is enabled with `World.profilerEnabled = true`.

### Method
GET

### Endpoint
World.profilerEnabled

### Returns
- **boolean** - Whether profiling is enabled.

## [SET] World.profilerEnabled

### Description
Sets whether internal performance profiling is enabled (default: false). Only works if the internal profiler is enabled with `World.profilerEnabled = true`.

### Method
SET

### Endpoint
World.profilerEnabled

### Parameters
- **enabled** (boolean) - Required - The new enabled state.

### Returns
- **void** - No return value.

## [GET] World.timestep

### Description
Gets the current simulation timestep.

### Method
GET

### Endpoint
World.timestep

### Returns
- **number** - The current simulation timestep.

## [SET] World.timestep

### Description
Sets the new simulation timestep. The simulation timestep governs by how much the physics state of the world will be integrated.

### Method
SET

### Endpoint
World.timestep

### Parameters
- **dt** (number) - Required - The timestep length, in seconds.

### Returns
- **void** - No return value.
```

--------------------------------

### enableSnapToGround

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Enables snap-to-ground.

```APIDOC
## Method: enableSnapToGround

### Description
Enables snap-to-ground.

### Parameters
- **distance** (number) - Required - The snap-to-ground distance.
```

--------------------------------

### userTorque

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the user-applied torque on the body.

```APIDOC
## userTorque

### Description
Gets the user-applied torque on the body.

### Method
userTorque

### Parameters
None

### Returns
number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/DebugRenderPipeline.html

Creates a new DebugRenderPipeline instance. Optionally accepts a raw pipeline object.

```APIDOC
## constructor

### Description
Creates a new DebugRenderPipeline instance.

### Method
constructor

### Parameters
- **raw** (RawDebugRenderPipeline) - Optional - The raw pipeline object.

### Returns
DebugRenderPipeline
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/RevoluteImpulseJoint.html

Creates a new RevoluteImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new RevoluteImpulseJoint instance.

### Method
constructor

### Signature
new RevoluteImpulseJoint(rawSet, bodySet, handle): RevoluteImpulseJoint

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
RevoluteImpulseJoint
```

--------------------------------

### translation

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the translation (position) of the body.

```APIDOC
## translation

### Description
Gets the translation (position) of the body.

### Method
translation

### Parameters
None

### Returns
Vector2
```

--------------------------------

### principalInertia

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the principal inertia of the body.

```APIDOC
## principalInertia

### Description
Gets the principal inertia of the body.

### Method
principalInertia

### Parameters
None

### Returns
number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/ShapeCastHit.html

Creates a new ShapeCastHit instance with the given time of impact, witness points, and normals.

```APIDOC
## constructor

### Description
Creates a new ShapeCastHit instance.

### Method
constructor

### Signature
new ShapeCastHit(time_of_impact, witness1, witness2, normal1, normal2): ShapeCastHit

### Parameters
- **time_of_impact** (number) - Required - The time of impact of the two shapes.
- **witness1** (Vector) - Required - The contact point on the first shape at the time of impact, expressed in the local-space of the first shape.
- **witness2** (Vector) - Required - The contact point on the second shape at the time of impact, expressed in the local-space of the second shape.
- **normal1** (Vector) - Required - The outward normal on the first shape at the time of impact, expressed in the local-space of the first shape.
- **normal2** (Vector) - Required - The outward normal on the second shape at the time of impact, expressed in the local-space of the second shape.

### Returns
- **ShapeCastHit** - The newly created ShapeCastHit instance.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/PointProjection.html

Constructor for the PointProjection class.

```APIDOC
## new PointProjection(point, isInside)

### Description
Creates a new PointProjection instance with the given point and isInside flag.

### Constructor
`new PointProjection(point, isInside)`

### Parameters
- **point** (Vector) - Required - The projection point.
- **isInside** (boolean) - Required - Whether the point is inside the collider.

### Returns
- **PointProjection** - The new PointProjection instance.
```

--------------------------------

### linvel

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the linear velocity of the body.

```APIDOC
## linvel

### Description
Gets the linear velocity of the body.

### Method
linvel

### Parameters
None

### Returns
Vector2
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/RopeImpulseJoint.html

Creates a new RopeImpulseJoint instance.

```APIDOC
## constructor

### Description
Creates a new RopeImpulseJoint instance.

### Method
constructor

### Signature
new RopeImpulseJoint(rawSet, bodySet, handle): RopeImpulseJoint

### Parameters
- **rawSet** (RawImpulseJointSet) - Required - The raw impulse joint set.
- **bodySet** (RigidBodySet) - Required - The rigid body set.
- **handle** (number) - Required - The handle of the joint.

### Returns
RopeImpulseJoint
```

--------------------------------

### invMass

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the inverse mass of the body.

```APIDOC
## invMass

### Description
Gets the inverse mass of the body.

### Method
invMass

### Parameters
None

### Returns
number
```

--------------------------------

### step(eventQueue?, hooks?): void

Source: https://rapier.rs/javascript2d/classes/World.html

Advances the physics simulation by one time step, with optional event queue and hooks.

```APIDOC
## step(eventQueue?, hooks?): void

### Description
Advance the simulation by one time step. All events generated by the physics engine are ignored.

### Method
step

### Parameters
- **eventQueue** (EventQueue) - Optional - Event queue for capturing physics events.
- **hooks** (PhysicsHooks) - Optional - Hooks for customizing the step.

### Returns
void
```

--------------------------------

### handle

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the handle of this rigid body.

```APIDOC
## handle

### Description
Gets the handle of this rigid body.

### Method
handle

### Parameters
None

### Returns
number
```

--------------------------------

### angvel

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the angular velocity of the body.

```APIDOC
## angvel

### Description
Gets the angular velocity of the body.

### Method
angvel

### Parameters
None

### Returns
number
```

--------------------------------

### RigidBodySet Class

Source: https://rapier.rs/javascript2d/classes/RigidBodySet.html

Documentation for the RigidBodySet class, including its constructor, properties, and methods.

```APIDOC
## Class RigidBodySet

### Description
A set of rigid bodies that can be handled by a physics pipeline. To avoid leaking WASM resources, this MUST be freed manually with `rigidBodySet.free()` once you are done using it (and all the rigid-bodies it created).

### Constructor
- `new RigidBodySet(raw?: RawRigidBodySet): RigidBodySet`
  - Parameters:
    - `raw` (RawRigidBodySet, optional) - The raw rigid body set.
  - Returns: `RigidBodySet`

### Properties
- `raw` (RawRigidBodySet) - The raw rigid body set.

### Methods

#### contains
- `contains(handle: number): boolean`
  - Description: Does this set contain a rigid-body with the given handle?
  - Parameters:
    - `handle` (number) - The rigid-body handle to check.
  - Returns: `boolean`

#### createRigidBody
- `createRigidBody(colliderSet: ColliderSet, desc: RigidBodyDesc): RigidBody`
  - Description: Creates a new rigid-body and return its integer handle.
  - Parameters:
    - `colliderSet` (ColliderSet) - The collider set.
    - `desc` (RigidBodyDesc) - The description of the rigid-body to create.
  - Returns: `RigidBody`

#### finalizeDeserialization
- `finalizeDeserialization(colliderSet: ColliderSet): void`
  - Description: Internal method, do not call this explicitly.
  - Parameters:
    - `colliderSet` (ColliderSet) - The collider set.
  - Returns: `void`

#### forEach
- `forEach(f: (body: RigidBody) => void): void`
  - Description: Applies the given closure to each rigid-body contained by this set.
  - Parameters:
    - `f` (function) - The closure to apply.
  - Returns: `void`

#### forEachActiveRigidBody
- `forEachActiveRigidBody(islands: IslandManager, f: (body: RigidBody) => void): void`
  - Description: Applies the given closure to each active rigid-bodies contained by this set. A rigid-body is active if it is not sleeping, i.e., if it moved recently.
  - Parameters:
    - `islands` (IslandManager) - The island manager.
    - `f` (function) - The closure to apply.
  - Returns: `void`

#### free
- `free(): void`
  - Description: Release the WASM memory occupied by this rigid-body set.
  - Returns: `void`

#### get
- `get(handle: number): RigidBody`
  - Description: Gets the rigid-body with the given handle.
  - Parameters:
    - `handle` (number) - The handle of the rigid-body to retrieve.
  - Returns: `RigidBody`

#### getAll
- `getAll(): RigidBody[]`
  - Description: Gets all rigid-bodies in the list.
  - Returns: `RigidBody[]` - The list of rigid-bodies.

#### len
- `len(): number`
  - Description: The number of rigid-bodies on this set.
  - Returns: `number`

#### mapNewBodies
- `mapNewBodies(colliders: ColliderSet): void`
  - Description: Wraps the rigid-bodies the engine created on its own (the proxies of soft bodies and their clusters) that have no JavaScript wrapper yet.
  - Parameters:
    - `colliders` (ColliderSet) - The collider set.
  - Returns: `void`

#### remove
- `remove(handle: number, islands: IslandManager, colliders: ColliderSet, softBodies: SoftBodySet, impulseJoints: ImpulseJointSet, multibodyJoints: MultibodyJointSet): void`
  - Description: Removes a rigid-body from this set. This will also remove all the colliders and joints attached to the rigid-body.
  - Parameters:
    - `handle` (number) - The integer handle of the rigid-body to remove.
    - `islands` (IslandManager) - The island manager.
    - `colliders` (ColliderSet) - The set of colliders that may contain colliders attached to the removed rigid-body.
    - `softBodies` (SoftBodySet) - The set of soft bodies: removing a cluster proxy removes its cluster.
    - `impulseJoints` (ImpulseJointSet) - The set of impulse joints that may contain joints attached to the removed rigid-body.
    - `multibodyJoints` (MultibodyJointSet) - The set of multibody joints that may contain joints attached to the removed rigid-body.
  - Returns: `void`

#### unmapRemovedBodies
- `unmapRemovedBodies(): void`
  - Description: Drops the wrappers of the rigid-bodies the engine removed on its own (the proxies of removed soft bodies and clusters).
  - Returns: `void`
```

--------------------------------

### fromBuffer

Source: https://rapier.rs/javascript2d/classes/PointProjection.html

Static method to create a PointProjection from a raw WASM projection.

```APIDOC
## fromBuffer(raw, target?)

### Description
Creates a PointProjection from a raw WASM projection. The raw projection is freed by this method. If a target is provided, it is populated and returned instead of allocating a new one.

### Method
`fromBuffer(raw, target?)`

### Parameters
- **raw** (RawPointProjection) - Required - The raw projection returned by the WASM query. It is freed by this method.
- **target** (PointProjection) - Optional - If provided, this object is populated and returned instead of allocating a new one.

### Returns
- **PointProjection** - The created or populated PointProjection.
```

--------------------------------

### activeEvents

Source: https://rapier.rs/javascript2d/classes/Collider.html

Gets the events active for this collider.

```APIDOC
## activeEvents

### Description
Gets the events active for this collider.

### Method
`activeEvents(): ActiveEvents`

### Returns
- **ActiveEvents** - The active events.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/TriMesh.html

Constructor for creating a new triangle mesh shape.

```APIDOC
## new TriMesh(vertices, indices, flags?)

### Description
Creates a new triangle mesh shape.

### Parameters
- **vertices** (Float32Array) - Required - The coordinates of the triangle mesh's vertices.
- **indices** (Uint32Array) - Required - The indices of the triangle mesh's triangles.
- **flags** (TriMeshFlags) - Optional - The triangle mesh flags.

### Returns
- **TriMesh** - The newly created triangle mesh shape.
```

--------------------------------

### fromRaw()

Source: https://rapier.rs/javascript2d/classes/SoftRecoverySettings.html

Creates a SoftRecoverySettings from a raw representation.

```APIDOC
## fromRaw()

### Description
Creates a SoftRecoverySettings from a raw representation.

### Method
`fromRaw(raw: RawSoftRecoverySettings): SoftRecoverySettings`

### Parameters
- **raw** (RawSoftRecoverySettings) - Required - The raw representation to convert.

### Returns
- **SoftRecoverySettings** - A new SoftRecoverySettings instance.
```

--------------------------------

### snapToGroundDistance()

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Gets the snap-to-ground distance threshold.

```APIDOC
## snapToGroundDistance()

### Description
If snap-to-ground is enabled, should the character be automatically snapped to the ground if the distance between the ground and its feet are smaller than the specified threshold?

### Method
snapToGroundDistance

### Returns
number - The snap-to-ground distance threshold.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/Polyline.html

Constructor for creating a new polyline shape.

```APIDOC
## new Polyline(vertices, indices?, flags?)

### Description
Creates a new polyline shape.

### Parameters
- **vertices** (Float32Array) - Required - The coordinates of the polyline's vertices.
- **indices** (Uint32Array) - Optional - The indices of the polyline's segments. If this is `null` or not provided, then the vertices are assumed to form a line strip.
- **flags** (PolylineFlags) - Optional - The polyline flags.

### Returns
- **Polyline** - The newly created polyline shape.
```

--------------------------------

### limitsMin

Source: https://rapier.rs/javascript2d/classes/RevoluteImpulseJoint.html

Gets the min limit of this joint.

```APIDOC
## limitsMin

### Description
The min limit of this joint.

### Method
limitsMin

### Signature
limitsMin(): number

### Returns
number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/Ball.html

Creates a new ball with the given radius.

```APIDOC
## constructor

### Description
Creates a new ball with the given radius.

### Method
constructor

### Parameters
- **radius** (number) - Required - The balls radius.

### Returns
- **Ball** - The newly created ball.
```

--------------------------------

### wakeUp

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Wakes a soft body and everything it touches up.

```APIDOC
## wakeUp(handle, bodies, strong): void

### Description
Wakes a soft body and everything it touches up.

### Method
wakeUp

### Parameters
- **handle** (number) - Required - The handle of the soft body.
- **bodies** (RigidBodySet) - Required - The set of rigid bodies.
- **strong** (boolean) - Required - If `true` the bodies stay awake for a while even if they are at rest.

### Returns
- **void**
```

--------------------------------

### limitsMax

Source: https://rapier.rs/javascript2d/classes/RevoluteImpulseJoint.html

Gets the max limit of this joint.

```APIDOC
## limitsMax

### Description
The max limit of this joint.

### Method
limitsMax

### Signature
limitsMax(): number

### Returns
number
```

--------------------------------

### worldCom

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the world-space center of mass of the body.

```APIDOC
## worldCom

### Description
Gets the world-space center of mass of the body.

### Method
worldCom

### Parameters
None

### Returns
Vector2
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/SoftBody.html

Creates a new SoftBody instance with the given raw set, bodies, colliders, and handle.

```APIDOC
## constructor

### Description
Creates a new SoftBody instance.

### Signature
`new SoftBody(rawSet, bodies, colliders, handle): SoftBody`

### Parameters
- **rawSet** (RawSoftBodySet) - Required - The raw soft body set.
- **bodies** (RigidBodySet) - Required - The rigid body set.
- **colliders** (ColliderSet) - Required - The collider set.
- **handle** (number) - Required - The handle for this soft body.

### Returns
- **SoftBody** - The new SoftBody instance.
```

--------------------------------

### velocityAtPoint

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the velocity at a specific point on the body.

```APIDOC
## velocityAtPoint

### Description
Gets the velocity at a specific point on the body.

### Method
velocityAtPoint

### Parameters
- **point** (Vector2) - Required - The world-space point.

### Returns
Vector2
```

--------------------------------

### new KinematicCharacterController(offset, params, broadPhase, narrowPhase, bodies, colliders)

Source: https://rapier.rs/javascript2d/classes/KinematicCharacterController.html

Creates a new KinematicCharacterController with the given offset, integration parameters, broad phase, narrow phase, rigid body set, and collider set.

```APIDOC
## Constructor: new KinematicCharacterController(offset, params, broadPhase, narrowPhase, bodies, colliders)

### Description
Creates a new KinematicCharacterController instance.

### Parameters
- **offset** (number) - Required - The offset distance for the character controller.
- **params** (IntegrationParameters) - Required - The integration parameters.
- **broadPhase** (BroadPhase) - Required - The broad phase collision detection.
- **narrowPhase** (NarrowPhase) - Required - The narrow phase collision detection.
- **bodies** (RigidBodySet) - Required - The set of rigid bodies.
- **colliders** (ColliderSet) - Required - The set of colliders.

### Returns
- **KinematicCharacterController** - The new character controller instance.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/PrismaticMultibodyJoint.html

Creates a new PrismaticMultibodyJoint instance.

```APIDOC
## constructor

### Description
Creates a new PrismaticMultibodyJoint instance.

### Parameters
- **rawSet** (RawMultibodyJointSet) - Required - The raw multibody joint set.
- **handle** (number) - Required - The handle of the joint.

### Returns
PrismaticMultibodyJoint

```

--------------------------------

### numColliders

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the number of colliders attached to this body.

```APIDOC
## numColliders

### Description
Gets the number of colliders attached to this body.

### Method
numColliders

### Parameters
None

### Returns
number
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/RotationOps.html

Creates a new instance of the RotationOps class.

```APIDOC
## constructor

### Description
Creates a new RotationOps instance.

### Method
constructor

### Parameters
None

### Returns
- **RotationOps** - A new RotationOps instance.
```

--------------------------------

### localCom

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the local center of mass of the body.

```APIDOC
## localCom

### Description
Gets the local center of mass of the body.

### Method
localCom

### Parameters
None

### Returns
Vector2
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/SoftBodySet.html

Constructor for the SoftBodySet class.

```APIDOC
## new SoftBodySet(raw?)

### Description
Creates a new set of soft bodies that can be handled by a physics pipeline.

### Parameters
- **raw** (RawSoftBodySet) - Optional - The raw soft body set to wrap.

### Returns
- **SoftBodySet** - The newly created soft body set.
```

--------------------------------

### linearDamping

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the linear damping coefficient of the body.

```APIDOC
## linearDamping

### Description
Gets the linear damping coefficient of the body.

### Method
linearDamping

### Parameters
None

### Returns
number
```

--------------------------------

### uniform(naturalFrequency, dampingRatio)

Source: https://rapier.rs/javascript2d/classes/SoftBodyMaterial.html

Creates a material with uniform softness parameters.

```APIDOC
## uniform(naturalFrequency, dampingRatio)

### Description
Creates a material whose edge, bend, volume and shape-matching softness all take the same value.

### Parameters
- **naturalFrequency** (number) - Required - The natural frequency for the softness.
- **dampingRatio** (number) - Required - The damping ratio for the softness.

### Returns
- **SoftBodyMaterial** - The created material.
```

--------------------------------

### invPrincipalInertia

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the inverse principal inertia of the body.

```APIDOC
## invPrincipalInertia

### Description
Gets the inverse principal inertia of the body.

### Method
invPrincipalInertia

### Parameters
None

### Returns
number
```

--------------------------------

### timingVelocityAssembly()

Source: https://rapier.rs/javascript2d/classes/World.html

Returns the time spent in milliseconds by the last step to run the constraint initialization.

```APIDOC
## timingVelocityAssembly()

### Description
Returns the time spent in milliseconds by the last step to run the constraint initialization. This timing is included in `timingSolver`. Only works if the internal profiler is enabled with `World.profilerEnabled = true`.

### Method
`timingVelocityAssembly()`

### Parameters
None.

### Returns
- **number** - The time spent in milliseconds.

```

--------------------------------

### effectiveInvMass

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the effective inverse mass of the body.

```APIDOC
## effectiveInvMass

### Description
Gets the effective inverse mass of the body.

### Method
effectiveInvMass

### Parameters
None

### Returns
number
```

--------------------------------

### effectiveAngularInertia

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the effective angular inertia of the body.

```APIDOC
## effectiveAngularInertia

### Description
Gets the effective angular inertia of the body.

### Method
effectiveAngularInertia

### Parameters
None

### Returns
number
```

--------------------------------

### Static restoreSnapshot(data)

Source: https://rapier.rs/javascript2d/classes/World.html

Creates a new physics world from a snapshot.

```APIDOC
## Static restoreSnapshot(data)

### Description
Creates a new physics world from a snapshot. This new physics world will be an identical copy of the snapshoted physics world.

### Method
`World.restoreSnapshot(data)`

### Parameters
- **data** (Uint8Array) - Required - The snapshot data.

### Returns
- **World** - The restored world.

```

--------------------------------

### serializeAll(gravity, integrationParameters, islands, broadPhase, narrowPhase, bodies, colliders, softBodies, impulseJoints, multibodyJoints)

Source: https://rapier.rs/javascript2d/classes/SerializationPipeline.html

Serializes a complete physics state into a single byte array. Takes various simulation components and returns a Uint8Array.

```APIDOC
## serializeAll(gravity, integrationParameters, islands, broadPhase, narrowPhase, bodies, colliders, softBodies, impulseJoints, multibodyJoints)

### Description
Serializes a complete physics state into a single byte array.

### Method
serializeAll

### Parameters
- `gravity` (Vector) - Required - The current gravity affecting the simulation.
- `integrationParameters` (IntegrationParameters) - Required - The integration parameters of the simulation.
- `islands` (IslandManager) - Required - The island manager.
- `broadPhase` (BroadPhase) - Required - The broad-phase of the simulation.
- `narrowPhase` (NarrowPhase) - Required - The narrow-phase of the simulation.
- `bodies` (RigidBodySet) - Required - The rigid-bodies taking part into the simulation.
- `colliders` (ColliderSet) - Required - The colliders taking part into the simulation.
- `softBodies` (SoftBodySet) - Required - The soft bodies taking part into the simulation.
- `impulseJoints` (ImpulseJointSet) - Required - The impulse joints taking part into the simulation.
- `multibodyJoints` (MultibodyJointSet) - Required - The multibody joints taking part into the simulation.

### Returns
Uint8Array

```

--------------------------------

### angularDamping

Source: https://rapier.rs/javascript2d/classes/RigidBody.html

Gets the angular damping coefficient of the body.

```APIDOC
## angularDamping

### Description
Gets the angular damping coefficient of the body.

### Method
angularDamping

### Parameters
None

### Returns
number
```

--------------------------------

### restitutionCombineRule()

Source: https://rapier.rs/javascript2d/classes/Collider.html

Gets the restitution combine rule for this collider.

```APIDOC
## restitutionCombineRule()

### Description
Gets the rule used to combine the restitution coefficients of two colliders involved in a contact.

### Method
restitutionCombineRule

### Returns
CoefficientCombineRule

```

--------------------------------

### constructor(vertices, colors)

Source: https://rapier.rs/javascript2d/classes/DebugRenderBuffers.html

Creates a new DebugRenderBuffers instance with the given vertex and color buffers.

```APIDOC
## [CONSTRUCTOR] new DebugRenderBuffers(vertices, colors)

### Description
Creates a new DebugRenderBuffers instance with the given vertex and color buffers.

### Parameters
- **vertices** (Float32Array) - Required - The vertex buffer containing line data.
- **colors** (Float32Array) - Required - The color buffer containing RGBA color data.

### Returns
- **DebugRenderBuffers** - The newly created instance.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/RigidBodyDesc.html

Creates a new RigidBodyDesc instance with the given rigid body type.

```APIDOC
## constructor

### Description
Creates a new RigidBodyDesc instance with the specified rigid body type.

### Method
constructor

### Signature
new RigidBodyDesc(status: RigidBodyType): RigidBodyDesc

### Parameters
- **status** (RigidBodyType) - Required - The rigid body type (e.g., dynamic, static, kinematic).

### Returns
RigidBodyDesc - The new rigid body description instance.
```

--------------------------------

### activeHooks

Source: https://rapier.rs/javascript2d/classes/Collider.html

Gets the physics hooks active for this collider.

```APIDOC
## activeHooks

### Description
Gets the physics hooks active for this collider.

### Method
`activeHooks(): ActiveHooks`

### Returns
- **ActiveHooks** - The active physics hooks.
```

--------------------------------

### constructor

Source: https://rapier.rs/javascript2d/classes/Compound.html

Constructor for creating a new Compound shape.

```APIDOC
## new Compound(shapes, positions, rotations, flags?)

### Description
Creates a new compound shape from an array of sub-shapes with their relative positions and rotations.

### Constructor
`new Compound(shapes, positions, rotations, flags?)`

### Parameters
- **shapes** (Shape[]) - Required - The array of shapes composing this compound. Must not be empty, and must not contain other compound shapes (nested compound shapes are not allowed).
- **positions** (Vector[]) - Required - The array of positions for each shape.
- **rotations** (number[]) - Required - The array of rotations for each shape.
- **flags** (FIX_INTERNAL_EDGES) - Optional - The compound flags.

### Returns
- **Compound** - The newly created compound shape.
```

--------------------------------

### activeCollisionTypes

Source: https://rapier.rs/javascript2d/classes/Collider.html

Gets the collision types active for this collider.

```APIDOC
## activeCollisionTypes

### Description
Gets the collision types active for this collider.

### Method
`activeCollisionTypes(): ActiveCollisionTypes`

### Returns
- **ActiveCollisionTypes** - The active collision types.
```

--------------------------------

### createPidController(kp, ki, kd, axes)

Source: https://rapier.rs/javascript2d/classes/World.html

Creates a new PID controller with specified gains and axes mask.

```APIDOC
## createPidController(kp, ki, kd, axes)

### Description
Creates a new PID (Proportional-Integral-Derivative) controller.

### Method
createPidController

### Parameters
- **kp** (number) - Required - The Proportional gain applied to the instantaneous linear position errors. This is usually set to a multiple of the inverse of simulation step time (e.g. `60` if the delta-time is `1.0 / 60.0`).
- **ki** (number) - Required - The linear gain applied to the Integral part of the PID controller.
- **kd** (number) - Required - The Derivative gain applied to the instantaneous linear velocity errors. This is usually set to a value in `[0.0, 1.0]` where `0.0` implies no damping (no correction of velocity errors) and `1.0` implies complete damping (velocity errors are corrected in a single simulation step).
- **axes** (PidAxesMask) - Required - The axes affected by this controller. Only coordinate axes with a bit flags set to `true` will be taken into account when calculating the errors and corrections.

### Returns
PidController
```

--------------------------------

### body2

Source: https://rapier.rs/javascript2d/classes/FixedImpulseJoint.html

Gets the second rigid-body this joint is attached to.

```APIDOC
## body2

### Description
The second rigid-body this joint is attached to.

### Method
body2

### Returns
RigidBody
```

--------------------------------

### free

Source: https://rapier.rs/javascript2d/classes/NarrowPhase.html

Releases the WASM memory occupied by this narrow-phase.

```APIDOC
## free

### Description
Releases the WASM memory occupied by this narrow-phase.

### Returns
- `void`
```
Tokens:
Raw