Skip to main content

Physics

Description​

This library has methods for applying physics and setting Colliders on Entities.

Functions​

applyForce​

You can directly apply forces (linear and angular) to any entity with a physics collider. These forces are applied in the next physics simulation update, which takes place at regular intervals. The function accepts a 3D vector to define the force direction and magnitude.

ecs.physics.applyForce(world, eid, forceX, forceY, forceZ) // -> void

applyImpulse​

This function is used to apply a one-time impulse force to a physics collider, altering its velocity based on the given impulse vector. This method is useful for events that require a quick, single action response, such as jumping, punching, or a sudden push.

ecs.physics.applyImpulse(world, eid, impulseX, impulseY, impulseZ) // -> void

applyTorque​

You can directly apply forces (linear and angular) to any entity with a physics collider. These forces are applied in the next physics simulation update, which takes place at regular intervals. The function accepts a 3D vector to define the force direction and magnitude.

ecs.physics.applyTorque(world, eid, torqueX, torqueY, torqueZ) // -> void

getWorldGravity​

This is a simple getter function that returns the current force of gravity applied to every object in the scene. The return value might change depending on the time the function was executed.

ecs.physics.getWorldGravity(world) // -> number

registerConvexShape​

Register a convex shape.

ecs.physics.registerConvexShape(world, vertices) // -> eid of the registered shape

getAngularVelocity​

Get the angular velocity of an entity.

ecs.physics.getAngularVelocity(world, eid) // -> {x: number, y: number, z: number}

getLinearVelocity​

Get the linear velocity of an entity.

ecs.physics.getLinearVelocity(world, eid) // -> {x: number, y: number, z: number}

setLinearVelocity​

Set the linear velocity of an entity.

ecs.physics.setLinearVelocity(world, eid, velocityX, velocityY, velocityZ) // -> void

getWorldGravity​

Get the world gravity.

ecs.physics.getWorldGravity(world, gravity) // -> number

setWorldGravity​

Set the world gravity.

ecs.physics.setWorldGravity(world, gravity) // -> void

unregisterConvexShape​

Unregister a convex shape.

ecs.physics.unregisterConvexShape(world, id) // -> void