ColliderComponent

Defined in: physics/src/ColliderComponent.ts:19

Wraps a Rapier collider. Attach after RigidBodyComponent.

Component ordering: Transform → RigidBodyComponent → ColliderComponent.

Extends

Component

Constructors

Constructor

new ColliderComponent(config): ColliderComponent

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

Parameters

config

ColliderConfig

Returns

ColliderComponent

Overrides

Component.constructor

Properties

_colliderHandle

_colliderHandle: number = -1

Defined in: physics/src/ColliderComponent.ts:24

Internal

Rapier collider handle, set during onAdd.

config

readonly config: ColliderConfig

Defined in: physics/src/ColliderComponent.ts:21

Collider configuration (shape, sensor, etc.).

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

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

_dispatchCollision()

_dispatchCollision(event): void

Defined in: physics/src/ColliderComponent.ts:111

Internal

Called by PhysicsWorld during event dispatch.

Parameters

event

CollisionEvent

Returns

void

_dispatchTrigger()

_dispatchTrigger(event): void

Defined in: physics/src/ColliderComponent.ts:120

Internal

Called by PhysicsWorld during event dispatch.

Parameters

event

TriggerEvent

Returns

void

_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()?

optional afterRestore(data, resolve): void

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

Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

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

getOverlapping()

Call Signature

getOverlapping<T>(filter): Entity & T[]

Defined in: physics/src/ColliderComponent.ts:73

Return all entities whose colliders currently overlap this one, optionally filtered.

Type Parameters

T

T

Parameters

filter

EntityFilter & object

Returns

Entity & T[]

Call Signature

getOverlapping(filter?): Entity[]

Defined in: physics/src/ColliderComponent.ts:74

Return all entities whose colliders currently overlap this one, optionally filtered.

Parameters

filter?

EntityFilter

Returns

Entity[]

getOverlappingComponents()

getOverlappingComponents<C>(cls): C[]

Defined in: physics/src/ColliderComponent.ts:81

Return components of type C from all overlapping entities that have one.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C[]

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

onAdd()

onAdd(): void

Defined in: physics/src/ColliderComponent.ts:36

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onCollision()

onCollision(handler): () => void

Defined in: physics/src/ColliderComponent.ts:55

Subscribe to collision events. Returns an unsubscribe function.

Parameters

handler

(e) => void

Returns

() => void

onDestroy()

onDestroy(): void

Defined in: physics/src/ColliderComponent.ts:49

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

onTrigger()

onTrigger(handler): () => void

Defined in: physics/src/ColliderComponent.ts:64

Subscribe to trigger events (sensor). Returns an unsubscribe function.

Parameters

handler

(e) => void

Returns

() => void

serialize()

serialize(): ColliderData

Defined in: physics/src/ColliderComponent.ts:99

Serialize the component into a plain data object.

Returns

ColliderData

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

setSensor()

setSensor(sensor): void

Defined in: physics/src/ColliderComponent.ts:91

Set whether this collider is a sensor.

Parameters

sensor

boolean

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): ColliderComponent

Defined in: physics/src/ColliderComponent.ts:104

Create a ColliderComponent from a serialized snapshot.

Parameters

data

ColliderData

Returns

ColliderComponent