@bendyline/molen-kernel/vehicles

Molen headless deterministic simulation kernel (no DOM, no three.js).

import { /* … */ } from '@bendyline/molen-kernel/vehicles';

Interfaces

MountableData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

exits

exits: [number, number, number][];

reach

reach: number;

seats

seats: SeatData[];

---

MountedData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

seat

seat: string;

vehicle

vehicle: string;

---

SeatData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

id

id: string;

position

position: [number, number, number];

role

role: "driver" | "passenger";

---

VehicleEnvironment

Host collision adapter. All positions are absolute metric coordinates.

Methods

canExit()?

optional canExit(
   position, 
   actor, 
   vehicle
): boolean;

Parameters

position

[number, number, number]

actor

string

vehicle

string

Returns

boolean

canOccupy()?

optional canOccupy(
   position, 
   yaw, 
   spec, 
   entity
): boolean;

Parameters

position

[number, number, number]

yaw

number

spec

VehicleSpec

entity

string

Returns

boolean

groundHeight()

groundHeight(x, z): number | undefined;

Parameters

x

number

z

number

Returns

number | undefined

---

VehicleInputData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

brake

brake: boolean;

steering

steering: number;

throttle

throttle: number;

---

VehicleStateData

Extends

• JsonObject

Indexable

[key: string]: JsonValue | undefined

Properties

grounded

grounded: boolean;

pitch

pitch: number;

roll

roll: number;

speed

speed: number;

steer

steer: number;

vy

vy: number;

waitingForTerrain

waitingForTerrain: boolean;

wheelAngle

wheelAngle: number;

yaw

yaw: number;

Variables

IDLE_VEHICLE_INPUT

const IDLE_VEHICLE_INPUT: VehicleInputData;

---

Mountable

const Mountable: ComponentType<MountableData>;

---

Mounted

const Mounted: ComponentType<MountedData>;

---

Vehicle

const Vehicle: ComponentType<VehicleData>;

---

VehicleInput

const VehicleInput: ComponentType<VehicleInputData>;

---

VehicleState

const VehicleState: ComponentType<VehicleStateData>;

Functions

driveVehicle()

function driveVehicle(
   world, 
   actor, 
   input
): boolean;

Parameters

world

World

actor

string

input

VehicleInputData

Returns

boolean

---

initialVehicleState()

function initialVehicleState(yaw?): VehicleStateData;

Parameters

yaw?

number

Returns

VehicleStateData

---

installMountedSeats()

function installMountedSeats(world): void;

Shared seat following, installed once by either vehicle capability.

Parameters

world

World

Returns

void

---

installVehicles()

function installVehicles(world, environment?): void;

Parameters

world

World

environment?

VehicleEnvironment

Returns

void

---

mountEntity()

function mountEntity(
   world, 
   actor, 
   vehicle, 
   seatId?
): boolean;

Parameters

world

World

actor

string

vehicle

string

seatId?

string

Returns

boolean

---

stepVehicle()

function stepVehicle(
   t, 
   state, 
   input, 
   spec, 
   dt, 
   env, 
   id?
): object;

Substepped bicycle chassis, grip-limited steering and four wheel terrain support. Grounded game physics; rigid-body crash deformation and rollovers are outside this solver.

Parameters

t

TransformData

state

VehicleStateData

input

VehicleInputData

spec

VehicleSpec

dt

number

env

VehicleEnvironment

id?

string

Returns

object

state

state: VehicleStateData;

transform

transform: TransformData;

---

unmountEntity()

function unmountEntity(
   world, 
   actor, 
   env
): boolean;

Parameters

world

World

actor

string

env

VehicleEnvironment

Returns

boolean

---

vehicleLocalPoint()

function vehicleLocalPoint(t, point): [number, number, number];

Parameters

t

TransformData

point

[number, number, number]

Returns

[number, number, number]

---

vehicleMounts()

function vehicleMounts(spec): MountableData;

Parameters

spec

VehicleSpec

Returns

MountableData

---

vehicleRotation()

function vehicleRotation(
   yaw, 
   pitch?, 
   roll?
): [number, number, number, number];

Parameters

yaw

number

pitch?

number

roll?

number

Returns

[number, number, number, number]