five-on-it / packages/sim/src/proxy / setDormant

Function: setDormant()

setDormant(sim, eid, dormant): void

Defined in: packages/sim/src/proxy.ts:96

Lets a vehicle (and its trailer) doze, or wakes it: its body held still (kinematic) or simulated again (dynamic), its pose and velocities kept. What the dormant cars' system does when one dozes off (dormant.ts), and what a client's twin does when a snapshot says so. Nothing for an entity with no body.

Parameters

sim

SimWorld

eid

number

dormant

boolean

Returns

void