@rpgjs/map-builder 0.0.0-stage → 5.0.0

package/dist/renderer/scene.js

@@ -0,0 +1,125 @@
+import { resolveElementGeometry, unionBounds } from "./geometry.js";
+//#region src/renderer/scene.ts
+/** Draw order, back to front. Only `objects` is filled by the built-in features. */
+var STAGE_ORDER = [
+	"ground",
+	"objects",
+	"overlay",
+	"lighting",
+	"post"
+];
+var toParts = (nodeKey, spec, origin, src) => spec.map((part, index) => ({
+	key: part.key ?? `${nodeKey}#${index}`,
+	x: origin.x + part.x,
+	y: origin.y + part.y,
+	width: part.width,
+	height: part.height,
+	src: part.src ?? src,
+	...part.frame ? { frame: part.frame } : {}
+}));
+/**
+* What to draw for an element, or `undefined` when nothing can be drawn yet: the
+* asset is unknown, or its size is not known until its image has loaded.
+*/
+function describeElement(element, context) {
+	const descriptor = context.assets.resolve(element.kind);
+	const spec = context.hooks?.resolveElementSprite?.(element, { descriptor });
+	if (!descriptor && !spec) {
+		context.hooks?.onMissingAsset?.(element.kind, {
+			type: "element",
+			id: element.id
+		});
+		return;
+	}
+	const src = spec?.src ?? descriptor?.src;
+	if (!src) return void 0;
+	const frame = spec?.frame ?? descriptor?.frame;
+	const size = spec?.size ?? descriptor?.size;
+	const hitbox = spec?.hitbox ?? descriptor?.hitbox;
+	const geometry = resolveElementGeometry({
+		x: element.x,
+		y: element.y,
+		...element.scale !== void 0 ? { scale: element.scale } : {},
+		...element.depth ? { depth: element.depth } : {},
+		...frame ? { frame } : {},
+		...size ? { size } : {},
+		...hitbox ? { hitbox } : {},
+		...(() => {
+			const measured = frame || size ? void 0 : context.measure?.(src);
+			return measured ? { sourceSize: measured } : {};
+		})()
+	});
+	if (!geometry) return void 0;
+	const key = `elements/${element.id}`;
+	const parts = spec?.parts ? toParts(key, spec.parts, element, src) : [{
+		key: "default",
+		x: geometry.draw.x,
+		y: geometry.draw.y,
+		width: geometry.draw.width,
+		height: geometry.draw.height,
+		src,
+		...frame ? { frame } : {}
+	}];
+	const node = {
+		key,
+		id: element.id,
+		type: "element",
+		kind: element.kind,
+		stage: "objects",
+		sortKey: geometry.sortKey,
+		bounds: unionBounds(parts),
+		parts,
+		...geometry.hitbox ? { hitbox: {
+			x: geometry.draw.x + geometry.hitbox.x * geometry.hitbox.scaleX,
+			y: geometry.draw.y + geometry.hitbox.y * geometry.hitbox.scaleY,
+			width: geometry.hitbox.width * geometry.hitbox.scaleX,
+			height: geometry.hitbox.height * geometry.hitbox.scaleY
+		} } : {}
+	};
+	return context.hooks?.onBeforeRenderElement?.(node, element) ?? node;
+}
+/** What to draw for an event: its graphic, when it has one that is a known asset. */
+function describeEvent(event, context) {
+	if (event.graphic === void 0) return void 0;
+	const descriptor = context.assets.resolve(event.graphic);
+	if (!descriptor) {
+		context.hooks?.onMissingAsset?.(event.graphic, {
+			type: "event",
+			id: event.id
+		});
+		return;
+	}
+	const measured = descriptor.frame || descriptor.size ? void 0 : context.measure?.(descriptor.src);
+	const geometry = resolveElementGeometry({
+		x: event.x,
+		y: event.y,
+		...descriptor.frame ? { frame: descriptor.frame } : {},
+		...descriptor.size ? { size: descriptor.size } : {},
+		...descriptor.hitbox ? { hitbox: descriptor.hitbox } : {},
+		...measured ? { sourceSize: measured } : {}
+	});
+	if (!geometry) return void 0;
+	const part = {
+		key: "default",
+		x: geometry.draw.x,
+		y: geometry.draw.y,
+		width: geometry.draw.width,
+		height: geometry.draw.height,
+		src: descriptor.src,
+		...descriptor.frame ? { frame: descriptor.frame } : {}
+	};
+	return {
+		key: `events/${event.id}`,
+		id: event.id,
+		type: "event",
+		kind: event.kind,
+		stage: "objects",
+		sortKey: geometry.sortKey,
+		bounds: unionBounds([part]),
+		parts: [part]
+	};
+}
+//#endregion
+export { STAGE_ORDER, describeElement, describeEvent };
+
+//# sourceMappingURL=scene.js.map

package/dist/renderer/scene.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene.js","names":[],"sources":["../../src/renderer/scene.ts"],"sourcesContent":["import type { AssetDescriptor, AssetResolver } from \"../model/assets\";\nimport type { MapElement, MapEvent } from \"../model/definition\";\nimport { resolveElementGeometry, unionBounds, type Frame, type Rect } from \"./geometry\";\n\nexport type StageName = \"ground\" | \"objects\" | \"overlay\" | \"lighting\" | \"post\";\n\n/** Draw order, back to front. Only `objects` is filled by the built-in features. */\nexport const STAGE_ORDER: readonly StageName[] = [\"ground\", \"objects\", \"overlay\", \"lighting\", \"post\"];\n\n/** One image drawn at a world position. */\nexport interface ScenePart {\n  readonly key: string;\n  readonly x: number;\n  readonly y: number;\n  readonly width: number;\n  readonly height: number;\n  readonly src: string;\n  readonly frame?: Frame;\n}\n\n/** What to draw for one element or event. Plain data: it can be compared, logged and snapshotted. */\nexport interface SceneNode {\n  /** Unique in the scene: `<feature>/<id>`. */\n  readonly key: string;\n  readonly id: string;\n  readonly type: \"element\" | \"event\";\n  readonly kind: string;\n  readonly stage: StageName;\n  /** Nodes with a higher key are drawn in front. */\n  readonly sortKey: number;\n  readonly bounds: Rect;\n  readonly parts: readonly ScenePart[];\n  /** Collision box in world coordinates. */\n  readonly hitbox?: Rect;\n}\n\n/** A part given by a hook, relative to the element origin. */\nexport interface SpritePartSpec {\n  readonly key?: string;\n  readonly x: number;\n  readonly y: number;\n  readonly width: number;\n  readonly height: number;\n  readonly src?: string;\n  readonly frame?: Frame;\n}\n\n/** What a hook can change about how an element is drawn. */\nexport interface ElementSpriteSpec {\n  /** Replaces the single image by these parts (a repeated body, a nine-slice…). */\n  readonly parts?: readonly SpritePartSpec[];\n  readonly src?: string;\n  readonly frame?: Frame;\n  readonly size?: readonly [number, number];\n  readonly hitbox?: Frame;\n}\n\nexport interface MapViewHooks {\n  /** Changes how an element is drawn. Studio uses it for drawing rules and element sizes. */\n  resolveElementSprite?(element: MapElement, context: { readonly descriptor: AssetDescriptor | undefined }): ElementSpriteSpec | undefined;\n  /** Last chance to adjust a node, e.g. its sort key or its parts. */\n  onBeforeRenderElement?(node: SceneNode, element: MapElement): SceneNode | void;\n  /** An element or an event refers to an asset nobody knows. */\n  onMissingAsset?(kind: string, owner: { readonly type: \"element\" | \"event\"; readonly id: string }): void;\n}\n\nexport interface DescribeContext {\n  readonly assets: AssetResolver;\n  readonly hooks?: MapViewHooks;\n  /** Size of a loaded image, for assets that do not declare one. */\n  readonly measure?: (src: string) => readonly [number, number] | undefined;\n}\n\nconst toParts = (nodeKey: string, spec: readonly SpritePartSpec[], origin: { x: number; y: number }, src: string): ScenePart[] =>\n  spec.map((part, index) => ({\n    key: part.key ?? `${nodeKey}#${index}`,\n    x: origin.x + part.x,\n    y: origin.y + part.y,\n    width: part.width,\n    height: part.height,\n    src: part.src ?? src,\n    ...(part.frame ? { frame: part.frame } : {}),\n  }));\n\n/**\n * What to draw for an element, or `undefined` when nothing can be drawn yet: the\n * asset is unknown, or its size is not known until its image has loaded.\n */\nexport function describeElement(element: MapElement, context: DescribeContext): SceneNode | undefined {\n  const descriptor = context.assets.resolve(element.kind);\n  const spec = context.hooks?.resolveElementSprite?.(element, { descriptor });\n  if (!descriptor && !spec) {\n    context.hooks?.onMissingAsset?.(element.kind, { type: \"element\", id: element.id });\n    return undefined;\n  }\n\n  const src = spec?.src ?? descriptor?.src;\n  if (!src) return undefined;\n  const frame = spec?.frame ?? descriptor?.frame;\n  const size = spec?.size ?? descriptor?.size;\n  const hitbox = spec?.hitbox ?? descriptor?.hitbox;\n\n  const geometry = resolveElementGeometry({\n    x: element.x,\n    y: element.y,\n    ...(element.scale !== undefined ? { scale: element.scale } : {}),\n    ...(element.depth ? { depth: element.depth } : {}),\n    ...(frame ? { frame } : {}),\n    ...(size ? { size } : {}),\n    ...(hitbox ? { hitbox } : {}),\n    ...(() => {\n      // Only an image that declares neither a frame nor a size has to be measured.\n      const measured = frame || size ? undefined : context.measure?.(src);\n      return measured ? { sourceSize: measured } : {};\n    })(),\n  });\n  if (!geometry) return undefined;\n\n  const key = `elements/${element.id}`;\n  const parts: ScenePart[] = spec?.parts\n    ? toParts(key, spec.parts, element, src)\n    : [\n        {\n          key: \"default\",\n          x: geometry.draw.x,\n          y: geometry.draw.y,\n          width: geometry.draw.width,\n          height: geometry.draw.height,\n          src,\n          ...(frame ? { frame } : {}),\n        },\n      ];\n\n  const node: SceneNode = {\n    key,\n    id: element.id,\n    type: \"element\",\n    kind: element.kind,\n    stage: \"objects\",\n    sortKey: geometry.sortKey,\n    bounds: unionBounds(parts),\n    parts,\n    ...(geometry.hitbox\n      ? {\n          hitbox: {\n            x: geometry.draw.x + geometry.hitbox.x * geometry.hitbox.scaleX,\n            y: geometry.draw.y + geometry.hitbox.y * geometry.hitbox.scaleY,\n            width: geometry.hitbox.width * geometry.hitbox.scaleX,\n            height: geometry.hitbox.height * geometry.hitbox.scaleY,\n          },\n        }\n      : {}),\n  };\n  return context.hooks?.onBeforeRenderElement?.(node, element) ?? node;\n}\n\n/** What to draw for an event: its graphic, when it has one that is a known asset. */\nexport function describeEvent(event: MapEvent, context: DescribeContext): SceneNode | undefined {\n  if (event.graphic === undefined) return undefined;\n  const descriptor = context.assets.resolve(event.graphic);\n  if (!descriptor) {\n    context.hooks?.onMissingAsset?.(event.graphic, { type: \"event\", id: event.id });\n    return undefined;\n  }\n  const measured = descriptor.frame || descriptor.size ? undefined : context.measure?.(descriptor.src);\n  const geometry = resolveElementGeometry({\n    x: event.x,\n    y: event.y,\n    ...(descriptor.frame ? { frame: descriptor.frame } : {}),\n    ...(descriptor.size ? { size: descriptor.size } : {}),\n    ...(descriptor.hitbox ? { hitbox: descriptor.hitbox } : {}),\n    ...(measured ? { sourceSize: measured } : {}),\n  });\n  if (!geometry) return undefined;\n\n  const part: ScenePart = {\n    key: \"default\",\n    x: geometry.draw.x,\n    y: geometry.draw.y,\n    width: geometry.draw.width,\n    height: geometry.draw.height,\n    src: descriptor.src,\n    ...(descriptor.frame ? { frame: descriptor.frame } : {}),\n  };\n  return {\n    key: `events/${event.id}`,\n    id: event.id,\n    type: \"event\",\n    kind: event.kind,\n    stage: \"objects\",\n    sortKey: geometry.sortKey,\n    bounds: unionBounds([part]),\n    parts: [part],\n  };\n}\n"],"mappings":";;;AAOA,IAAa,cAAoC;CAAC;CAAU;CAAW;CAAW;CAAY;AAAM;AAkEpG,IAAM,WAAW,SAAiB,MAAiC,QAAkC,QACnG,KAAK,KAAK,MAAM,WAAW;CACzB,KAAK,KAAK,OAAO,GAAG,QAAQ,GAAG;CAC/B,GAAG,OAAO,IAAI,KAAK;CACnB,GAAG,OAAO,IAAI,KAAK;CACnB,OAAO,KAAK;CACZ,QAAQ,KAAK;CACb,KAAK,KAAK,OAAO;CACjB,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;AAC5C,EAAE;;;;;AAMJ,SAAgB,gBAAgB,SAAqB,SAAiD;CACpG,MAAM,aAAa,QAAQ,OAAO,QAAQ,QAAQ,IAAI;CACtD,MAAM,OAAO,QAAQ,OAAO,uBAAuB,SAAS,EAAE,WAAW,CAAC;CAC1E,IAAI,CAAC,cAAc,CAAC,MAAM;EACxB,QAAQ,OAAO,iBAAiB,QAAQ,MAAM;GAAE,MAAM;GAAW,IAAI,QAAQ;EAAG,CAAC;EACjF;CACF;CAEA,MAAM,MAAM,MAAM,OAAO,YAAY;CACrC,IAAI,CAAC,KAAK,OAAO,KAAA;CACjB,MAAM,QAAQ,MAAM,SAAS,YAAY;CACzC,MAAM,OAAO,MAAM,QAAQ,YAAY;CACvC,MAAM,SAAS,MAAM,UAAU,YAAY;CAE3C,MAAM,WAAW,uBAAuB;EACtC,GAAG,QAAQ;EACX,GAAG,QAAQ;EACX,GAAI,QAAQ,UAAU,KAAA,IAAY,EAAE,OAAO,QAAQ,MAAM,IAAI,CAAC;EAC9D,GAAI,QAAQ,QAAQ,EAAE,OAAO,QAAQ,MAAM,IAAI,CAAC;EAChD,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;EACzB,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;EACvB,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAC3B,UAAU;GAER,MAAM,WAAW,SAAS,OAAO,KAAA,IAAY,QAAQ,UAAU,GAAG;GAClE,OAAO,WAAW,EAAE,YAAY,SAAS,IAAI,CAAC;EAChD,EAAA,CAAG;CACL,CAAC;CACD,IAAI,CAAC,UAAU,OAAO,KAAA;CAEtB,MAAM,MAAM,YAAY,QAAQ;CAChC,MAAM,QAAqB,MAAM,QAC7B,QAAQ,KAAK,KAAK,OAAO,SAAS,GAAG,IACrC,CACE;EACE,KAAK;EACL,GAAG,SAAS,KAAK;EACjB,GAAG,SAAS,KAAK;EACjB,OAAO,SAAS,KAAK;EACrB,QAAQ,SAAS,KAAK;EACtB;EACA,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;CAC3B,CACF;CAEJ,MAAM,OAAkB;EACtB;EACA,IAAI,QAAQ;EACZ,MAAM;EACN,MAAM,QAAQ;EACd,OAAO;EACP,SAAS,SAAS;EAClB,QAAQ,YAAY,KAAK;EACzB;EACA,GAAI,SAAS,SACT,EACE,QAAQ;GACN,GAAG,SAAS,KAAK,IAAI,SAAS,OAAO,IAAI,SAAS,OAAO;GACzD,GAAG,SAAS,KAAK,IAAI,SAAS,OAAO,IAAI,SAAS,OAAO;GACzD,OAAO,SAAS,OAAO,QAAQ,SAAS,OAAO;GAC/C,QAAQ,SAAS,OAAO,SAAS,SAAS,OAAO;EACnD,EACF,IACA,CAAC;CACP;CACA,OAAO,QAAQ,OAAO,wBAAwB,MAAM,OAAO,KAAK;AAClE;;AAGA,SAAgB,cAAc,OAAiB,SAAiD;CAC9F,IAAI,MAAM,YAAY,KAAA,GAAW,OAAO,KAAA;CACxC,MAAM,aAAa,QAAQ,OAAO,QAAQ,MAAM,OAAO;CACvD,IAAI,CAAC,YAAY;EACf,QAAQ,OAAO,iBAAiB,MAAM,SAAS;GAAE,MAAM;GAAS,IAAI,MAAM;EAAG,CAAC;EAC9E;CACF;CACA,MAAM,WAAW,WAAW,SAAS,WAAW,OAAO,KAAA,IAAY,QAAQ,UAAU,WAAW,GAAG;CACnG,MAAM,WAAW,uBAAuB;EACtC,GAAG,MAAM;EACT,GAAG,MAAM;EACT,GAAI,WAAW,QAAQ,EAAE,OAAO,WAAW,MAAM,IAAI,CAAC;EACtD,GAAI,WAAW,OAAO,EAAE,MAAM,WAAW,KAAK,IAAI,CAAC;EACnD,GAAI,WAAW,SAAS,EAAE,QAAQ,WAAW,OAAO,IAAI,CAAC;EACzD,GAAI,WAAW,EAAE,YAAY,SAAS,IAAI,CAAC;CAC7C,CAAC;CACD,IAAI,CAAC,UAAU,OAAO,KAAA;CAEtB,MAAM,OAAkB;EACtB,KAAK;EACL,GAAG,SAAS,KAAK;EACjB,GAAG,SAAS,KAAK;EACjB,OAAO,SAAS,KAAK;EACrB,QAAQ,SAAS,KAAK;EACtB,KAAK,WAAW;EAChB,GAAI,WAAW,QAAQ,EAAE,OAAO,WAAW,MAAM,IAAI,CAAC;CACxD;CACA,OAAO;EACL,KAAK,UAAU,MAAM;EACrB,IAAI,MAAM;EACV,MAAM;EACN,MAAM,MAAM;EACZ,OAAO;EACP,SAAS,SAAS;EAClB,QAAQ,YAAY,CAAC,IAAI,CAAC;EAC1B,OAAO,CAAC,IAAI;CACd;AACF"}

package/dist/renderer/textures.d.ts

@@ -0,0 +1,20 @@
+import { Texture } from 'pixi.js';
+import { Frame } from './geometry';
+/** Loads the image behind an asset. Replaceable, so tests and games can bring their own loading. */
+export interface TextureProvider {
+    load(src: string): Texture | Promise<Texture>;
+}
+/** The default provider: PixiJS `Assets`. */
+export declare const pixiTextureProvider: TextureProvider;
+export interface TextureStore {
+    /** The texture, or `undefined` while the image is loading (or if it failed). */
+    get(src: string, frame?: Frame): Texture | undefined;
+    /** Loads the image, then resolves the texture. Rejects if loading failed. */
+    ready(src: string, frame?: Frame): Promise<Texture>;
+    /** Size of a loaded image, before any frame is applied. */
+    size(src: string): readonly [number, number] | undefined;
+    destroy(): void;
+}
+/** Loads each image once and caches the textures cut out of it. */
+export declare function createTextureStore(provider: TextureProvider): TextureStore;
+//# sourceMappingURL=textures.d.ts.map

package/dist/renderer/textures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textures.d.ts","sourceRoot":"","sources":["../../src/renderer/textures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,OAAO,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,oGAAoG;AACpG,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/C;AAED,6CAA6C;AAC7C,eAAO,MAAM,mBAAmB,EAAE,eAA8D,CAAC;AAEjG,MAAM,WAAW,YAAY;IAC3B,gFAAgF;IAChF,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,CAAC;IACrD,6EAA6E;IAC7E,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD,2DAA2D;IAC3D,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IACzD,OAAO,IAAI,IAAI,CAAC;CACjB;AAID,mEAAmE;AACnE,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,eAAe,GAAG,YAAY,CAmD1E"}

package/dist/renderer/textures.js

@@ -0,0 +1,61 @@
+import { Assets, Rectangle, Texture } from "pixi.js";
+//#region src/renderer/textures.ts
+/** The default provider: PixiJS `Assets`. */
+var pixiTextureProvider = { load: (src) => Assets.load(src) };
+var frameKey = (src, frame) => frame ? `${src}#${frame.join(",")}` : src;
+/** Loads each image once and caches the textures cut out of it. */
+function createTextureStore(provider) {
+	const loading = /* @__PURE__ */ new Map();
+	const loaded = /* @__PURE__ */ new Map();
+	const frames = /* @__PURE__ */ new Map();
+	const base = (src) => {
+		let promise = loading.get(src);
+		if (!promise) {
+			promise = Promise.resolve(provider.load(src)).then((texture) => {
+				loaded.set(src, texture);
+				return texture;
+			});
+			loading.set(src, promise);
+			promise.catch(() => loading.delete(src));
+		}
+		return promise;
+	};
+	const cut = (src, texture, frame) => {
+		if (!frame) return texture;
+		const key = frameKey(src, frame);
+		let part = frames.get(key);
+		if (!part) {
+			part = new Texture({
+				source: texture.source,
+				frame: new Rectangle(frame[0], frame[1], frame[2], frame[3])
+			});
+			frames.set(key, part);
+		}
+		return part;
+	};
+	return {
+		get(src, frame) {
+			const texture = loaded.get(src);
+			if (!texture) {
+				base(src).catch(() => void 0);
+				return;
+			}
+			return cut(src, texture, frame);
+		},
+		ready: async (src, frame) => cut(src, await base(src), frame),
+		size(src) {
+			const texture = loaded.get(src);
+			return texture ? [texture.width, texture.height] : void 0;
+		},
+		destroy() {
+			for (const part of frames.values()) part.destroy(false);
+			frames.clear();
+			loaded.clear();
+			loading.clear();
+		}
+	};
+}
+//#endregion
+export { createTextureStore, pixiTextureProvider };
+
+//# sourceMappingURL=textures.js.map

package/dist/renderer/textures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"textures.js","names":[],"sources":["../../src/renderer/textures.ts"],"sourcesContent":["import { Assets, Rectangle, Texture } from \"pixi.js\";\nimport type { Frame } from \"./geometry\";\n\n/** Loads the image behind an asset. Replaceable, so tests and games can bring their own loading. */\nexport interface TextureProvider {\n  load(src: string): Texture | Promise<Texture>;\n}\n\n/** The default provider: PixiJS `Assets`. */\nexport const pixiTextureProvider: TextureProvider = { load: (src) => Assets.load<Texture>(src) };\n\nexport interface TextureStore {\n  /** The texture, or `undefined` while the image is loading (or if it failed). */\n  get(src: string, frame?: Frame): Texture | undefined;\n  /** Loads the image, then resolves the texture. Rejects if loading failed. */\n  ready(src: string, frame?: Frame): Promise<Texture>;\n  /** Size of a loaded image, before any frame is applied. */\n  size(src: string): readonly [number, number] | undefined;\n  destroy(): void;\n}\n\nconst frameKey = (src: string, frame?: Frame): string => (frame ? `${src}#${frame.join(\",\")}` : src);\n\n/** Loads each image once and caches the textures cut out of it. */\nexport function createTextureStore(provider: TextureProvider): TextureStore {\n  const loading = new Map<string, Promise<Texture>>();\n  const loaded = new Map<string, Texture>();\n  const frames = new Map<string, Texture>();\n\n  const base = (src: string): Promise<Texture> => {\n    let promise = loading.get(src);\n    if (!promise) {\n      promise = Promise.resolve(provider.load(src)).then((texture) => {\n        loaded.set(src, texture);\n        return texture;\n      });\n      loading.set(src, promise);\n      // A failed load can be retried on the next request.\n      promise.catch(() => loading.delete(src));\n    }\n    return promise;\n  };\n\n  const cut = (src: string, texture: Texture, frame?: Frame): Texture => {\n    if (!frame) return texture;\n    const key = frameKey(src, frame);\n    let part = frames.get(key);\n    if (!part) {\n      part = new Texture({ source: texture.source, frame: new Rectangle(frame[0], frame[1], frame[2], frame[3]) });\n      frames.set(key, part);\n    }\n    return part;\n  };\n\n  return {\n    get(src, frame) {\n      const texture = loaded.get(src);\n      if (!texture) {\n        void base(src).catch(() => undefined);\n        return undefined;\n      }\n      return cut(src, texture, frame);\n    },\n    ready: async (src, frame) => cut(src, await base(src), frame),\n    size(src) {\n      const texture = loaded.get(src);\n      return texture ? [texture.width, texture.height] : undefined;\n    },\n    destroy() {\n      for (const part of frames.values()) part.destroy(false);\n      frames.clear();\n      loaded.clear();\n      loading.clear();\n    },\n  };\n}\n"],"mappings":";;;AASA,IAAa,sBAAuC,EAAE,OAAO,QAAQ,OAAO,KAAc,GAAG,EAAE;AAY/F,IAAM,YAAY,KAAa,UAA2B,QAAQ,GAAG,IAAI,GAAG,MAAM,KAAK,GAAG,MAAM;;AAGhG,SAAgB,mBAAmB,UAAyC;CAC1E,MAAM,0BAAU,IAAI,IAA8B;CAClD,MAAM,yBAAS,IAAI,IAAqB;CACxC,MAAM,yBAAS,IAAI,IAAqB;CAExC,MAAM,QAAQ,QAAkC;EAC9C,IAAI,UAAU,QAAQ,IAAI,GAAG;EAC7B,IAAI,CAAC,SAAS;GACZ,UAAU,QAAQ,QAAQ,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,YAAY;IAC9D,OAAO,IAAI,KAAK,OAAO;IACvB,OAAO;GACT,CAAC;GACD,QAAQ,IAAI,KAAK,OAAO;GAExB,QAAQ,YAAY,QAAQ,OAAO,GAAG,CAAC;EACzC;EACA,OAAO;CACT;CAEA,MAAM,OAAO,KAAa,SAAkB,UAA2B;EACrE,IAAI,CAAC,OAAO,OAAO;EACnB,MAAM,MAAM,SAAS,KAAK,KAAK;EAC/B,IAAI,OAAO,OAAO,IAAI,GAAG;EACzB,IAAI,CAAC,MAAM;GACT,OAAO,IAAI,QAAQ;IAAE,QAAQ,QAAQ;IAAQ,OAAO,IAAI,UAAU,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE;GAAE,CAAC;GAC3G,OAAO,IAAI,KAAK,IAAI;EACtB;EACA,OAAO;CACT;CAEA,OAAO;EACL,IAAI,KAAK,OAAO;GACd,MAAM,UAAU,OAAO,IAAI,GAAG;GAC9B,IAAI,CAAC,SAAS;IACZ,KAAU,GAAG,CAAC,CAAC,YAAY,KAAA,CAAS;IACpC;GACF;GACA,OAAO,IAAI,KAAK,SAAS,KAAK;EAChC;EACA,OAAO,OAAO,KAAK,UAAU,IAAI,KAAK,MAAM,KAAK,GAAG,GAAG,KAAK;EAC5D,KAAK,KAAK;GACR,MAAM,UAAU,OAAO,IAAI,GAAG;GAC9B,OAAO,UAAU,CAAC,QAAQ,OAAO,QAAQ,MAAM,IAAI,KAAA;EACrD;EACA,UAAU;GACR,KAAK,MAAM,QAAQ,OAAO,OAAO,GAAG,KAAK,QAAQ,KAAK;GACtD,OAAO,MAAM;GACb,OAAO,MAAM;GACb,QAAQ,MAAM;EAChB;CACF;AACF"}

package/dist/renderer/view.d.ts

@@ -0,0 +1,139 @@
+import { Container } from 'pixi.js';
+import { AssetResolver } from '../model/assets';
+import { ApplyResult, MaybePromise } from '../model/result';
+import { KeyTarget } from '../interaction/keyboard';
+import { InteractionController, ModelApi } from '../interaction/controller';
+import { EffectDefinition, EffectHandle, EffectParams } from './effects';
+import { FeatureApis, MapFeature } from './feature';
+import { Rect } from './geometry';
+import { MapViewHooks, SceneNode, StageName } from './scene';
+import { TextureProvider } from './textures';
+export type MapViewErrorCode = "asset-load-failed";
+export interface MapViewError {
+    readonly code: MapViewErrorCode;
+    readonly message: string;
+    readonly src: string;
+    readonly cause: unknown;
+}
+/** The part of a PixiJS `Application` the view uses to mount itself. */
+export interface PixiApplicationLike {
+    init(options: Record<string, unknown>): Promise<void>;
+    readonly canvas: unknown;
+    readonly stage: Container;
+    readonly ticker: {
+        add(callback: (ticker: {
+            deltaMS: number;
+        }) => void): unknown;
+        remove(callback: (ticker: {
+            deltaMS: number;
+        }) => void): unknown;
+    };
+    destroy(removeView?: boolean, options?: unknown): void;
+}
+export interface MountOptions {
+    /**
+     * Listen to the keyboard (Escape, Delete…) and give it to the interaction layer.
+     * `true` listens on the page, or give an event target. Off by default.
+     */
+    readonly keyboard?: boolean | KeyTarget;
+    /** CSS-style colour of the canvas background. Transparent by default. */
+    readonly background?: string | number;
+    /** Anti-aliasing is off by default: it blurs pixel art. */
+    readonly antialias?: boolean;
+    /** Replaces `new Application()`. */
+    readonly createApplication?: () => PixiApplicationLike;
+}
+export interface MapViewOptions<F extends readonly MapFeature<string, object>[] = readonly MapFeature<string, object>[], R extends MaybePromise<ApplyResult> = MaybePromise<ApplyResult>> {
+    /** Any `MapModel` fits, whatever its committer. */
+    readonly model: ModelApi<R>;
+    readonly assets: AssetResolver;
+    /** What the view draws and how. Nothing is drawn without features. */
+    readonly features: F;
+    /** Who is acting, handed to the steps of the pipelines. Whatever the game decides. */
+    readonly actor?: () => unknown;
+    /** Modes active at the start. Tools belong to modes (`play`, `edit`, `inspect`). Defaults to `["edit"]`. */
+    readonly modes?: readonly string[];
+    /**
+     * Turn pointer events on the map into interaction. Defaults to true as soon as a
+     * feature has something to interact with, false otherwise: a view that only
+     * draws never gets in the way of the clicks of a game.
+     */
+    readonly interactive?: boolean;
+    /** How images are loaded. Defaults to PixiJS `Assets`. */
+    readonly textures?: TextureProvider;
+    readonly hooks?: MapViewHooks;
+    /** Extra effects, by name, next to the built-in `shake` and `blink`. */
+    readonly effects?: Readonly<Record<string, EffectDefinition>>;
+    /**
+     * Draw the sprites of the elements and events. Defaults to true. With `false` the view only keeps them as
+     * what can be picked and selected (their bounds and hitboxes), so that a game that draws the map itself can
+     * use the tools and the selection of the map builder without drawing everything twice. Nothing is loaded.
+     */
+    readonly draw?: boolean;
+    /** Margin, in pixels, added around the viewport before something is hidden. Defaults to 64. */
+    readonly cullingMargin?: number;
+    /** Receives non-fatal problems. Defaults to `console.warn`, once per image. */
+    readonly onError?: (error: MapViewError) => void;
+}
+/** An element or event, as an effect target. A plain string is an element id. */
+export type EffectTarget = string | {
+    readonly type: "element" | "event";
+    readonly id: string;
+};
+export interface MapViewEffects {
+    /**
+     * Plays a short visual effect. It does not touch the model, so it is neither
+     * persisted nor undoable. It never throws: see the status of `handle.finished`.
+     */
+    play(target: EffectTarget, name: string, params?: EffectParams): EffectHandle;
+    register(name: string, definition: EffectDefinition): void;
+    clear(target?: EffectTarget): void;
+    readonly running: number;
+}
+export interface MapView<R extends MaybePromise<ApplyResult> = MaybePromise<ApplyResult>> {
+    /** Add this to any PixiJS stage (a `Application`, a CanvasEngine scene). */
+    readonly root: Container;
+    /** The headless layer: modes, tools, selection, pipelines. Observable through `interaction.state`. */
+    readonly interaction: InteractionController<R>;
+    /** Asks for something to be done: runs the pipeline, then applies. See {@link InteractionController.submit}. */
+    readonly submit: InteractionController<R>["submit"];
+    /** One container per stage, back to front. */
+    readonly stages: Readonly<Record<StageName, Container>>;
+    readonly effects: MapViewEffects;
+    /**
+     * Restricts drawing to a world rectangle (usually the camera view). What is
+     * outside, margin included, is hidden. `null` shows everything.
+     */
+    setViewport(viewport: Rect | null): void;
+    /** Advances time. `mount` calls it every frame; call it yourself when you host `root`. */
+    tick(deltaMs: number): void;
+    /** Creates a PixiJS application in `host` and draws into it. */
+    mount(host: {
+        appendChild(node: never): unknown;
+    }, options?: MountOptions): Promise<void>;
+    /** Resolves once every image requested so far has loaded (or failed). */
+    whenIdle(): Promise<void>;
+    /** The nodes currently in the scene, as plain data. Useful for tests and tools. */
+    describe(): readonly SceneNode[];
+    destroy(): void;
+}
+export declare function createMapView<const F extends readonly MapFeature<string, object>[], R extends MaybePromise<ApplyResult> = ApplyResult>(options: MapViewOptions<F, R>): MapView<R> & FeatureApis<F>;
+/**
+ * Hosts a view in an existing PixiJS container, typically the `componentInstance`
+ * of a CanvasEngine component. Returns the function that detaches it again, which
+ * is what the `mount` hook of CanvasEngine expects to return.
+ *
+ * ```ce
+ * <Container />
+ *
+ * <script>
+ *   import { mount, tick } from "canvasengine";
+ *   import { attachMapView } from "@rpgjs/map-builder/renderer";
+ *
+ *   mount((element) => attachMapView(element.componentInstance, view));
+ *   tick(({ deltaTime }) => view.tick(deltaTime));
+ * </script>
+ * ```
+ */
+export declare function attachMapView(container: Container, view: Pick<MapView, "root">): () => void;
+//# sourceMappingURL=view.d.ts.map

package/dist/renderer/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/renderer/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,SAAS,EAA8B,MAAM,SAAS,CAAC;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAgB,KAAK,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAqB,KAAK,qBAAqB,EAAE,KAAK,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAEzG,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,YAAY,EAEjB,KAAK,YAAY,EAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAoB,KAAK,WAAW,EAAwC,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACtH,OAAO,EAAoB,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,SAAS,EAEd,KAAK,SAAS,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAA2C,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAE3F,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAEnD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE;QAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,GAAG,OAAO,CAAC;QAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,GAAG,OAAO,CAAA;KAAE,CAAC;IACrJ,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,oCAAoC;IACpC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,mBAAmB,CAAC;CACxD;AAED,MAAM,WAAW,cAAc,CAC7B,CAAC,SAAS,SAAS,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,SAAS,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EACvF,CAAC,SAAS,YAAY,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,WAAW,CAAC;IAE/D,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,sFAAsF;IACtF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/B,4GAA4G;IAC5G,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;IACpC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAC9D;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,+FAA+F;IAC/F,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,+EAA+E;IAC/E,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CAClD;AAED,iFAAiF;AACjF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhG,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;IAC9E,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC3D,KAAK,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,YAAY,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,WAAW,CAAC;IACtF,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,sGAAsG;IACtG,QAAQ,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC/C,gHAAgH;IAChH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACpD,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IACxD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACzC,0FAA0F;IAC1F,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gEAAgE;IAChE,KAAK,CAAC,IAAI,EAAE;QAAE,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1F,yEAAyE;IACzE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,mFAAmF;IACnF,QAAQ,IAAI,SAAS,SAAS,EAAE,CAAC;IACjC,OAAO,IAAI,IAAI,CAAC;CACjB;AAiBD,wBAAgB,aAAa,CAC3B,KAAK,CAAC,CAAC,SAAS,SAAS,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EACrD,CAAC,SAAS,YAAY,CAAC,WAAW,CAAC,GAAG,WAAW,EACjD,OAAO,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAmV5D;AAYD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,IAAI,CAM3F"}