Class JoltManager

Gets the current gravity vector.

Default Value

Vec3(0, -9.81, 0)
Copy

Sets the physics world gravity.

Sometimes it is useful to have a callback right before the physics world steps. You can set such a callback function via this method.

Your given callback will be called after all commands have been executed and right before we update virtual kinematic characters and step the physics world.

Note, this feature is disabled, when the backend runs in a Web Worker.

Creates a raycast query to the physics world.

Example

// Cast a 10 meters ray from (0, 5, 0) straight down.
const origin = new Vec3(0, 5, 0);
const dir = new Vec3(0, -10, 0);
app.physics.castRay(origin, dir, onResults, { firstOnly: false });

function onResults(results) {
    if (results.length === 0) {
        return;
    }
    // do something with results
}
Copy

Creates a shapecast query to the physics world.

Example

import { SHAPE_SPHERE } from './physics.dbg.mjs';

// Do a 10 meters cast with a 0.3 radius sphere from (0, 5, 0) straight down.
const shapeIndex = app.physics.createShape(SHAPE_SPHERE, { radius: 0.3 });
const pos = new Vec3(0, 5, 0);
const dir = new Vec3(0, -10, 0);
app.physics.castShape(shapeIndex, pos, Quat.IDENTITY, dir, onResults, {
    ignoreSensors: true
});

function onResults(results) {
    if (results.length === 0) {
        return;
    }
    // do something with results
}
Copy

Check if a world point is inside any body shape. For this test all shapes are treated as if they were solid. For a mesh shape, this test will only provide sensible information if the mesh is a closed manifold.

Example

// get all entities that overlap a world position (0, 5, 0)
app.physics.collidePoint(new Vec3(0, 5, 0), onResults, { ignoreSensors: true });

function onResults(results) {
    if (results.length === 0) {
        return;
    }
    // do something with results
}
Copy

Gets all entities that collide with a given shape.

Example

import { SHAPE_BOX } from './physics.dbg.mjs';

// create a box with a half extent (1, 1, 1) meters
const shapeIndex = app.physics.createShape(SHAPE_BOX, { halfExtent: Vec3.ONE });

// get all entities that intersect a box with half extent (0.2, 0.5, 0.2) at world position
// (0, 10, 0)
const scale = new Vec3(0.2, 0.5, 0.2);
const pos = new Vec3(0, 10, 0);
app.physics.collideShape(shapeIndex, pos, Quat.IDENTITY, onResults, { scale });

function onResults(results) {
    if (results.length === 0) {
        return;
    }
    // do something with the results
}

Copy

Allows to create collision groups. Note, that collision groups are more expensive than broadphase layers.

The groups are created by giving an array of numbers, where each element adds a group and its number represents the count of subgroups in it.

Example

// Create `2` groups. The first group has `3` subgroups, the second `5`.
app.physics.createGroups([3, 5]);
Copy

For additional information, refer to Jolt's official documentation on Collision Filtering.

Creates a shape in the physics backend. Note, that the shape is not added to the physics world after it is created, so it won't affect the simulation.

This is useful, when you want to use a shape for a shapecast, or want your kinematic character controller to change current shape (e.g. standing, sitting, laying, etc).

Once you no longer need the shape, you must destroyShape to avoid memory leaks.

Example

import { SHAPE_CAPSULE } from './physics.dbg.mjs';

// create a 2m high and 0.6m wide capsule.
const shapeIndex = app.physics.createShape(SHAPE_CAPSULE, {
    halfHeight: 1,
    radius: 0.3
});
Copy

See

ShapeComponent.shape for available shape type options.

Destroys a shape that was previously created with createShape.

Removes a callback that was set via addUpdateCallback.

Toggles a collision between 2 subgroups inside a group.