@bendyline/molen-kernel/aircraft

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

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

Interfaces

AircraftEnvironment

Properties

weather?

optional weather?: WeatherData;

Optional shared atmospheric conditions. Otherwise retain the stock altitude-density model.

wind?

optional wind?: [number, number, number];

Methods

canOccupy()?

optional canOccupy(
   transform, 
   spec, 
   entity
): boolean;

Called at <= 1/120s and <= 1m intervals; positions and rotations are absolute.

Parameters

transform

TransformData

spec

AircraftSpec

entity

string

Returns

boolean

groundHeight()

groundHeight(x, z): number | undefined;

Parameters

x

number

z

number

Returns

number | undefined

Variables

Aircraft

const Aircraft: ComponentType<AircraftData>;

---

AircraftInput

const AircraftInput: ComponentType<AircraftInputData>;

---

AircraftState

const AircraftState: ComponentType<AircraftStateData>;

---

IDLE_AIRCRAFT_INPUT

const IDLE_AIRCRAFT_INPUT: AircraftInputData;

Functions

aircraftEngines()

function aircraftEngines(spec): readonly AircraftNamedEngineSpec[];

Resolve the single-engine form as "main", or return an airplane's named engine bank.

Parameters

spec

AircraftSpec

Returns

readonly AircraftNamedEngineSpec[]

---

aircraftMounts()

function aircraftMounts(spec): MountableData;

Parameters

spec

AircraftSpec

Returns

MountableData

---

flyAircraft()

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

Parameters

world

World

actor

string

input

AircraftInputData

Returns

boolean

---

initialAircraftState()

function initialAircraftState(yaw?): AircraftStateData;

Parameters

yaw?

number

Returns

AircraftStateData

---

installAircraft()

function installAircraft(world, environment?): void;

Parameters

world

World

environment?

AircraftEnvironment

Returns

void

---

setAircraftEngineFailed()

function setAircraftEngineFailed(
   world, 
   aircraft, 
   engine, 
   failed?
): boolean;

Latch or explicitly repair an engine failure. Pilot input cannot clear a failure.

Parameters

world

World

aircraft

string

engine

string

failed?

boolean

Returns

boolean

---

stepAircraft()

function stepAircraft(
   transform, 
   state, 
   input, 
   spec, 
   dt, 
   env, 
   id?
): object;

Force-based, assisted flight, substepped independently of rendering. No second physics body.

Parameters

transform

TransformData

state

AircraftStateData

input

AircraftInputData

spec

AircraftSpec

dt

number

env

AircraftEnvironment

id?

string

Returns

object

state

state: AircraftStateData;

transform

transform: TransformData;