Interface: IPhysicsWorld2D

Core interface types.

Methods

CreateBody()

CreateBody(def): IPhysicsBody2D;

Parameters

Parameter	Type
def	Body2DDef

Returns

IPhysicsBody2D

---

CreateJoint()

CreateJoint(def): IPhysicsJoint2D | null;

Null when the definition is degenerate (same body twice, zero length, ...).

Parameters

Parameter	Type
def	Joint2DDef

Returns

IPhysicsJoint2D | null

---

Destroy()

Destroy(): void;

Returns

void

---

DestroyBody()

DestroyBody(body): void;

Parameters

Parameter	Type
body	IPhysicsBody2D

Returns

void

---

ForEachContact()

ForEachContact(cb): void;

Every touching contact, with its current manifold (Stay events).

Parameters

Parameter	Type
cb	(a, b, manifold) => void

Returns

void

---

GetGroundBody()

GetGroundBody(): IPhysicsBody2D;

A static body at the origin with no fixtures — the "world" end of a joint.

Returns

IPhysicsBody2D

---

QueryPoint()

QueryPoint(
   x, 
   y, 
   cb
): void;

Parameters

Parameter	Type
x	number
y	number
cb	(fixture) => boolean

Returns

void

---

QueryShape()

QueryShape(
   shape, 
   x, 
   y, 
   angle, 
   cb
): void;

Fixtures overlapping shape placed at (x, y, angle). cb returns false to stop.

Parameters

Parameter	Type
shape	Shape2D
x	number
y	number
angle	number
cb	(fixture) => boolean

Returns

void

---

RayCast()

RayCast(
   x1, 
   y1, 
   x2, 
   y2, 
   cb
): void;

Closest-first is the caller's job: cb returns the new max fraction (Box2D convention: 0 stops, fraction clips, 1 continues unclipped, -1 skips the fixture).

Parameters

Parameter	Type
x1	number
y1	number
x2	number
y2	number
cb	(fixture, px, py, nx, ny, fraction) => number

Returns

void

---

SetAllowSleep()

SetAllowSleep(allow): void;

Parameters

Parameter	Type
allow	boolean

Returns

void

---

SetContactListener()

SetContactListener(listener): void;

Parameters

Parameter	Type
listener	IContactListener2D | null

Returns

void

---

SetGravity()

SetGravity(x, y): void;

Parameters

Parameter	Type
x	number
y	number

Returns

void

---

Step()

Step(
   dt, 
   velocityIterations, 
   positionIterations
): void;

Parameters

Parameter	Type
dt	number
velocityIterations	number
positionIterations	number

Returns

void