Skip to content

five-on-it / packages/sim/src/boarding / boardingBeat

Function: boardingBeat() ​

boardingBeat(sim, eid, body): boolean

Defined in: packages/sim/src/boarding.ts:206

One tick of getting in or out of a car, if the character is at it (see the module documentation): standing at the door it just got out of; getting in at a door, then seated; or on its way to the door, giving up when it may no longer get in. Returns whether it was busy with it (the character system does nothing else with it this tick).

Parameters ​

sim ​

SimWorld

eid ​

number

body ​

RigidBody

Returns ​

boolean