Kiln API / kiln/physics / PhysicsState

Class: PhysicsState

The Rapier world plus Kiln's entity mapping. Use res.mut(Physics) for impulses and raycasts.

Constructors

Constructor

new PhysicsState(
   rapier, 
   world, 
   is2D
): PhysicsState;

Parameters

Parameter	Type
rapier	any
world	any
is2D	boolean

Returns

PhysicsState

Properties

bodies

readonly bodies: Map<Entity, Created>;

---

colliderOwner

readonly colliderOwner: Map<number, Entity>;

---

eventQueue

readonly eventQueue: any;

---

rapier

readonly rapier: any;

---

world

readonly world: any;

---

is2D

readonly is2D: boolean;

Methods

bodyOf()

bodyOf(e): any;

The Rapier body for an entity, once created (the step after RigidBody was added).

Parameters

Parameter	Type
e	Entity

Returns

any

---

applyImpulse()

applyImpulse(e, impulse): void;

Adds an instantaneous change in momentum (mass × velocity).

Parameters

Parameter	Type
e	Entity
impulse	Partial<Vec3>

Returns

void

---

setVelocity()

setVelocity(e, v): void;

Sets linear velocity directly (same as writing LinearVelocity).

Parameters

Parameter	Type
e	Entity
v	Partial<Vec3>

Returns

void

---

raycast()

raycast(
   origin, 
   dir, 
   maxDistance?, 
   exclude?
): RaycastHit | null;

Casts a ray and returns the first hit, or null. exclude skips one entity's colliders.

Parameters

Parameter	Type	Default value
origin	Vec3	undefined
dir	Vec3	undefined
maxDistance	number	1000
exclude?	Entity	undefined

Returns

RaycastHit | null

---

remove()

remove(e): void;

Parameters

Parameter	Type
e	Entity

Returns

void