@tileflow/core 0.1.0-alpha.40 → 0.1.0-alpha.41

package/dist/browser.d.ts

@@ -412,16 +412,7 @@ type TileflowBuildingSurfaceDesign = {
     cornice?: Required<NonNullable<TileflowBuildingSurfaces['cornice']>>;
 };
 
-/** The parts of a model, each coloured by the theme: the model's materials name them. */
-declare const tileflowModelParts: Readonly<{
-    surface: 0;
-    secondary: 1;
-    glass: 2;
-    accent: 3;
-    roof: 4;
-}>;
-type TileflowModelPart = keyof typeof tileflowModelParts;
-/** Architectural roles control lighting independently of the model's palette slots. */
+/** Architectural roles control lighting independently of the model's parts. */
 declare const tileflowModelLightingRoles: Readonly<{
     unclassified: 0;
     wall: 1;
@@ -466,7 +457,7 @@ type TileflowBuildingsThreeDimensionalStyle = {
         /** Wall radius as a fraction of building height; defaults to 1/3. */
         wallHeightRatio?: number;
     };
-    /** Per-role physical materials and emission, separate from palette slots and occlusion. */
+    /** Per-role physical materials and emission, separate from model parts and occlusion. */
     modelLighting?: Partial<Record<TileflowModelLightingRole, {
         emissiveStrength?: TileflowThemeNumberValue;
         /** Stable per-model addition to emission, from zero to this amount. */
@@ -521,7 +512,10 @@ type TileflowBuildingsThreeDimensionalStyle = {
      * directories. Each stands in for the buildings under its footprint.
      */
     models?: readonly TileflowBuildingModelPlacementConfig[];
-    /** The colours of the models' parts; a part without one takes it from the building colour. */
+    /**
+     * The colours of the models' parts, by the names their materials give them, such as `glass` or
+     * `water`. A part the map gives no colour keeps its material's own.
+     */
     modelColors?: Partial<Record<TileflowBuildingModelPart, TileflowThemeColorValue>>;
     /**
      * Tileflow's landmarks, such as the Eiffel Tower, drawn as models in place of the buildings
@@ -533,8 +527,11 @@ type TileflowBuildingsThreeDimensionalStyle = {
         url: string;
     };
 };
-/** The parts of a building model, as its materials name them. */
-type TileflowBuildingModelPart = 'surface' | 'secondary' | 'glass' | 'accent' | 'roof';
+/**
+ * A part of a building model, as its materials name it: lower-case words joined by hyphens or
+ * underscores, such as `surface`, `glass`, `roof` or `water`.
+ */
+type TileflowBuildingModelPart = string;
 /** Where a building model stands. */
 type TileflowBuildingModelPlacementConfig = {
     /** The model's id: the name of its `.glb` file in the map's `models` directories. */
@@ -1371,7 +1368,7 @@ type TileflowBuildings3DDesign = Readonly<{
     nightLight: number;
     /** Height-selected light on ordinary buildings and the ground, independent of shop windows. */
     floodLight?: TileflowBuildingFloodLight;
-    /** Emission by architectural role, independent of model palette slots. */
+    /** Emission by architectural role, independent of the models' parts. */
     modelLighting?: Readonly<Partial<Record<TileflowModelLightingRole, TileflowModelRoleLighting>>>;
     /** Invented night windows, lit by rooms: decoration, not data. */
     windows: boolean;
@@ -1393,8 +1390,8 @@ type TileflowBuildings3DDesign = Readonly<{
     modelOcclusion?: number;
     /** Building models the map places in its city, each replacing the buildings under it. */
     models?: readonly TileflowBuildingModelPlacement[];
-    /** The colours of the models' parts; a part without one takes it from the building colour. */
-    modelColors?: Readonly<Partial<Record<TileflowModelPart, string>>>;
+    /** The colours of the models' parts by name; a part without one keeps its material's colour. */
+    modelColors?: Readonly<Record<string, string>>;
     /**
      * Tileflow's landmarks, drawn as models in place of the buildings under them: the TileJSON of
      * their tileset. Without it, the map shows none.