PhysicsWorld
Defined in: physics/src/PhysicsWorld.ts:36
Central Rapier2D wrapper. All public API values are in pixels. Pixel-to-meter conversion is handled internally.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PhysicsWorld(
config?):PhysicsWorld
Defined in: physics/src/PhysicsWorld.ts:56
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”PhysicsWorld
Properties
Section titled “Properties”_colliderComponents
Section titled “_colliderComponents”
readonly_colliderComponents:Map<number,ColliderComponent>
Defined in: physics/src/PhysicsWorld.ts:46
Internal
Map from collider handle to ColliderComponent.
bodyMap
Section titled “bodyMap”
readonlybodyMap:Map<number,Entity>
Defined in: physics/src/PhysicsWorld.ts:41
Map from Rapier body handle to Entity.
colliderMap
Section titled “colliderMap”
readonlycolliderMap:Map<number,Entity>
Defined in: physics/src/PhysicsWorld.ts:43
Map from Rapier collider handle to Entity.
pixelsPerMeter
Section titled “pixelsPerMeter”
readonlypixelsPerMeter:number
Defined in: physics/src/PhysicsWorld.ts:38
Pixels per meter conversion factor.
Methods
Section titled “Methods”createBody()
Section titled “createBody()”createBody(
entity,config):number
Defined in: physics/src/PhysicsWorld.ts:131
Create a rigid body and register it. Returns the Rapier handle.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity
config
Section titled “config”Returns
Section titled “Returns”number
createCollider()
Section titled “createCollider()”createCollider(
entity,bodyHandle,config,component):number
Defined in: physics/src/PhysicsWorld.ts:170
Create a collider attached to a body. Returns the Rapier collider handle.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity
bodyHandle
Section titled “bodyHandle”number
config
Section titled “config”component
Section titled “component”Returns
Section titled “Returns”number
destroy()
Section titled “destroy()”destroy():
void
Defined in: physics/src/PhysicsWorld.ts:458
Destroy the physics world and free resources.
Returns
Section titled “Returns”void
getBody()
Section titled “getBody()”getBody(
handle):RigidBody|undefined
Defined in: physics/src/PhysicsWorld.ts:304
Get a Rapier rigid body by handle.
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”RigidBody | undefined
getCollider()
Section titled “getCollider()”getCollider(
handle):Collider|undefined
Defined in: physics/src/PhysicsWorld.ts:313
Get a Rapier collider by handle.
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”Collider | undefined
processCollisionEvents()
Section titled “processCollisionEvents()”processCollisionEvents():
void
Defined in: physics/src/PhysicsWorld.ts:84
Drain collision events and dispatch to ColliderComponents.
Returns
Section titled “Returns”void
queryOverlapping()
Section titled “queryOverlapping()”queryOverlapping(
colliderHandle):Entity[]
Defined in: physics/src/PhysicsWorld.ts:360
Return all entities whose colliders currently overlap the given collider.
Parameters
Section titled “Parameters”colliderHandle
Section titled “colliderHandle”number
Returns
Section titled “Returns”Entity[]
raycast()
Section titled “raycast()”raycast(
origin,direction,maxDistance,options?):RaycastHit|null
Defined in: physics/src/PhysicsWorld.ts:322
Cast a ray and return the first hit. All values in pixels.
Parameters
Section titled “Parameters”origin
Section titled “origin”Vec2Like
direction
Section titled “direction”Vec2Like
maxDistance
Section titled “maxDistance”number
options?
Section titled “options?”filterGroups?
Section titled “filterGroups?”number
Returns
Section titled “Returns”RaycastHit | null
removeBody()
Section titled “removeBody()”removeBody(
handle):void
Defined in: physics/src/PhysicsWorld.ts:286
Remove a rigid body and all its colliders from the world.
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”void
setGravity()
Section titled “setGravity()”setGravity(
x,y):void
Defined in: physics/src/PhysicsWorld.ts:126
Set gravity in pixels/s².
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
snapshot()
Section titled “snapshot()”snapshot():
object
Defined in: physics/src/PhysicsWorld.ts:377
Inspector-facing snapshot of the current rigid bodies and active contacts.
Returns
Section titled “Returns”object
bodies
Section titled “bodies”bodies:
object[]
contacts
Section titled “contacts”contacts:
object[]
step()
Section titled “step()”step(
dt):void
Defined in: physics/src/PhysicsWorld.ts:78
Step the physics simulation. dt is in seconds.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
toMeters()
Section titled “toMeters()”toMeters(
pixels):number
Defined in: physics/src/PhysicsWorld.ts:68
Convert pixels to meters.
Parameters
Section titled “Parameters”pixels
Section titled “pixels”number
Returns
Section titled “Returns”number
toPixels()
Section titled “toPixels()”toPixels(
meters):number
Defined in: physics/src/PhysicsWorld.ts:73
Convert meters to pixels.
Parameters
Section titled “Parameters”meters
Section titled “meters”number
Returns
Section titled “Returns”number