@adatechnology/game-vehicles-three 0.6.4 → 0.7.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { E as EngineProfile, V as VehicleSoundKeys, B as BuiltVehicle } from './testing-C-BgV7gj.js';
-export { a as BIKE_ENGINE, b as BuildVehicleOptions, C as CAR_ENGINE, c as CRASH_SPEEDS, D as DEFAULT_TEST_VEHICLES, d as DEFAULT_TEST_WRECKS, e as DEFAULT_VEHICLE_SOUND_KEYS, f as DocumentLike, g as ENGINE_PROFILES, h as EffectsLike, i as EngineLayer, j as EngineLoadLayer, F as FleetDims, M as ModuleRoomLike, P as PAGE_ITEM_ALIASES, k as PAGE_SCENARIO_ALIASES, l as PROVING_AREA_ID, m as PROVING_TEXT, n as ProvingModuleOptions, o as ProvingRoomLike, p as ProvingText, T as TRUCK_ENGINE, q as VEHICLES_AREA_ID, r as VEHICLE_SCENARIO_IDS, s as VehicleEffectIds, t as VehicleFleetContent, u as VehicleQuality, v as VehicleSoundIds, w as VehicleWreck, x as VehiclesContext, y as VehiclesRoom, z as VehiclesTestFleet, A as VehiclesTestOptions, G as VehiclesThree, H as VehiclesThreeOptions, I as createProvingModule, J as createVehiclesTestModule, K as createVehiclesThree, L as defaultEffectIds, N as defaultSoundIds, O as loadProvingModule, Q as loadVehiclesTestModule } from './testing-C-BgV7gj.js';
-import { EffectSink, Vec3, AudioSink } from '@adatechnology/game-contracts';
+import { E as EngineProfile, V as VehicleSoundKeys, B as BuiltVehicle } from './testing-DI0_R8dH.js';
+export { a as BIKE_ENGINE, b as BuildVehicleOptions, C as CAR_ENGINE, c as CRASH_SPEEDS, D as DEFAULT_TEST_VEHICLES, d as DEFAULT_TEST_WRECKS, e as DEFAULT_VEHICLE_SOUND_KEYS, f as DocumentLike, g as ENGINE_PROFILES, h as EffectsLike, i as EngineLayer, j as EngineLoadLayer, F as FleetDims, M as ModuleRoomLike, P as PAGE_ITEM_ALIASES, k as PAGE_SCENARIO_ALIASES, l as PROVING_AREA_ID, m as PROVING_TEXT, n as ProvingModuleOptions, o as ProvingRoomLike, p as ProvingText, T as TRUCK_ENGINE, q as VEHICLES_AREA_ID, r as VEHICLE_SCENARIO_IDS, s as VehicleEffectIds, t as VehicleFleetContent, u as VehicleQuality, v as VehicleSoundIds, w as VehicleWreck, x as VehiclesContext, y as VehiclesRoom, z as VehiclesTestFleet, A as VehiclesTestOptions, G as VehiclesThree, H as VehiclesThreeOptions, I as createProvingModule, J as createVehiclesTestModule, K as createVehiclesThree, L as defaultEffectIds, N as defaultSoundIds, O as loadProvingModule, Q as loadVehiclesTestModule } from './testing-DI0_R8dH.js';
+import { EffectSink, Vec3, AudioSink, AnimationClipSpec } from '@adatechnology/game-contracts';
 import { CabinSource } from '@adatechnology/game-vehicles';
-import { LoopRecipe, Falloff, SoundRecipe, SoundBank } from '@adatechnology/game-audio';
+import { LoopRecipe, Falloff, SampleAlias, SoundRecipe, SoundBank } from '@adatechnology/game-audio';
 import { Object3D, CanvasTexture, CircleGeometry, MeshBasicMaterial, Mesh, Vector3 } from 'three';
 import '@adatechnology/game-vehicles-proving';
 
@@ -33,6 +33,34 @@ declare const VEHICLE_LOOP_FALLOFF: Falloff;
 declare const VEHICLE_LOOPS: readonly LoopRecipe[];
 /** The one-shots: the starter, the engine stopping, crashes by speed, and the doors, trunk and hood of a car. */
 declare const VEHICLE_SOUNDS: readonly SoundRecipe[];
+/**
+ * The RPM each car recording runs at, measured on the files (the crank turning at 16.7 and 42 Hz, the firing at four times that: a V8). A layer
+ * plays its file at `rpm / recorded rpm`.
+ */
+declare const CAR_RECORDED_RPM: {
+    readonly idle: 1000;
+    readonly high: 2520;
+};
+/** Where the start and the stop sit in the recording of a car starting, running and stopping (`engine_start_run_stop`), in seconds. */
+declare const CAR_START_RUN_STOP: {
+    /** The starter and the engine catching (at 0.58 s) and flaring; the loops take over at the crank time of the vehicle. */
+    readonly start: {
+        readonly offset: 0;
+        readonly duration: 1.3;
+    };
+    /** The ignition off: the engine running down to the end of the file. */
+    readonly stop: {
+        readonly offset: 9.96;
+        readonly duration: 0.64;
+    };
+};
+/**
+ * The vehicle ids answered by the recordings of the kit's manifest (files kept by the game, never in the SDK): the car engine layers by RPM, the
+ * start and the stop cut out of one recording, the door and the trunk. Each recipe above stays as the fallback while the files load or where the
+ * game has none. `car_door_open` is a file id of its own and needs no alias; the hood, the truck, the bike, the tyres, crashes and horns have no
+ * recording yet.
+ */
+declare const VEHICLE_SAMPLE_ALIASES: readonly SampleAlias[];
 declare const VEHICLE_SOUND_BANK: SoundBank;
 
 /** What one engine loop is set to this frame. `frequency` is absent for the load layer (noise has no pitch). */
@@ -259,6 +287,112 @@ declare function createVehicleLamps(THREE: {
     owner?: string;
 }): VehicleLamps;
 
+/**
+ * The openings of a built vehicle worked by hand: each door, the hood and the trunk lid swing on the hinges the vehicle destructible draws (their open
+ * pose is the one of its `open_*` clips, so the door takes its skin, glass and trim with it), each side window slides down into its door, a sunroof
+ * slides back when the model has one, the wiper blades sweep, and the central locking keeps the doors and the lid shut. It moves only what the kit
+ * drew and puts every part back on `dispose`.
+ */
+
+type Vec$1 = {
+    x: number;
+    y: number;
+    z: number;
+    copy(v: Vec$1): Vec$1;
+    clone(): Vec$1;
+    sub(v: Vec$1): Vec$1;
+    add(v: Vec$1): Vec$1;
+    applyQuaternion(q: Quat$1): Vec$1;
+};
+type Quat$1 = {
+    copy(q: Quat$1): Quat$1;
+    clone(): Quat$1;
+    setFromAxisAngle(axis: Vec$1, angle: number): Quat$1;
+    multiply(q: Quat$1): Quat$1;
+};
+/** What the body needs of three.js: vectors and quaternions to turn a wiper about its spindle. */
+type BodyThree = {
+    Vector3: new (x?: number, y?: number, z?: number) => Vec$1;
+    Quaternion: new () => Quat$1;
+};
+/** A side window by where it sits: `front_left`, `rear_right`... */
+type WindowId = `${'front' | 'rear'}_${'left' | 'right'}`;
+type BodyEvent = {
+    type: 'sound';
+    key: string;
+    part: string;
+} | {
+    type: 'refused';
+    part: string;
+    reason: 'locked' | 'missing';
+};
+interface VehicleBodyOptions {
+    THREE: BodyThree;
+    /** The open and close clips of the vehicle destructible (`animations()`): the open pose of each door, the hood and the lid. */
+    clips: readonly AnimationClipSpec[];
+    /** Seconds a door, the hood or the lid takes to open. Default 1.2 (the clips'). */
+    swingSeconds?: number;
+    /** Seconds a window takes from shut to open. Default 3.5. */
+    windowSeconds?: number;
+    /** Share of the pane's height that goes into the door. Default 0.92 (the top edge stays in the seal). */
+    windowTravel?: number;
+}
+interface VehicleBody {
+    /** Part ids the body can open: `door_front_left`..., `hood`, `lid`. */
+    readonly parts: readonly string[];
+    readonly windows: readonly WindowId[];
+    readonly hasSunroof: boolean;
+    readonly wipers: number;
+    readonly locked: boolean;
+    /** 0 shut to 1 open. */
+    openness(part: string): number;
+    /** Opens a shut part or shuts an open one. Locked doors and lid refuse. */
+    toggle(part: string): BodyEvent[];
+    /** Window opening, 0 shut to 1 down. */
+    window(id: WindowId): number;
+    toggleWindow(id: WindowId): void;
+    setWindow(id: WindowId, open: number): void;
+    toggleSunroof(): void;
+    /** Locks or unlocks the doors and the lid (the key or the remote). */
+    lock(locked: boolean): BodyEvent[];
+    /** Advances the moving parts; `wipe` is the wipers' sweeps per second (0 parked). */
+    update(dt: number, wipe?: number): BodyEvent[];
+    dispose(): void;
+}
+declare function createVehicleBody(built: BuiltVehicle, options: VehicleBodyOptions): VehicleBody;
+
+/**
+ * The wheels of a built vehicle turning as it moves: each wheel the kit drew (`context.wheels`) rolls about its axle by the distance travelled over
+ * its radius, and the front ones turn with the steering. The turn is applied over the wheel's own rest pose, so a mirrored or tilted wheel rolls the
+ * right way, and `dispose` puts every wheel back exactly as it was drawn.
+ */
+
+type Vec = {
+    x: number;
+    y: number;
+    z: number;
+};
+type Quat = {
+    copy(q: Quat): Quat;
+    clone(): Quat;
+    setFromAxisAngle(axis: Vec, angle: number): Quat;
+    multiply(q: Quat): Quat;
+    premultiply(q: Quat): Quat;
+};
+/** What the wheels need of three.js. */
+type WheelRollThree = {
+    Vector3: new (x?: number, y?: number, z?: number) => Vec;
+    Quaternion: new () => Quat;
+};
+interface WheelRoll {
+    /** Wheels found on the vehicle. */
+    readonly count: number;
+    /** The vehicle went `distance` metres forward (negative backwards) with the front wheels steered `steer` radians (positive to the left). */
+    roll(distance: number, steer: number): void;
+    dispose(): void;
+}
+declare function createWheelRoll(THREE: WheelRollThree, built: BuiltVehicle): WheelRoll;
+
 /** What the cluster shows this instant. */
 type DashboardReading = {
     kmh: number;
@@ -279,6 +413,15 @@ type DashboardReading = {
     temperature?: number;
     /** Fuel, 0 (empty) to 1 (full); leave out while the vehicle has no fuel model. */
     fuel?: number;
+    /** Cruise control holding a speed. */
+    cruise?: boolean;
+    /** Drive profile shown by its letter (E economy, S sport; nothing for normal). */
+    profile?: 'eco' | 'normal' | 'sport';
+    /** The aids switched off light their amber lamps. */
+    tractionOff?: boolean;
+    absOff?: boolean;
+    /** The alternator does not keep up (the battery drains with the engine running). */
+    charging?: boolean;
 };
 /** The scale of the dials and how often the faces are redrawn. */
 type DashboardOptions = {
@@ -331,4 +474,4 @@ declare const DASHBOARD_LOOK: {
 };
 declare function createVehicleDashboard(THREE: ThreeLib, built: BuiltVehicle, options: DashboardOptions): VehicleDashboard;
 
-export { BuiltVehicle, type CabinSmoke, DASHBOARD_LOOK, type DashboardOptions, type DashboardReading, type EngineLayerSetting, type EngineMixInput, EngineProfile, LAMP_RULES, LITE_CLASSES, type LampSwitch, type LiteClass, type LiteFusion, PRUNE_BELOW, VEHICLE_LOD_DISTANCE, VEHICLE_LOOPS, VEHICLE_LOOP_FALLOFF, VEHICLE_SOUNDS, VEHICLE_SOUND_BANK, type VehicleDashboard, type VehicleLamps, type VehicleLod, type VehicleSound, type VehicleSoundFrame, VehicleSoundKeys, type VehicleSoundOptions, type VehicleSoundReading, classColor, classify, createCabinSmoke, createGearGuess, createVehicleDashboard, createVehicleLamps, createVehicleLod, createVehicleSound, engineMix, firingHz, fuse, layerWeight, liteMaterials, liteMeshes, rpmShare };
+export { type BodyEvent, type BodyThree, BuiltVehicle, CAR_RECORDED_RPM, CAR_START_RUN_STOP, type CabinSmoke, DASHBOARD_LOOK, type DashboardOptions, type DashboardReading, type EngineLayerSetting, type EngineMixInput, EngineProfile, LAMP_RULES, LITE_CLASSES, type LampSwitch, type LiteClass, type LiteFusion, PRUNE_BELOW, VEHICLE_LOD_DISTANCE, VEHICLE_LOOPS, VEHICLE_LOOP_FALLOFF, VEHICLE_SAMPLE_ALIASES, VEHICLE_SOUNDS, VEHICLE_SOUND_BANK, type VehicleBody, type VehicleBodyOptions, type VehicleDashboard, type VehicleLamps, type VehicleLod, type VehicleSound, type VehicleSoundFrame, VehicleSoundKeys, type VehicleSoundOptions, type VehicleSoundReading, type WheelRoll, type WheelRollThree, type WindowId, classColor, classify, createCabinSmoke, createGearGuess, createVehicleBody, createVehicleDashboard, createVehicleLamps, createVehicleLod, createVehicleSound, createWheelRoll, engineMix, firingHz, fuse, layerWeight, liteMaterials, liteMeshes, rpmShare };