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

Function: startBoarding()

startBoarding(sim, eid, vehicle, seat): boolean

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

Starts getting in a vehicle's seat by its door (see the module documentation): the door of the seat nearest the character that a person can stand at, else the nearest across the car one can, else its own nearest. Returns false for a seat the car has not, or one taken or kept for another.

Parameters

sim

SimWorld

eid

number

vehicle

number

seat

number

Returns

boolean