mudlet-map-renderer 2.3.0 → 2.3.1

package/dist/overlay/WaypointOverlay.d.ts

@@ -0,0 +1,70 @@
+import { MapState } from '../MapState';
+import { ViewportBounds } from '../types/Settings';
+import { Shape } from '../scene/Shape';
+import { Direction8 } from '../labelPlacement';
+import { SceneOverlay, SceneOverlayContext } from './SceneOverlay';
+export interface Waypoint {
+    roomId: number;
+    /** Label text. An array renders as stacked lines in one bubble. */
+    label: string | string[];
+    /** Marker / accent colour (hex). Default amber. */
+    color?: string;
+    /** Optional preferred label direction (nudge only). */
+    preferred?: Direction8;
+    /**
+     * Optional click handler. Fired when the waypoint's bubble is clicked.
+     * Wire pointer hits to it via {@link WaypointOverlay.hitTest} (see below).
+     * Waypoints without a handler are inert.
+     */
+    onClick?: (waypoint: Waypoint) => void;
+}
+/**
+ * Persistent named markers anchored to rooms (shops, banks, quest givers …),
+ * with auto-placed labels that dodge neighbouring rooms, exits, and each other
+ * via {@link placeLabels}. A {@link SceneOverlay}, so it renders on the
+ * interactive canvas and in every export.
+ *
+ * A room may carry more than one waypoint (e.g. a transport stop served by two
+ * routes): the list is flat, so push several entries with the same `roomId` and
+ * each gets its own auto-placed bubble. Alternatively give one waypoint a
+ * multi-line `label` to list them in a single bubble.
+ *
+ * Waypoints can be clickable. Bubbles are overlay-layer shapes, so they are not
+ * part of the renderer's {@link HitTester}; the overlay instead records the
+ * rects it places and resolves them via {@link hitTest}. Wire pointer clicks to
+ * it by converting the cursor to world space:
+ *
+ * ```ts
+ * const waypoints = new WaypointOverlay();
+ * waypoints.add({ roomId: 42, label: 'Bank', onClick: wp => console.log(wp.roomId) });
+ * renderer.addSceneOverlay('waypoints', waypoints);
+ *
+ * container.addEventListener('click', e => {
+ *     const p = renderer.camera.clientToMapPoint(e.clientX, e.clientY, container.getBoundingClientRect());
+ *     if (!p) return;
+ *     const wp = waypoints.hitTest(p.x, p.y);
+ *     wp?.onClick?.(wp);
+ * });
+ * ```
+ */
+export declare class WaypointOverlay implements SceneOverlay {
+    private waypoints;
+    private ctx?;
+    /** Bubble rects from the last render, for click hit-testing (world space). */
+    private placed;
+    set(list: Waypoint[]): void;
+    add(waypoint: Waypoint): void;
+    /** Remove every waypoint anchored to this room. */
+    remove(roomId: number): void;
+    has(roomId: number): boolean;
+    /**
+     * Topmost waypoint whose bubble contains the given **world-space** point, or
+     * `undefined`. Hit-tests the bubbles placed by the last {@link render} (in
+     * reverse, so later-drawn bubbles win). Convert a pointer position to world
+     * space with `renderer.camera.clientToMapPoint(...)` before calling.
+     */
+    hitTest(worldX: number, worldY: number): Waypoint | undefined;
+    attach(ctx: SceneOverlayContext): void;
+    detach(): void;
+    render(state: MapState, _bounds: ViewportBounds): Shape[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mudlet-map-renderer",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "license": "MIT",
   "repository": {
     "url": "https://github.com/Delwing/mudlet-map-renderer"