Physics2DAPI
Defined in: physics/Physics2D.ts:42
Unit contract: Box2D simulates in meters; the engine converts at the
pixels-per-unit (PPU) boundary. Spatial queries (raycast / shapeCast /
overlapCircle / moveCharacter) take and return world pixels, scaled by
the live PPU. Everything that talks to the solver directly — forces, impulses,
velocities, setGravity — is in meters (m/s, m/s²), matching the collider
component dimensions. Convert with getPixelsPerUnit when mixing the two.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Physics2DAPI(
app):Physics2DAPI
Defined in: physics/Physics2D.ts:72
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Physics2DAPI
Methods
Section titled “Methods”applyAngularImpulse()
Section titled “applyAngularImpulse()”applyAngularImpulse(
entity,impulse):void
Defined in: physics/Physics2D.ts:130
Parameters
Section titled “Parameters”entity
Section titled “entity”number
impulse
Section titled “impulse”number
Returns
Section titled “Returns”void
applyForce()
Section titled “applyForce()”applyForce(
entity,force):void
Defined in: physics/Physics2D.ts:89
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
applyImpulse()
Section titled “applyImpulse()”applyImpulse(
entity,impulse):void
Defined in: physics/Physics2D.ts:93
Parameters
Section titled “Parameters”entity
Section titled “entity”number
impulse
Section titled “impulse”Returns
Section titled “Returns”void
applyTorque()
Section titled “applyTorque()”applyTorque(
entity,torque):void
Defined in: physics/Physics2D.ts:126
Parameters
Section titled “Parameters”entity
Section titled “entity”number
torque
Section titled “torque”number
Returns
Section titled “Returns”void
createMouseJoint()
Section titled “createMouseJoint()”createMouseJoint(
entity,target,opts?,ppu?):boolean
Defined in: physics/Physics2D.ts:467
Parameters
Section titled “Parameters”entity
Section titled “entity”number
target
Section titled “target”dampingRatio?
Section titled “dampingRatio?”number
hertz?
Section titled “hertz?”number
maxForce?
Section titled “maxForce?”number
number = ...
Returns
Section titled “Returns”boolean
createRevoluteJoint()
Section titled “createRevoluteJoint()”createRevoluteJoint(
entityA,entityB,anchorA,anchorB,options?):boolean
Defined in: physics/Physics2D.ts:134
Parameters
Section titled “Parameters”entityA
Section titled “entityA”number
entityB
Section titled “entityB”number
anchorA
Section titled “anchorA”anchorB
Section titled “anchorB”options?
Section titled “options?”collideConnected?
Section titled “collideConnected?”boolean
enableLimit?
Section titled “enableLimit?”boolean
enableMotor?
Section titled “enableMotor?”boolean
lowerAngle?
Section titled “lowerAngle?”number
maxMotorTorque?
Section titled “maxMotorTorque?”number
motorSpeed?
Section titled “motorSpeed?”number
upperAngle?
Section titled “upperAngle?”number
Returns
Section titled “Returns”boolean
destroyJoint()
Section titled “destroyJoint()”destroyJoint(
entity):void
Defined in: physics/Physics2D.ts:153
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
destroyMouseJoint()
Section titled “destroyMouseJoint()”destroyMouseJoint():
void
Defined in: physics/Physics2D.ts:483
Returns
Section titled “Returns”void
enableDistanceJointLimit()
Section titled “enableDistanceJointLimit()”enableDistanceJointLimit(
entity,enable):void
Defined in: physics/Physics2D.ts:352
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableDistanceJointMotor()
Section titled “enableDistanceJointMotor()”enableDistanceJointMotor(
entity,enable):void
Defined in: physics/Physics2D.ts:360
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableDistanceJointSpring()
Section titled “enableDistanceJointSpring()”enableDistanceJointSpring(
entity,enable):void
Defined in: physics/Physics2D.ts:348
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enablePrismaticJointLimit()
Section titled “enablePrismaticJointLimit()”enablePrismaticJointLimit(
entity,enable):void
Defined in: physics/Physics2D.ts:388
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enablePrismaticJointMotor()
Section titled “enablePrismaticJointMotor()”enablePrismaticJointMotor(
entity,enable):void
Defined in: physics/Physics2D.ts:396
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enablePrismaticJointSpring()
Section titled “enablePrismaticJointSpring()”enablePrismaticJointSpring(
entity,enable):void
Defined in: physics/Physics2D.ts:384
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableRevoluteLimit()
Section titled “enableRevoluteLimit()”enableRevoluteLimit(
entity,enable):void
Defined in: physics/Physics2D.ts:169
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableRevoluteMotor()
Section titled “enableRevoluteMotor()”enableRevoluteMotor(
entity,enable):void
Defined in: physics/Physics2D.ts:165
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableWheelJointLimit()
Section titled “enableWheelJointLimit()”enableWheelJointLimit(
entity,enable):void
Defined in: physics/Physics2D.ts:416
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableWheelJointMotor()
Section titled “enableWheelJointMotor()”enableWheelJointMotor(
entity,enable):void
Defined in: physics/Physics2D.ts:424
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
enableWheelJointSpring()
Section titled “enableWheelJointSpring()”enableWheelJointSpring(
entity,enable):void
Defined in: physics/Physics2D.ts:412
Parameters
Section titled “Parameters”entity
Section titled “entity”number
enable
Section titled “enable”boolean
Returns
Section titled “Returns”void
getAngularVelocity()
Section titled “getAngularVelocity()”getAngularVelocity(
entity):number
Defined in: physics/Physics2D.ts:122
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getCenterOfMass()
Section titled “getCenterOfMass()”getCenterOfMass(
entity,ppu?):Vec2
Defined in: physics/Physics2D.ts:319
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”getDistanceJointCurrentLength()
Section titled “getDistanceJointCurrentLength()”getDistanceJointCurrentLength(
entity,ppu?):number
Defined in: physics/Physics2D.ts:340
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”number
getDistanceJointLength()
Section titled “getDistanceJointLength()”getDistanceJointLength(
entity,ppu?):number
Defined in: physics/Physics2D.ts:336
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”number
getDistanceJointMotorForce()
Section titled “getDistanceJointMotorForce()”getDistanceJointMotorForce(
entity):number
Defined in: physics/Physics2D.ts:372
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getGravity()
Section titled “getGravity()”getGravity():
Vec2
Defined in: physics/Physics2D.ts:112
Returns
Section titled “Returns”getInertia()
Section titled “getInertia()”getInertia(
entity):number
Defined in: physics/Physics2D.ts:315
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getLinearVelocity()
Section titled “getLinearVelocity()”getLinearVelocity(
entity):Vec2
Defined in: physics/Physics2D.ts:101
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”getMass()
Section titled “getMass()”getMass(
entity):number
Defined in: physics/Physics2D.ts:311
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getMassData()
Section titled “getMassData()”getMassData(
entity,ppu?):MassData
Defined in: physics/Physics2D.ts:328
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”getPixelsPerUnit()
Section titled “getPixelsPerUnit()”getPixelsPerUnit():
number
Defined in: physics/Physics2D.ts:68
Live pixels-per-unit (world pixels per Box2D meter). Collider dimensions are stored in meters, so consumers that cast a collider’s shape through the pixel-space query API (raycast/shapeCast) must scale by this.
Returns
Section titled “Returns”number
getPrismaticJointMotorForce()
Section titled “getPrismaticJointMotorForce()”getPrismaticJointMotorForce(
entity):number
Defined in: physics/Physics2D.ts:408
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getPrismaticJointSpeed()
Section titled “getPrismaticJointSpeed()”getPrismaticJointSpeed(
entity,ppu?):number
Defined in: physics/Physics2D.ts:380
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”number
getPrismaticJointTranslation()
Section titled “getPrismaticJointTranslation()”getPrismaticJointTranslation(
entity,ppu?):number
Defined in: physics/Physics2D.ts:376
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number = ...
Returns
Section titled “Returns”number
getRevoluteAngle()
Section titled “getRevoluteAngle()”getRevoluteAngle(
entity):number
Defined in: physics/Physics2D.ts:177
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getRevoluteMotorTorque()
Section titled “getRevoluteMotorTorque()”getRevoluteMotorTorque(
entity):number
Defined in: physics/Physics2D.ts:181
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
getWheelJointMotorTorque()
Section titled “getWheelJointMotorTorque()”getWheelJointMotorTorque(
entity):number
Defined in: physics/Physics2D.ts:436
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”number
hasMouseJoint()
Section titled “hasMouseJoint()”hasMouseJoint():
boolean
Defined in: physics/Physics2D.ts:487
Returns
Section titled “Returns”boolean
isAwake()
Section titled “isAwake()”isAwake(
entity):boolean
Defined in: physics/Physics2D.ts:225
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”boolean
moveCharacter()
Section titled “moveCharacter()”moveCharacter(
pos,c1,c2,radius,velocity,dt,up,floorCos,maskBits,self,skinWidth?,maxSlides?,snapLength?,slideOnCeiling?,ppu?):MoverResult|null
Defined in: physics/Physics2D.ts:276
Advance a kinematic capsule character one step against the world using Box2D’s
native mover (collide-into-planes + depenetrating slide). Unlike a raw shape
cast this resolves resting/touching contacts with valid normals, so a grounded
character slides instead of wedging. Capsule endpoints/radius and pos/velocity
are world pixels; dt seconds; up a unit vector; floorCos = cos(floorMaxAngle).
self is excluded from the collision. Returns null if the module isn’t ready.
Parameters
Section titled “Parameters”radius
Section titled “radius”number
velocity
Section titled “velocity”number
floorCos
Section titled “floorCos”number
maskBits
Section titled “maskBits”number
number
skinWidth?
Section titled “skinWidth?”number = 0
maxSlides?
Section titled “maxSlides?”number = 5
snapLength?
Section titled “snapLength?”number = 0
slideOnCeiling?
Section titled “slideOnCeiling?”boolean = true
number = ...
Returns
Section titled “Returns”MoverResult | null
overlapAABB()
Section titled “overlapAABB()”overlapAABB(
min,max,maskBits?,ppu?):number[]
Defined in: physics/Physics2D.ts:302
Parameters
Section titled “Parameters”maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”number[]
overlapCircle()
Section titled “overlapCircle()”overlapCircle(
center,radius,maskBits?,ppu?):number[]
Defined in: physics/Physics2D.ts:212
Parameters
Section titled “Parameters”center
Section titled “center”radius
Section titled “radius”number
maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”number[]
raycast()
Section titled “raycast()”raycast(
origin,direction,maxDistance,maskBits?,ppu?):RaycastHit[]
Defined in: physics/Physics2D.ts:185
Parameters
Section titled “Parameters”origin
Section titled “origin”direction
Section titled “direction”maxDistance
Section titled “maxDistance”number
maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”setAngularVelocity()
Section titled “setAngularVelocity()”setAngularVelocity(
entity,omega):void
Defined in: physics/Physics2D.ts:118
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setAwake()
Section titled “setAwake()”setAwake(
entity,awake):void
Defined in: physics/Physics2D.ts:221
Parameters
Section titled “Parameters”entity
Section titled “entity”number
boolean
Returns
Section titled “Returns”void
setDistanceJointLength()
Section titled “setDistanceJointLength()”setDistanceJointLength(
entity,length,ppu?):void
Defined in: physics/Physics2D.ts:344
Parameters
Section titled “Parameters”entity
Section titled “entity”number
length
Section titled “length”number
number = ...
Returns
Section titled “Returns”void
setDistanceJointLimits()
Section titled “setDistanceJointLimits()”setDistanceJointLimits(
entity,minLength,maxLength,ppu?):void
Defined in: physics/Physics2D.ts:356
Parameters
Section titled “Parameters”entity
Section titled “entity”number
minLength
Section titled “minLength”number
maxLength
Section titled “maxLength”number
number = ...
Returns
Section titled “Returns”void
setDistanceJointMaxMotorForce()
Section titled “setDistanceJointMaxMotorForce()”setDistanceJointMaxMotorForce(
entity,force):void
Defined in: physics/Physics2D.ts:368
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setDistanceJointMotorSpeed()
Section titled “setDistanceJointMotorSpeed()”setDistanceJointMotorSpeed(
entity,speed):void
Defined in: physics/Physics2D.ts:364
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setGravity()
Section titled “setGravity()”setGravity(
gravity):void
Defined in: physics/Physics2D.ts:108
World gravity in meters/s² (Box2D space), e.g. { x: 0, y: -9.81 }.
Parameters
Section titled “Parameters”gravity
Section titled “gravity”Returns
Section titled “Returns”void
setLinearVelocity()
Section titled “setLinearVelocity()”setLinearVelocity(
entity,velocity):void
Defined in: physics/Physics2D.ts:97
Parameters
Section titled “Parameters”entity
Section titled “entity”number
velocity
Section titled “velocity”Returns
Section titled “Returns”void
setMotorJointAngularVelocity()
Section titled “setMotorJointAngularVelocity()”setMotorJointAngularVelocity(
entity,omega):void
Defined in: physics/Physics2D.ts:448
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setMotorJointLinearVelocity()
Section titled “setMotorJointLinearVelocity()”setMotorJointLinearVelocity(
entity,velocity,ppu?):void
Defined in: physics/Physics2D.ts:444
Parameters
Section titled “Parameters”entity
Section titled “entity”number
velocity
Section titled “velocity”number = ...
Returns
Section titled “Returns”void
setMotorJointMaxVelocityForce()
Section titled “setMotorJointMaxVelocityForce()”setMotorJointMaxVelocityForce(
entity,force):void
Defined in: physics/Physics2D.ts:452
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setMotorJointMaxVelocityTorque()
Section titled “setMotorJointMaxVelocityTorque()”setMotorJointMaxVelocityTorque(
entity,torque):void
Defined in: physics/Physics2D.ts:456
Parameters
Section titled “Parameters”entity
Section titled “entity”number
torque
Section titled “torque”number
Returns
Section titled “Returns”void
setMouseTarget()
Section titled “setMouseTarget()”setMouseTarget(
target,ppu?):void
Defined in: physics/Physics2D.ts:479
Parameters
Section titled “Parameters”target
Section titled “target”number = ...
Returns
Section titled “Returns”void
setPrismaticJointLimits()
Section titled “setPrismaticJointLimits()”setPrismaticJointLimits(
entity,lower,upper,ppu?):void
Defined in: physics/Physics2D.ts:392
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
number = ...
Returns
Section titled “Returns”void
setPrismaticJointMaxMotorForce()
Section titled “setPrismaticJointMaxMotorForce()”setPrismaticJointMaxMotorForce(
entity,force):void
Defined in: physics/Physics2D.ts:404
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setPrismaticJointMotorSpeed()
Section titled “setPrismaticJointMotorSpeed()”setPrismaticJointMotorSpeed(
entity,speed):void
Defined in: physics/Physics2D.ts:400
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setRevoluteLimits()
Section titled “setRevoluteLimits()”setRevoluteLimits(
entity,lower,upper):void
Defined in: physics/Physics2D.ts:173
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
Returns
Section titled “Returns”void
setRevoluteMaxMotorTorque()
Section titled “setRevoluteMaxMotorTorque()”setRevoluteMaxMotorTorque(
entity,torque):void
Defined in: physics/Physics2D.ts:161
Parameters
Section titled “Parameters”entity
Section titled “entity”number
torque
Section titled “torque”number
Returns
Section titled “Returns”void
setRevoluteMotorSpeed()
Section titled “setRevoluteMotorSpeed()”setRevoluteMotorSpeed(
entity,speed):void
Defined in: physics/Physics2D.ts:157
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setWheelJointLimits()
Section titled “setWheelJointLimits()”setWheelJointLimits(
entity,lower,upper,ppu?):void
Defined in: physics/Physics2D.ts:420
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
number = ...
Returns
Section titled “Returns”void
setWheelJointMaxMotorTorque()
Section titled “setWheelJointMaxMotorTorque()”setWheelJointMaxMotorTorque(
entity,torque):void
Defined in: physics/Physics2D.ts:432
Parameters
Section titled “Parameters”entity
Section titled “entity”number
torque
Section titled “torque”number
Returns
Section titled “Returns”void
setWheelJointMotorSpeed()
Section titled “setWheelJointMotorSpeed()”setWheelJointMotorSpeed(
entity,speed):void
Defined in: physics/Physics2D.ts:428
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
shapeCastBox()
Section titled “shapeCastBox()”shapeCastBox(
center,halfExtents,angle,translation,maskBits?,ppu?):RaycastHit[]
Defined in: physics/Physics2D.ts:241
Parameters
Section titled “Parameters”center
Section titled “center”halfExtents
Section titled “halfExtents”number
translation
Section titled “translation”maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”shapeCastCapsule()
Section titled “shapeCastCapsule()”shapeCastCapsule(
center1,center2,radius,translation,maskBits?,ppu?):RaycastHit[]
Defined in: physics/Physics2D.ts:254
Parameters
Section titled “Parameters”center1
Section titled “center1”center2
Section titled “center2”radius
Section titled “radius”number
translation
Section titled “translation”maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”shapeCastCircle()
Section titled “shapeCastCircle()”shapeCastCircle(
center,radius,translation,maskBits?,ppu?):RaycastHit[]
Defined in: physics/Physics2D.ts:229
Parameters
Section titled “Parameters”center
Section titled “center”radius
Section titled “radius”number
translation
Section titled “translation”maskBits?
Section titled “maskBits?”number = 0xFFFF
number = ...
Returns
Section titled “Returns”setDebugDraw()
Section titled “setDebugDraw()”
staticsetDebugDraw(app,enabled):void
Defined in: physics/Physics2D.ts:523
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
setDebugDrawConfig()
Section titled “setDebugDrawConfig()”
staticsetDebugDrawConfig(app,config):void
Defined in: physics/Physics2D.ts:531
Parameters
Section titled “Parameters”config
Section titled “config”Partial<Physics2DDebugDrawConfig>
Returns
Section titled “Returns”void