mudlet-map-renderer 2.3.1 → 2.5.0

package/dist/ScenePipeline.d.ts

@@ -5,6 +5,7 @@ import { Settings } from './types/Settings';
 import { default as ExitRenderer, ExitDrawData } from './ExitRenderer';
 import { GroupShape, Shape } from './scene/Shape';
 import { RoomLens } from './lens/RoomLens';
+import { NeighborSpill } from './scene/NeighborProjector';
 type Bounds = {
     x: number;
     y: number;
@@ -186,6 +187,7 @@ export declare class ScenePipeline {
     private specialExitShapeRefs;
     private stubShapeRefs;
     private areaExitLabelShapeRefs;
+    private spilledRoomIds;
     constructor(mapReader: IMapReader, settings: Settings);
     /**
      * Build the full scene for an area/plane.
@@ -195,7 +197,7 @@ export declare class ScenePipeline {
      * The `lens` filters which rooms paint and how partially-visible exits are
      * treated. Pass {@link ALL_VISIBLE} (or omit) for an unfiltered build.
      */
-    buildScene(area: IArea, plane: IPlane, zIndex: number, lens?: RoomLens): SceneBuildResult;
+    buildScene(area: IArea, plane: IPlane, zIndex: number, lens?: RoomLens, spill?: NeighborSpill): SceneBuildResult;
     getEffectiveBounds(area: IArea, plane: IPlane): {
         minX: number;
         maxX: number;
@@ -203,6 +205,13 @@ export declare class ScenePipeline {
         maxY: number;
     };
     private renderRooms;
+    /**
+     * Draw plain connector lines for the spill's regular/special exits (the room
+     * bodies, custom lines, stubs and inner exits are rendered through the normal
+     * room pass via {@link projectRoom} clones). Lines go on the link layer so
+     * they sit under the rooms, like ordinary exits.
+     */
+    private renderSpillConnectors;
     private renderLinkExits;
     /**
      * Build a stub anchored at the visible endpoint of an exit, pointing

package/dist/binary/BinaryMapReader.d.ts

@@ -23,8 +23,10 @@ export default class BinaryMapReader implements IMapReader {
     constructor(model: MudletMap);
     /**
      * Parse the given binary map buffer and construct a reader from it.
-     * In Node, pass `fs.readFileSync(path)`; in the browser, construct a
-     * `Buffer` from an `ArrayBuffer` (e.g. via the `buffer` polyfill).
+     * Accepts any `Uint8Array`: in Node pass `fs.readFileSync(path)`; in the
+     * browser pass `new Uint8Array(await file.arrayBuffer())`. The underlying
+     * `mudlet-map-binary-reader` (>=1.0.0) is browser-safe and needs no
+     * Node `Buffer` polyfill.
      */
     static fromBuffer(buf: Parameters<typeof readMapFromBuffer>[0]): BinaryMapReader;
     getArea(areaId: number): IArea;

package/dist/binary.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"binary.mjs","names":[],"sources":["../src/binary/BinaryMapReader.ts"],"sourcesContent":["import {\n    type MudletMap,\n    readerExport,\n    readMapFromBuffer,\n} from \"mudlet-map-binary-reader\";\nimport MapReader, {type IMapReader} from \"../reader/MapReader\";\nimport type {IArea} from \"../reader/Area\";\n\n/**\n * {@link IMapReader} implementation backed by a parsed Mudlet binary map.\n *\n * Convenience wrapper around the existing {@link MapReader} that converts a\n * {@link MudletMap} (the in-memory binary model from\n * `mudlet-map-binary-reader`) into the renderer's `{mapData, colors}` shape\n * via `readerExport()`, then forwards every `IMapReader` call to the wrapped\n * reader.\n *\n * Useful for downstream apps (the upstream Mudix client is one) that already\n * own binary `.dat` bytes and want a single object they can hand to\n * {@link MapRenderer} without staging a separate JSON export step.\n *\n * `mudlet-map-binary-reader` is a `peerDependency`; consumers who do not use\n * binary maps never pay the bundle cost.\n */\nexport default class BinaryMapReader implements IMapReader {\n    private readonly reader: MapReader;\n\n    /** Build directly from a parsed {@link MudletMap}. */\n    constructor(model: MudletMap) {\n        const {mapData, colors} = readerExport(model);\n        // RendererRoom (binary-reader output) and MapData.Room (renderer\n        // input) overlap structurally — RendererRoom is missing only\n        // `areaId`, which the renderer never reads from rooms (only from\n        // the area). Cast through `unknown` to bridge the nominal gap.\n        this.reader = new MapReader(mapData as unknown as MapData.Map, colors);\n    }\n\n    /**\n     * Parse the given binary map buffer and construct a reader from it.\n     * In Node, pass `fs.readFileSync(path)`; in the browser, construct a\n     * `Buffer` from an `ArrayBuffer` (e.g. via the `buffer` polyfill).\n     */\n    static fromBuffer(buf: Parameters<typeof readMapFromBuffer>[0]): BinaryMapReader {\n        return new BinaryMapReader(readMapFromBuffer(buf));\n    }\n\n    // --- IMapReader forwarding ---\n\n    getArea(areaId: number): IArea {\n        return this.reader.getArea(areaId);\n    }\n\n    getAreas(): IArea[] {\n        return this.reader.getAreas();\n    }\n\n    getRooms(): MapData.Room[] {\n        return this.reader.getRooms();\n    }\n\n    getRoom(roomId: number): MapData.Room {\n        return this.reader.getRoom(roomId);\n    }\n\n    getColorValue(envId: number): string {\n        return this.reader.getColorValue(envId);\n    }\n\n    getSymbolColor(envId: number, opacity?: number): string {\n        return this.reader.getSymbolColor(envId, opacity);\n    }\n}\n"],"mappings":";;;AAwBA,IAAqB,IAArB,MAAqB,EAAsC;CAIvD,YAAY,GAAkB;EAC1B,IAAM,EAAC,YAAS,cAAU,EAAa,EAAM;AAK7C,OAAK,SAAS,IAAI,EAAU,GAAmC,EAAO;;CAQ1E,OAAO,WAAW,GAA+D;AAC7E,SAAO,IAAI,EAAgB,EAAkB,EAAI,CAAC;;CAKtD,QAAQ,GAAuB;AAC3B,SAAO,KAAK,OAAO,QAAQ,EAAO;;CAGtC,WAAoB;AAChB,SAAO,KAAK,OAAO,UAAU;;CAGjC,WAA2B;AACvB,SAAO,KAAK,OAAO,UAAU;;CAGjC,QAAQ,GAA8B;AAClC,SAAO,KAAK,OAAO,QAAQ,EAAO;;CAGtC,cAAc,GAAuB;AACjC,SAAO,KAAK,OAAO,cAAc,EAAM;;CAG3C,eAAe,GAAe,GAA0B;AACpD,SAAO,KAAK,OAAO,eAAe,GAAO,EAAQ"}
+{"version":3,"file":"binary.mjs","names":[],"sources":["../src/binary/BinaryMapReader.ts"],"sourcesContent":["import {\n    type MudletMap,\n    readerExport,\n    readMapFromBuffer,\n} from \"mudlet-map-binary-reader\";\nimport MapReader, {type IMapReader} from \"../reader/MapReader\";\nimport type {IArea} from \"../reader/Area\";\n\n/**\n * {@link IMapReader} implementation backed by a parsed Mudlet binary map.\n *\n * Convenience wrapper around the existing {@link MapReader} that converts a\n * {@link MudletMap} (the in-memory binary model from\n * `mudlet-map-binary-reader`) into the renderer's `{mapData, colors}` shape\n * via `readerExport()`, then forwards every `IMapReader` call to the wrapped\n * reader.\n *\n * Useful for downstream apps (the upstream Mudix client is one) that already\n * own binary `.dat` bytes and want a single object they can hand to\n * {@link MapRenderer} without staging a separate JSON export step.\n *\n * `mudlet-map-binary-reader` is a `peerDependency`; consumers who do not use\n * binary maps never pay the bundle cost.\n */\nexport default class BinaryMapReader implements IMapReader {\n    private readonly reader: MapReader;\n\n    /** Build directly from a parsed {@link MudletMap}. */\n    constructor(model: MudletMap) {\n        const {mapData, colors} = readerExport(model);\n        // RendererRoom (binary-reader output) and MapData.Room (renderer\n        // input) overlap structurally — RendererRoom is missing only\n        // `areaId`, which the renderer never reads from rooms (only from\n        // the area). Cast through `unknown` to bridge the nominal gap.\n        this.reader = new MapReader(mapData as unknown as MapData.Map, colors);\n    }\n\n    /**\n     * Parse the given binary map buffer and construct a reader from it.\n     * Accepts any `Uint8Array`: in Node pass `fs.readFileSync(path)`; in the\n     * browser pass `new Uint8Array(await file.arrayBuffer())`. The underlying\n     * `mudlet-map-binary-reader` (>=1.0.0) is browser-safe and needs no\n     * Node `Buffer` polyfill.\n     */\n    static fromBuffer(buf: Parameters<typeof readMapFromBuffer>[0]): BinaryMapReader {\n        return new BinaryMapReader(readMapFromBuffer(buf));\n    }\n\n    // --- IMapReader forwarding ---\n\n    getArea(areaId: number): IArea {\n        return this.reader.getArea(areaId);\n    }\n\n    getAreas(): IArea[] {\n        return this.reader.getAreas();\n    }\n\n    getRooms(): MapData.Room[] {\n        return this.reader.getRooms();\n    }\n\n    getRoom(roomId: number): MapData.Room {\n        return this.reader.getRoom(roomId);\n    }\n\n    getColorValue(envId: number): string {\n        return this.reader.getColorValue(envId);\n    }\n\n    getSymbolColor(envId: number, opacity?: number): string {\n        return this.reader.getSymbolColor(envId, opacity);\n    }\n}\n"],"mappings":";;;AAwBA,IAAqB,IAArB,MAAqB,EAAsC;CAIvD,YAAY,GAAkB;EAC1B,IAAM,EAAC,YAAS,cAAU,EAAa,EAAM;AAK7C,OAAK,SAAS,IAAI,EAAU,GAAmC,EAAO;;CAU1E,OAAO,WAAW,GAA+D;AAC7E,SAAO,IAAI,EAAgB,EAAkB,EAAI,CAAC;;CAKtD,QAAQ,GAAuB;AAC3B,SAAO,KAAK,OAAO,QAAQ,EAAO;;CAGtC,WAAoB;AAChB,SAAO,KAAK,OAAO,UAAU;;CAGjC,WAA2B;AACvB,SAAO,KAAK,OAAO,UAAU;;CAGjC,QAAQ,GAA8B;AAClC,SAAO,KAAK,OAAO,QAAQ,EAAO;;CAGtC,cAAc,GAAuB;AACjC,SAAO,KAAK,OAAO,cAAc,EAAM;;CAG3C,eAAe,GAAe,GAA0B;AACpD,SAAO,KAAK,OAAO,eAAe,GAAO,EAAQ"}