five-on-it / packages/sim/src/character / exitVehicle

Function: exitVehicle()

exitVehicle(sim, eid, spot?, forced?): boolean

Defined in: packages/sim/src/character.ts:1429

Gets a character out of its vehicle at its seat's door (or at spot), on its feet, facing out: at the first free spot from the door along the car (exitPoint), never into a wall, another car or a person. With every spot blocked, a character getting out of its own accord stays in its seat (forced false: the doors are blocked) and the call returns false; one that must get out (pulled out, its car gone, put out) is set down at the door asked for. A no-op on foot (false). It neither looks at the car's speed nor stands the character at the door a moment: getting out by the interaction key does (boarding.ts).

Parameters

sim

SimWorld

eid

number

spot?

VehicleDoor

forced?

boolean = true

Returns

boolean