Save entity state for legacy objects

Hubs-Foundation · Jun 13, 2023 · 826ec75 · 826ec75
1 parent 39d3b83
commit 826ec75
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 4 deletions.
diff --git a/src/bit-systems/network-receive-system.ts b/src/bit-systems/network-receive-system.ts
@@ -2,7 +2,7 @@ import { addComponent, defineQuery, enterQuery, hasComponent, removeComponent, r
 import { HubsWorld } from "../app";
 import { Networked, Owned } from "../bit-components";
 import { renderAsNetworkedEntity } from "../utils/create-networked-entity";
-import { deleteEntityState, hasSavedEntityState } from "../utils/entity-state-utils";
+import { createEntityState, deleteEntityState, hasSavedEntityState } from "../utils/entity-state-utils";
 import { networkableComponents, schemas, StoredComponent } from "../utils/network-schemas";
 import type { ClientID, CursorBufferUpdateMessage, EntityID, StringID, UpdateMessage } from "../utils/networking-types";
 import { hasPermissionToSpawn } from "../utils/permissions";
@@ -145,6 +145,29 @@ export function networkReceiveSystem(world: HubsWorld) {
     }
   }
 
+  // Handle save entity messages
+  for (let i = 0; i < pendingMessages.length; i++) {
+    const message = pendingMessages[i];
+
+    for (let j = 0; j < message.saves.length; j++) {
+      const { networkId: nidString } = message.saves[j];
+      const nid = APP.getSid(nidString);
+      const eid = world.nid2eid.get(nid);
+
+      if (!eid) {
+        console.warn(`Received save message for unknown entity ${nidString}.`);
+        continue;
+      }
+
+      if (!isNetworkInstantiated(eid)) {
+        console.warn(`Received save message for non-network-instantiated entity ${nidString}.`);
+        continue;
+      }
+
+      createEntityState(APP.hubChannel!, world, eid);
+    }
+  }
+
   {
     // If reticulum told us to reassign an entity's creator, do so now
     pendingCreatorChanges.forEach(({ nid, creator }) => {
@@ -183,7 +206,7 @@ export function networkReceiveSystem(world: HubsWorld) {
       }
 
       // Process the stored message before other updates
-      pendingMessages.unshift({ creates: [], updates, deletes: [] });
+      pendingMessages.unshift({ creates: [], updates, deletes: [], saves: [] });
       storedUpdates.delete(nid);
     }
   });

diff --git a/src/utils/listen-for-network-messages.ts b/src/utils/listen-for-network-messages.ts
@@ -82,7 +82,8 @@ export function queueEntityStateAsMessage(entityState: EntityState) {
     fromClientId: "reticulum",
     creates: [entityState.create_message],
     updates: entityState.update_messages,
-    deletes: []
+    deletes: [],
+    saves: []
   });
   pendingCreatorChanges.push({
     nid: rootNid,

diff --git a/src/utils/message-for.ts b/src/utils/message-for.ts
@@ -12,6 +12,7 @@ import type {
   EntityID,
   Message,
   NetworkID,
+  SaveMessage,
   StorableUpdateMessage
 } from "./networking-types";
 
@@ -36,7 +37,8 @@ export function messageFor(
   const message: Message = {
     creates: [],
     updates: [],
-    deletes: []
+    deletes: [],
+    saves: []
   };
 
   created.forEach(eid => {
@@ -110,6 +112,7 @@ export interface LegacyRoomObject {
 export function messageForLegacyRoomObjects(objects: LegacyRoomObject[]) {
   const message: Message = {
     creates: [],
+    saves: [],
     updates: [],
     deletes: []
   };
@@ -131,6 +134,13 @@ export function messageForLegacyRoomObjects(objects: LegacyRoomObject[]) {
     };
     message.creates.push(createMessage);
 
+    if (obj.extensions.HUBS_components.pinnable.pinned) {
+      const saveMessage: SaveMessage = {
+        networkId: nid
+      };
+      message.saves.push(saveMessage);
+    }
+
     const updateMessage: StorableUpdateMessage = {
       data: {
         "networked-transform": {

diff --git a/src/utils/networking-types.ts b/src/utils/networking-types.ts
@@ -15,6 +15,9 @@ export type CreateMessage = {
   prefabName: PrefabName;
   initialData: InitialData;
 };
+export type SaveMessage = {
+  networkId: NetworkID;
+};
 export interface CursorBuffer extends Array<any> {
   cursor?: number;
 }
@@ -38,6 +41,7 @@ export type Message = {
   creates: CreateMessage[];
   updates: UpdateMessage[];
   deletes: DeleteMessage[];
+  saves: SaveMessage[];
 };
 export interface StorableMessage extends Message {
   version: 1;