Class CollisionBuilder

Fluent collision setup builder returned by PhysicsHelper.collide().

Example

PhysicsHelper.collide(scene, player)
  .with(platforms)
  .onHit((p, platform) => { ... });

Example

PhysicsHelper.collide(scene, bullets)
  .with(enemies)
  .asOverlap((bullet, enemy) => {
    bullet.destroy();
    takeDamage(enemy);
  });

Index

Methods

asOverlap onHit onProcess with

Methods

asOverlap

asOverlap(callback?: ArcadePhysicsCallback): Collider | null
Create an overlap sensor between the two objects. Bodies pass through each other; the callback fires when they overlap.
Parameters
- Optionalcallback: ArcadePhysicsCallback
Returns Collider | null
The created Collider (overlap), or null if physics is not available.
- Defined in packages/clik-engine/src/physics/CollisionBuilder.ts:70

onHit

onHit(callback?: ArcadePhysicsCallback): Collider | null
Create a solid collider between the two objects. Bodies bounce off each other and cannot overlap.
Parameters
- Optionalcallback: ArcadePhysicsCallback
Returns Collider | null
The created Collider, or null if physics is not available.
- Defined in packages/clik-engine/src/physics/CollisionBuilder.ts:53

onProcess

onProcess(callback: ArcadePhysicsCallback): this
Optional process callback — return false to prevent the collision response for that specific pair this frame (e.g., one-way platforms).
Parameters
- callback: ArcadePhysicsCallback
Returns this
- Defined in packages/clik-engine/src/physics/CollisionBuilder.ts:43

with

with(b: PhysicsTarget): this
Set the second collision target
Parameters
- b: PhysicsTarget
Returns this
- Defined in packages/clik-engine/src/physics/CollisionBuilder.ts:34