RigidBodyComponent

Defined in: physics/src/RigidBodyComponent.ts:26

Wraps a Rapier rigid body. All public API values are in pixels.

Component ordering: Transform must be added before RigidBodyComponent.

Extends

Component

Constructors

Constructor

new RigidBodyComponent(config): RigidBodyComponent

Defined in: physics/src/RigidBodyComponent.ts:51

Parameters

config

RigidBodyConfig

Returns

RigidBodyComponent

Overrides

Component.constructor

Properties

_bodyHandle

_bodyHandle: number = -1

Defined in: physics/src/RigidBodyComponent.ts:34

Internal

Rapier body handle, set during onAdd.

_currPosition

_currPosition: Vec2 = Vec2.ZERO

Defined in: physics/src/RigidBodyComponent.ts:41

Internal

Current authoritative position (post physics step).

_currRotation

_currRotation: number = 0

Defined in: physics/src/RigidBodyComponent.ts:43

Internal

Current authoritative rotation (post physics step).

_prevPosition

_prevPosition: Vec2 = Vec2.ZERO

Defined in: physics/src/RigidBodyComponent.ts:37

Internal

Previous position for interpolation.

_prevRotation

_prevRotation: number = 0

Defined in: physics/src/RigidBodyComponent.ts:39

Internal

Previous rotation for interpolation.

_teleported

_teleported: boolean = false

Defined in: physics/src/RigidBodyComponent.ts:45

Internal

If true, skip interpolation on next frame (teleport).

enabled

enabled: boolean

Defined in: core/dist/index.d.ts:542

Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.

Inherited from

Component.enabled

entity

entity: Entity

Defined in: core/dist/index.d.ts:540

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

syncRotation

syncRotation: boolean

Defined in: physics/src/RigidBodyComponent.ts:31

If false, physics will not write rotation back to Transform.

type

readonly type: BodyType

Defined in: physics/src/RigidBodyComponent.ts:28

Body type (dynamic, static, kinematic).

Accessors

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:554

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:549

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over this.entity.scene! in component methods.

Returns

Scene

Inherited from

Component.scene

Methods

_runCleanups()

_runCleanups(): void

Defined in: core/dist/index.d.ts:584

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:578

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()

afterRestore(data): void

Defined in: physics/src/RigidBodyComponent.ts:237

Restore runtime state (velocities) after the Rapier body has been created.

Parameters

data

unknown

Returns

void

Overrides

Component.afterRestore

applyForce()

applyForce(force): void

Defined in: physics/src/RigidBodyComponent.ts:92

Apply a force (in pixels) at the center of mass.

Parameters

force

Vec2Like

Returns

void

applyImpulse()

applyImpulse(impulse): void

Defined in: physics/src/RigidBodyComponent.ts:105

Apply an impulse (in pixels) at the center of mass.

Parameters

impulse

Vec2Like

Returns

void

applyTorque()

applyTorque(torque): void

Defined in: physics/src/RigidBodyComponent.ts:154

Apply torque.

Parameters

torque

number

Returns

void

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:594

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

getAngularVelocity()

getAngularVelocity(): number

Defined in: physics/src/RigidBodyComponent.ts:168

Get angular velocity in radians/s.

Returns

number

getVelocity()

getVelocity(): Vec2

Defined in: physics/src/RigidBodyComponent.ts:143

Get linear velocity in pixels/s.

Returns

Vec2

listen()

protected listen<T>(entity, token, handler): void

Defined in: core/dist/index.d.ts:574

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: core/dist/index.d.ts:576

Subscribe to scene-level bubbled events, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity) => void

Returns

void

Inherited from

Component.listenScene

lockRotations()

lockRotations(locked): void

Defined in: physics/src/RigidBodyComponent.ts:182

Lock or unlock rotations at runtime.

Parameters

locked

boolean

Returns

void

onAdd()

onAdd(): void

Defined in: physics/src/RigidBodyComponent.ts:58

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: physics/src/RigidBodyComponent.ts:84

Called when the component is destroyed (entity destroyed or component removed).

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: core/dist/index.d.ts:588

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

serialize()

serialize(): RigidBodyData

Defined in: physics/src/RigidBodyComponent.ts:206

Serialize the component into a plain data object.

Returns

RigidBodyData

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:564

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly camera = this.service(CameraKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

setAngularVelocity()

setAngularVelocity(v): void

Defined in: physics/src/RigidBodyComponent.ts:161

Set angular velocity in radians/s.

Parameters

v

number

Returns

void

setEnabledTranslations()

setEnabledTranslations(enableX, enableY): void

Defined in: physics/src/RigidBodyComponent.ts:175

Set which translation axes are enabled at runtime.

Parameters

enableX

boolean

enableY

boolean

Returns

void

setPosition()

setPosition(x, y): void

Defined in: physics/src/RigidBodyComponent.ts:189

Teleport to a position in pixels. Skips interpolation on next frame.

Parameters

x

number

y

number

Returns

void

setVelocity()

setVelocity(velocity): void

Defined in: physics/src/RigidBodyComponent.ts:118

Set linear velocity in pixels/s.

Parameters

velocity

Vec2Like

Returns

void

setVelocityX()

setVelocityX(vx): void

Defined in: physics/src/RigidBodyComponent.ts:131

Set only the X component of velocity (px/s), preserving Y.

Parameters

vx

number

Returns

void

setVelocityY()

setVelocityY(vy): void

Defined in: physics/src/RigidBodyComponent.ts:137

Set only the Y component of velocity (px/s), preserving X.

Parameters

vy

number

Returns

void

sibling()

protected sibling<C>(cls): C

Defined in: core/dist/index.d.ts:572

Lazy proxy-based sibling component resolution. Can be used at field-declaration time:

readonly anim = this.sibling(AnimatedSpriteComponent);

The actual resolution is deferred until first property access.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

update()?

optional update(dt): void

Defined in: core/dist/index.d.ts:592

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:556

Resolve a service by key, cached after first lookup.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): RigidBodyComponent

Defined in: physics/src/RigidBodyComponent.ts:223

Create a RigidBodyComponent from a serialized snapshot.

Parameters

data

RigidBodyData

Returns

RigidBodyComponent