@aethervtt/shard-scene 0.0.1 → 0.2.0

package/dist/components.d.ts

@@ -1,5 +1,5 @@
 import { AssetStore } from '@aethervtt/shard-assets';
-import { type Entity, type JsonValue } from '@aethervtt/shard-core';
+import { type Entity, type JsonValue, type Owner } from '@aethervtt/shard-core';
 import type { PrefabFile, SceneEntity, SceneFile } from './format.js';
 /** Marks entities that came from a scene file. */
 export declare const SceneMember: import("@aethervtt/shard-core").ComponentDef<{
@@ -18,6 +18,8 @@ export interface LoadedScene {
     loadedResources: Map<string, JsonValue>;
     /** Guids of every asset the scene referenced, requested at load. */
     assets: Set<string>;
+    /** Who it was loaded for (0061); releasing the owner unloads it. */
+    owner?: Owner;
 }
 export declare const SceneIndex: import("@aethervtt/shard-core").ResourceDef<Map<string, LoadedScene>>;
 /** Scene files loaded as assets (a glTF's node tree), by guid. */

package/dist/components.js

@@ -34,15 +34,22 @@ const SceneAssetType = defineAssetType("Scene", {
       return out;
     };
     return resolve(artifact.json);
-  }
+  },
+  // A model that failed to load spawns a beveled box in its place (0061).
+  fallback: () => ({ version: 1, entities: [MISSING_ENTITY] })
 });
+const MISSING_ENTITY = {
+  name: "missing",
+  components: { "render/Mesh3d": { mesh: { path: "procedural:missing-box" } } }
+};
 const PrefabAssets = defineResource("scene/PrefabAssets", {
   description: "Prefab assets (resolved entity trees) by guid.",
   init: () => new AssetStore("Prefab")
 });
 const PrefabAssetType = defineAssetType("Prefab", {
   store: PrefabAssets,
-  load: (artifact) => artifact.json
+  load: (artifact) => artifact.json,
+  fallback: () => ({ version: 1, root: MISSING_ENTITY })
 });
 const overridesField = () => t.json({
   default: {},

package/dist/instances.js

@@ -31,6 +31,7 @@ import {
   componentDef,
   equal,
   expandAliases,
+  notAuthorable,
   rebase,
   resolveAssets,
   serializeComponents
@@ -271,6 +272,10 @@ function applyOverrides(flat, overrides, prefix, report, validate) {
         );
         continue;
       }
+      if (def.hostOnly) {
+        report(key, notAuthorable(name, where));
+        continue;
+      }
       if (!def.serializable || def === ChildOf) {
         report(
           key,
@@ -432,7 +437,7 @@ function stateOf(world) {
   let s = perWorld.get(world);
   if (!s) {
     const off = assetServer(world).onEvent((e) => {
-      if (e.kind !== "loaded" && e.kind !== "modified") return;
+      if (e.kind !== "loaded" && e.kind !== "modified" && e.kind !== "failed") return;
       const type = assetServer(world).entry(e.guid)?.type;
       if (type === "Scene" || type === "Prefab") updateInstances(world);
     });
@@ -760,7 +765,7 @@ function updateInstances(world) {
           server.request(entry.guid);
           continue;
         }
-        if (entry.state !== "loaded") continue;
+        if (entry.state !== "loaded" && !server.isFallback(entry.guid)) continue;
         const state = s.states.get(entity);
         const o = overridesOf(value.overrides);
         if (state && state.def === def && state.template.entry.guid === entry.guid && isCurrent(world, state.template) && state.template.flat.missing.size === 0 && state.overridesKey === JSON.stringify(o)) {

package/dist/procedural.js

@@ -1,5 +1,6 @@
 import { ShardError } from "@aethervtt/shard-core";
 import {
+  bevelBox,
   box,
   capsule,
   cone,
@@ -20,6 +21,15 @@ const PROCEDURAL_MESHES = {
   torus: {
     params: ["radius", "tube", "radialSegments", "tubularSegments"],
     create: (p) => torus(p)
+  },
+  // The stand-in for a mesh or model that failed to load (0061).
+  "missing-box": {
+    params: [],
+    create: () => {
+      const mesh = bevelBox();
+      mesh.missing = true;
+      return mesh;
+    }
   }
 };
 function parseProcedural(source, params = {}, path) {

package/dist/scene.d.ts

@@ -1,4 +1,4 @@
-import { type AssetRef, type ComponentDef, type Entity, type JsonValue, type ResolvedAsset, type SchemaContext, ShardError, type World } from '@aethervtt/shard-core';
+import { type AssetRef, type ComponentDef, type Entity, type JsonValue, type Owner, type ResolvedAsset, type SchemaContext, ShardError, type World } from '@aethervtt/shard-core';
 import { type SceneAsset, type SceneEntity, type SceneFile } from './format.js';
 export interface LoadedSceneHandle {
     id: string;
@@ -59,9 +59,14 @@ export declare function validateTree(world: World, file: {
 }, flat: readonly FlatEntity[], errors: ShardError[], options: TreeOptions): void;
 /** A specific scene error beats the generic asset-not-found for the same field; drop duplicates. */
 export declare function dedupeErrors(errors: ShardError[]): ShardError[];
-/** Validates, then spawns the scene. Throws `scene/invalid` (with every error in `details`) if invalid. */
+/**
+ * Validates, then spawns the scene. Throws `scene/invalid` (with every error in `details`) if invalid.
+ * With `owner` (0061), everything in it belongs to that owner, and a scene that would exceed the
+ * owner's entity limit throws `core/owner-quota` before anything spawns.
+ */
 export declare function loadScene(world: World, json: unknown, options?: {
     id?: string;
+    owner?: Owner;
 }): LoadedSceneHandle;
 /**
  * Resolves once every asset the scene referenced has loaded or failed (following their
@@ -91,3 +96,5 @@ export declare function saveScene(world: World, id: string): SceneFile;
 /** Scene JSON as written to disk: 2-space indent, trailing newline. */
 export declare function stringifyScene(file: SceneFile): string;
 export type { AssetRef };
+/** A host-only component (ownership, 0061) named in authored data. */
+export declare function notAuthorable(name: string, path: string): ShardError;

package/dist/scene.js

@@ -352,6 +352,10 @@ function validateTree(world, file, flat, errors, options) {
         );
         continue;
       }
+      if (def.hostOnly) {
+        errors.push(notAuthorable(name, base));
+        continue;
+      }
       if (!def.serializable || def === ChildOf) {
         errors.push(
           new ShardError("scene/derived-component", `"${name}" can't be written in a scene`, {
@@ -517,6 +521,7 @@ function loadScene(world, json, options = {}) {
   const file = json;
   const flat = [];
   flatten(file.entities, "/entities", void 0, flat);
+  if (options.owner) world.owners.ensureCapacity(options.owner, "entities", flat.length);
   const entities = /* @__PURE__ */ new Map();
   for (const f of flat) entities.set(f.path, world.reserveEntity());
   const requested = /* @__PURE__ */ new Set();
@@ -556,6 +561,12 @@ function loadScene(world, json, options = {}) {
     else world.insertResource(def, structuredCloneJson(value));
     scene.loadedResources.set(name, toJson(world.resource(def)));
   }
+  if (options.owner) {
+    for (const f of flat)
+      if (f.parent === void 0) world.owners.adopt(options.owner, entities.get(f.path));
+    scene.owner = options.owner;
+    forgetOnRelease(world);
+  }
   index.set(id, scene);
   return { id, entities };
 }
@@ -708,6 +719,22 @@ function stringifyScene(file) {
   return `${JSON.stringify(file, null, 2)}
 `;
 }
+const forgetting = /* @__PURE__ */ new WeakSet();
+function forgetOnRelease(world) {
+  if (forgetting.has(world)) return;
+  forgetting.add(world);
+  world.owners.onRelease((owner) => {
+    const index = world.tryResource(SceneIndex);
+    if (!index) return;
+    for (const [id, scene] of index) if (scene.owner === owner) index.delete(id);
+  });
+}
+function notAuthorable(name, path) {
+  return new ShardError("core/owner-not-authorable", `"${name}" can't be written in scene files`, {
+    path,
+    hint: "Ownership is a grant from host code: the host loads the scene for an owner (world.owners)."
+  });
+}
 export {
   ALIASES,
   addSceneReadyCheck,
@@ -719,6 +746,7 @@ export {
   findEntityByPath,
   flatten,
   loadScene,
+  notAuthorable,
   pathOfEntity,
   rebase,
   reloadScene,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aethervtt/shard-scene",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -16,12 +16,12 @@
     "README.md"
   ],
   "dependencies": {
-    "@aethervtt/shard-assets": "0.0.1",
-    "@aethervtt/shard-core": "0.0.1",
-    "@aethervtt/shard-mesh": "0.0.1",
-    "@aethervtt/shard-render": "0.0.1",
-    "@aethervtt/shard-runtime": "0.0.1",
-    "@aethervtt/shard-transform": "0.0.1"
+    "@aethervtt/shard-assets": "0.2.0",
+    "@aethervtt/shard-core": "0.2.0",
+    "@aethervtt/shard-mesh": "0.2.0",
+    "@aethervtt/shard-render": "0.2.0",
+    "@aethervtt/shard-runtime": "0.2.0",
+    "@aethervtt/shard-transform": "0.2.0"
   },
   "repository": {
     "type": "git",
@@ -33,6 +33,6 @@
     "provenance": true
   },
   "shard": {
-    "buildSha": "d6c5c6aef4675575c878b02cf2c8f738b4190229"
+    "buildSha": "32c22a3944ed23f5d1baa90bf7cc9fae724f5fd8"
   }
 }