Skip to content
InterfaceTypes & Utilities@public

FlxPhysicsBackendWorld ​

Low-level renderer-neutral world implemented by an optional solver adapter. Game code normally uses FlxPhysicsWorld instead of backend body handles.

ts
export interface FlxPhysicsBackendWorld

Properties ​

PropertyModifiersTypeDescription
capabilitiesreadonlyFlxPhysicsCapabilities-

Methods ​

applyForce() ​

ts
applyForce(body: FlxPhysicsBackendBody, force: FlxPhysicsVector, point?: FlxPhysicsVector): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-
forceFlxPhysicsVector-
pointFlxPhysicsVector-

Returns: void

applyImpulse() ​

ts
applyImpulse(body: FlxPhysicsBackendBody, impulse: FlxPhysicsVector, point?: FlxPhysicsVector): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-
impulseFlxPhysicsVector-
pointFlxPhysicsVector-

Returns: void

createBody() ​

ts
createBody(definition: FlxPhysicsBodyDefinition): FlxPhysicsBackendBody

Parameters:

ParameterTypeDescription
definitionFlxPhysicsBodyDefinition-

Returns: FlxPhysicsBackendBody

createJoint() ​

ts
createJoint?(definition: FlxPhysicsBackendJointDefinition): FlxPhysicsBackendJoint

Parameters:

ParameterTypeDescription
definitionFlxPhysicsBackendJointDefinition-

Returns: FlxPhysicsBackendJoint

destroy() ​

ts
destroy(): void

Returns: void

destroyBody() ​

ts
destroyBody(body: FlxPhysicsBackendBody): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-

Returns: void

destroyJoint() ​

ts
destroyJoint?(joint: FlxPhysicsBackendJoint): void

Parameters:

ParameterTypeDescription
jointFlxPhysicsBackendJoint-

Returns: void

drainContacts() ​

ts
drainContacts(): readonly FlxPhysicsBackendContact[]

Returns: readonly FlxPhysicsBackendContact[]

getBodyState() ​

ts
getBodyState(body: FlxPhysicsBackendBody): FlxPhysicsBodyState

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-

Returns: FlxPhysicsBodyState

getDebugGeometry() ​

ts
getDebugGeometry?(): readonly FlxPhysicsDebugPrimitive[]

Returns: readonly FlxPhysicsDebugPrimitive[]

queryAabb() ​

ts
queryAabb(bounds: FlxPhysicsAabb, filter?: FlxPhysicsQueryFilter): readonly FlxPhysicsBackendQueryHit[]

Parameters:

ParameterTypeDescription
boundsFlxPhysicsAabb-
filterFlxPhysicsQueryFilter-

Returns: readonly FlxPhysicsBackendQueryHit[]

queryPoint() ​

ts
queryPoint(point: FlxPhysicsVector, filter?: FlxPhysicsQueryFilter): readonly FlxPhysicsBackendQueryHit[]

Parameters:

ParameterTypeDescription
pointFlxPhysicsVector-
filterFlxPhysicsQueryFilter-

Returns: readonly FlxPhysicsBackendQueryHit[]

queryRay() ​

ts
queryRay?(query: FlxPhysicsRayQuery): readonly FlxPhysicsBackendQueryHit[]

Parameters:

ParameterTypeDescription
queryFlxPhysicsRayQuery-

Returns: readonly FlxPhysicsBackendQueryHit[]

reset() ​

ts
reset(): void

Returns: void

setBodyTransform() ​

ts
setBodyTransform(body: FlxPhysicsBackendBody, transform: FlxPhysicsTransform): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-
transformFlxPhysicsTransform-

Returns: void

setBodyType() ​

ts
setBodyType(body: FlxPhysicsBackendBody, type: FlxPhysicsBodyType): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-
typeFlxPhysicsBodyType-

Returns: void

setBodyVelocity() ​

ts
setBodyVelocity(body: FlxPhysicsBackendBody, velocity: FlxPhysicsVector, angularVelocity: number): void

Parameters:

ParameterTypeDescription
bodyFlxPhysicsBackendBody-
velocityFlxPhysicsVector-
angularVelocitynumber-

Returns: void

setGravity() ​

ts
setGravity(gravity: FlxPhysicsVector): void

Parameters:

ParameterTypeDescription
gravityFlxPhysicsVector-

Returns: void

step() ​

ts
step(elapsed: number): void

Parameters:

ParameterTypeDescription
elapsednumber-

Returns: void

Released under the MIT License.