Class PhysicsWorld

Planck.js physics simulation manager.

Example

// Via setupMoxi (recommended)
const { physicsWorld } = await setupMoxi({ physics: true });

// Or manually
const physicsWorld = new PhysicsWorld({ gravity: { x: 0, y: 9.8 } });
engine.addPhysicsWorld(physicsWorld);

// Collision callbacks
physicsWorld.onCollision('player', 'enemy', (e) => console.log('hit!'));

// Debug visualization
physicsWorld.enableDebugRenderer(scene);

Constructors

constructor

new PhysicsWorld(options?: PhysicsWorldOptions): PhysicsWorld
Parameters
- options: PhysicsWorldOptions = {}
Returns PhysicsWorld
- Defined in library/physics/physics-world.ts:52

Properties

collisionManager

collisionManager: CollisionManager

Handles collision callbacks between tags.

collisionRegistry

collisionRegistry: CollisionRegistry

Collision tag registry for tag-to-bitmask conversion.

pixelsPerMeter

pixelsPerMeter: number = 30

Conversion factor. Default 30.

timestep

timestep: number = ...

Fixed timestep (seconds). Default 1/60.

world

world: World

Planck.js world.

Methods

createBody

createBody(def: BodyDef): Body$1
Create a physics body
Parameters
- def: BodyDef
Returns Body$1
- Defined in library/physics/physics-world.ts:103

destroy

destroy(): void
Clean up and destroy the physics world

Returns void
- Defined in library/physics/physics-world.ts:274

destroyBody

destroyBody(body: Body$1): void
Destroy a physics body
Parameters
- body: Body$1
Returns void
- Defined in library/physics/physics-world.ts:110

disableDebugRenderer

disableDebugRenderer(): void
Disable debug renderer

Returns void
- Defined in library/physics/physics-world.ts:239

enableDebugRenderer

enableDebugRenderer(
scene: Container,
options?: PhysicsDebugOptions,
): PhysicsDebugRenderer
Enable debug renderer
Parameters
- scene: Container
- options: PhysicsDebugOptions = {}
Returns PhysicsDebugRenderer
- Defined in library/physics/physics-world.ts:206

getBodies

getBodies(): Body$1[]
Get all bodies in the world

Returns Body$1[]
- Defined in library/physics/physics-world.ts:263

getBodyLogic

getBodyLogic(body: Body$1): PhysicsBodyLogic
Get physics body logic from Planck body
Parameters
- body: Body$1
Returns PhysicsBodyLogic
- Defined in library/physics/physics-world.ts:125

getDebugRenderer

getDebugRenderer(): PhysicsDebugRenderer
Get debug renderer if enabled

Returns PhysicsDebugRenderer
- Defined in library/physics/physics-world.ts:256

queryAABB

queryAABB(bounds: Rectangle, callback: (body: Body$1) => boolean): void
Query AABB (axis-aligned bounding box)
Parameters
- bounds: Rectangle
- callback: (body: Body$1) => boolean
Returns void
- Defined in library/physics/physics-world.ts:146

queryPoint

queryPoint(point: Point, callback: (fixture: Fixture) => boolean): void
Query point
Parameters
- point: Point
- callback: (fixture: Fixture) => boolean
Returns void
- Defined in library/physics/physics-world.ts:158

raycast

raycast(from: Point, to: Point, callback: RaycastCallback): void
Raycast from one point to another
Parameters
- from: Point
- to: Point
- callback: RaycastCallback
Returns void
- Defined in library/physics/physics-world.ts:132

registerBody

registerBody(body: Body$1, logic: PhysicsBodyLogic): void
Register a physics body logic component
Parameters
- body: Body$1
- logic: PhysicsBodyLogic
Returns void
- Defined in library/physics/physics-world.ts:118

step

step(deltaTime: number): void
Step the physics simulation (called by Engine update loop) Uses fixed timestep for deterministic physics
Parameters
- deltaTime: number
Returns void
- Defined in library/physics/physics-world.ts:87

toPhysics

toPhysics(pixels: number): number
Convert pixels to meters
Parameters
- pixels: number
Returns number
- Defined in library/physics/physics-world.ts:178

toPhysicsPoint

toPhysicsPoint(point: Point): Vec2
Convert PIXI Point (pixels) to Planck Vec2 (meters)
Parameters
- point: Point
Returns Vec2
- Defined in library/physics/physics-world.ts:192

toPixels

toPixels(meters: number): number
Convert meters to pixels
Parameters
- meters: number
Returns number
- Defined in library/physics/physics-world.ts:185

toPixelsPoint

toPixelsPoint(vec: Vec2): Point
Convert Planck Vec2 (meters) to PIXI Point (pixels)
Parameters
- vec: Vec2
Returns Point
- Defined in library/physics/physics-world.ts:199

Class PhysicsWorld

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PhysicsWorld

Properties

collisionManager

collisionRegistry

pixelsPerMeter

timestep

world

Methods

createBody

Parameters

Returns Body$1

destroy

Returns void

destroyBody

Parameters

Returns void

disableDebugRenderer

Returns void

enableDebugRenderer

Parameters

Returns PhysicsDebugRenderer

getBodies

Returns Body$1[]

getBodyLogic

Parameters

Returns PhysicsBodyLogic

getDebugRenderer

Returns PhysicsDebugRenderer

queryAABB

Parameters

Returns void

queryPoint

Parameters

Returns void

raycast

Parameters

Returns void

registerBody

Parameters

Returns void

step

Parameters

Returns void

toPhysics

Parameters

Returns number

toPhysicsPoint

Parameters

Returns Vec2

toPixels

Parameters

Returns number

toPixelsPoint

Parameters

Returns Point

Settings

On This Page