@adatechnology/game-weather-three 0.2.2 → 0.3.0

package/README.md

@@ -33,8 +33,9 @@ picture.update(dt)
 ## Bench
 
 `createWeatherTestModule({ visual: createWeatherVisual({ vfx: room.vfx }) })` (the module of `game-weather`) adds the picture to the weather bench: seven layers
-(rain curtain, near rain and splashes, mist and ash, sky, lightning, headlights, heat haze; names in pt-BR and en), and a lamp rig (two lamps on a block, the
-Workshop's `hlMat` lenses) in front of the camera to show the headlights. `layers: { sky: false }` keeps a room's own sky; the bench's own `fog` layer reaches the
+(rain curtain, near rain and splashes, mist and ash, sky, lightning, headlights, heat haze; names in pt-BR and en), and a lamp rig in front of the camera to show the headlights. The rig's car is not drawn here: pass
+`vehicles: (THREE) => createVehiclesThree(THREE, { kit })` (game-vehicles-three, with the fleet installed) and it builds a fleet car (`rigVehicle`, default
+`midsize_sedan`) under the lamps, so it follows the vehicles SDK; without it the rig has only the lamps and their beams. `layers: { sky: false }` keeps a room's own sky; the bench's own `fog` layer reaches the
 renderer too. The fog layer gives back the fog the host had when it is switched off.
 
 ## Proof

package/dist/index.d.ts

@@ -313,9 +313,26 @@ type WeatherVisualOptions = Pick<WeatherRendererOptions, 'profile' | 'random' |
     readonly vfx?: VfxWorld;
     /** Where the lamp rig stands (the two headlights of the Workshop's car, to see the beams); `false` leaves it out. Default 2.5 m ahead of the test room camera, lamps toward it. */
     readonly rig?: readonly [x: number, z: number, turn: number] | false;
+    /**
+     * The car the lamps are mounted on, built by the vehicles SDK for the host's three.js (`createVehiclesThree` of game-vehicles-three with the fleet installed), so the rig follows the fleet when it
+     * changes. Without it the rig has only the lamps and their beams: no car drawn here.
+     */
+    readonly vehicles?: (THREE: ThreeLib) => RigVehicles;
+    /** Fleet id of the rig's car (default `midsize_sedan`). */
+    readonly rigVehicle?: string;
     /** Which layers start on (all do by default); the room that is not about weather starts the sky and the fog off to keep its own look. */
     readonly layers?: Partial<Record<WeatherLayerId, boolean>>;
 };
+/** What the rig needs of the vehicles SDK (`VehiclesThree` of game-vehicles-three): a car in the game frame (front on +z, wheels on y = 0) and its length. */
+interface RigVehicles {
+    build(key: string, options?: {
+        quality?: 'high' | 'lite';
+    }): {
+        readonly group: THREE_NS.Object3D;
+        readonly length: number;
+        dispose(): void;
+    };
+}
 /**
  * The picture of the weather for the weather bench: `createWeatherTestModule({ visual: createWeatherVisual({ vfx: room.vfx }) })`. It draws the weather the bench shows with
  * `createWeatherRenderer` on the room's scene and camera, switches each part with the bench layers and puts a lamp rig in front of the camera for the headlights.
@@ -328,4 +345,4 @@ type WeatherVisualText = {
 };
 declare const weatherVisualTextOf: (locale: string) => WeatherVisualText;
 
-export { ASH, FOG_EXP_FROM, FOG_NEAR, FOG_ZONE_NEAR, type Fog, type FogValues, HEADLIGHTS, HEAT_HAZE, HEAT_HAZE_FRAGMENT, HEAT_HAZE_VERTEX, type HeadlightRules, type Headlights, type HeatHaze, LIGHTNING, type Lightning, MIST, type NearRain, type NearRainOptions, RAIN_CURTAIN, RAIN_CURTAIN_FRAGMENT, RAIN_CURTAIN_FULL_AT, RAIN_CURTAIN_PROFILES, RAIN_CURTAIN_VERTEX, type RainCurtain, type RainCurtainOptions, SKY_DAY, SKY_NIGHT, SPLASH_FROM_MM, type Sky, type ThreeLib, type Vec3, WEATHER_LAYERS, type WeatherLayerId, type WeatherProfileName, type WeatherRenderer, type WeatherRendererOptions, type WeatherSource, type WeatherVisualOptions, type WeatherVisualText, ZONE_FOG_DEFAULTS, ZONE_LIGHT, type ZoneFog, createFog, createHeadlights, createHeatHaze, createLightning, createNearRain, createRainCurtain, createSky, createWeatherRenderer, createWeatherVisual, defaultHeadlightRule, densityForFar, emitAirborne, fogOf, rainCurtainPositions, weatherVisualTextOf };
+export { ASH, FOG_EXP_FROM, FOG_NEAR, FOG_ZONE_NEAR, type Fog, type FogValues, HEADLIGHTS, HEAT_HAZE, HEAT_HAZE_FRAGMENT, HEAT_HAZE_VERTEX, type HeadlightRules, type Headlights, type HeatHaze, LIGHTNING, type Lightning, MIST, type NearRain, type NearRainOptions, RAIN_CURTAIN, RAIN_CURTAIN_FRAGMENT, RAIN_CURTAIN_FULL_AT, RAIN_CURTAIN_PROFILES, RAIN_CURTAIN_VERTEX, type RainCurtain, type RainCurtainOptions, type RigVehicles, SKY_DAY, SKY_NIGHT, SPLASH_FROM_MM, type Sky, type ThreeLib, type Vec3, WEATHER_LAYERS, type WeatherLayerId, type WeatherProfileName, type WeatherRenderer, type WeatherRendererOptions, type WeatherSource, type WeatherVisualOptions, type WeatherVisualText, ZONE_FOG_DEFAULTS, ZONE_LIGHT, type ZoneFog, createFog, createHeadlights, createHeatHaze, createLightning, createNearRain, createRainCurtain, createSky, createWeatherRenderer, createWeatherVisual, defaultHeadlightRule, densityForFar, emitAirborne, fogOf, rainCurtainPositions, weatherVisualTextOf };

package/dist/index.global.js

@@ -2356,29 +2356,21 @@ var GameWeatherThree = (() => {
   var weatherVisualTextOf = (locale) => TEXTS[locale] ?? TEXTS[locale.split("-")[0] ?? "en"] ?? TEXTS.en;
 
   // src/bench/visual.ts
+  var RIG_VEHICLE = "midsize_sedan";
   var LAYER_ORDER = ["far_rain", "near_rain", "mist", "sky", "lightning", "headlights", "haze"];
   var RIG_DEFAULT = [1.6, -2.5, 0];
-  function buildRig(THREE) {
+  function buildRig(THREE, vehicles, key) {
     const group = new THREE.Group();
     group.name = "weather-lamp-rig";
-    const body = new THREE.Mesh(new THREE.BoxGeometry(1.8, 0.7, 4.2), new THREE.MeshBasicMaterial({ color: 1776928 }));
-    body.position.set(0, 0.5, 0);
-    const lens2 = new THREE.MeshBasicMaterial({ color: HEADLIGHTS.lens.off });
-    const lampGeometry = new THREE.BoxGeometry(0.35, 0.15, 0.05);
-    for (const side of [-1, 1]) {
-      const lamp = new THREE.Mesh(lampGeometry, lens2);
-      lamp.position.set(side * HEADLIGHTS.lamp[0], HEADLIGHTS.lamp[1], 2.11);
-      group.add(lamp);
+    const car = vehicles?.build(key, { quality: "lite" });
+    if (car) {
+      car.group.position.z = HEADLIGHTS.lamp[2] + 0.1 - car.length / 2;
+      group.add(car.group);
     }
-    group.add(body);
     return {
       group,
-      lens: lens2,
       dispose() {
-        body.geometry.dispose();
-        body.material.dispose();
-        lampGeometry.dispose();
-        lens2.dispose();
+        car?.dispose();
       }
     };
   }
@@ -2403,19 +2395,19 @@ var GameWeatherThree = (() => {
           ...options.headlights ? { headlights: options.headlights } : {},
           ...options.layers ? { layers: options.layers } : {}
         });
-        return attachRig(THREE, host, renderer, options.rig === void 0 ? RIG_DEFAULT : options.rig);
+        return attachRig(THREE, host, renderer, options.rig === void 0 ? RIG_DEFAULT : options.rig, options.vehicles?.(THREE), options.rigVehicle ?? RIG_VEHICLE);
       }
     };
   }
-  function attachRig(THREE, host, renderer, place) {
+  function attachRig(THREE, host, renderer, place, vehicles, key) {
     const scene = host.scene;
-    const rig = place === false ? void 0 : buildRig(THREE);
+    const rig = place === false ? void 0 : buildRig(THREE, vehicles, key);
     let detach;
     if (rig && place) {
       rig.group.position.set(place[0], 0, place[1]);
       rig.group.rotation.y = place[2];
       scene.add(rig.group);
-      detach = renderer.headlights.attach(rig.group, rig.lens);
+      detach = renderer.headlights.attach(rig.group);
     }
     return {
       update: (dt) => renderer.update(dt),