Add sync for StoryHandTarget (SubnauticaNitrox#2595)

Author: misterbubb

Nitrox.Model.Subnautica/DataStructures/GameLogic/Entities/Metadata/EntityMetadata.cs

@@ -41,6 +41,8 @@ namespace Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata
     [ProtoInclude(82, typeof(PlantableMetadata))]
     [ProtoInclude(83, typeof(FruitPlantMetadata))]
     [ProtoInclude(84, typeof(DrillableMetadata))]
+    [ProtoInclude(85, typeof(PrecursorComputerTerminalMetadata))]
+    [ProtoInclude(86, typeof(GenericConsoleMetadata))]
     public abstract class EntityMetadata
     {
     }

Nitrox.Model.Subnautica/DataStructures/GameLogic/Entities/Metadata/GenericConsoleMetadata.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Runtime.Serialization;
+using BinaryPack.Attributes;
+
+namespace Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+
+[Serializable]
+[DataContract]
+public class GenericConsoleMetadata : EntityMetadata
+{
+    [DataMember(Order = 1)]
+    public bool GotUsed { get; }
+
+    [IgnoreConstructor]
+    protected GenericConsoleMetadata()
+    {
+    }
+
+    public GenericConsoleMetadata(bool gotUsed)
+    {
+        GotUsed = gotUsed;
+    }
+
+    public override string ToString()
+    {
+        return $"[GenericConsoleMetadata GotUsed: {GotUsed}]";
+    }
+}

Nitrox.Model.Subnautica/DataStructures/GameLogic/Entities/Metadata/PrecursorComputerTerminalMetadata.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Runtime.Serialization;
+using BinaryPack.Attributes;
+
+namespace Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+
+[Serializable]
+[DataContract]
+public class PrecursorComputerTerminalMetadata : EntityMetadata
+{
+    [DataMember(Order = 1)]
+    public bool Used { get; }
+
+    [IgnoreConstructor]
+    protected PrecursorComputerTerminalMetadata()
+    {
+        // Constructor for serialization. Has to be "protected" for json serialization.
+    }
+
+    public PrecursorComputerTerminalMetadata(bool used)
+    {
+        Used = used;
+    }
+
+    public override string ToString()
+    {
+        return $"[PrecursorComputerTerminalMetadata Used: {Used}]";
+    }
+}

Nitrox.Test/Server/Serialization/WorldPersistenceTest.cs

@@ -336,6 +336,12 @@ private static void EntityTest(Entity entity, Entity entityAfter)
                 Assert.IsTrue(metadata.ChunkHealth.SequenceEqual(metadataAfter.ChunkHealth));
                 Assert.AreEqual(metadata.TimeLastDrilled, metadataAfter.TimeLastDrilled);
                 break;
+            case PrecursorComputerTerminalMetadata metadata when entityAfter.Metadata is PrecursorComputerTerminalMetadata metadataAfter:
+                Assert.AreEqual(metadata.Used, metadataAfter.Used);
+                break;
+            case GenericConsoleMetadata metadata when entityAfter.Metadata is GenericConsoleMetadata metadataAfter:
+                Assert.AreEqual(metadata.GotUsed, metadataAfter.GotUsed);
+                break;
             default:
                 Assert.Fail($"Runtime type of {nameof(Entity)}.{nameof(Entity.Metadata)} is not equal: {entity.Metadata?.GetType().Name} - {entityAfter.Metadata?.GetType().Name}");
                 break;

NitroxClient/GameLogic/Spawning/Metadata/Extractor/GenericConsoleMetadataExtractor.cs

@@ -0,0 +1,12 @@
+using Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+using NitroxClient.GameLogic.Spawning.Metadata.Extractor.Abstract;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata.Extractor;
+
+public class GenericConsoleMetadataExtractor : EntityMetadataExtractor<GenericConsole, GenericConsoleMetadata>
+{
+    public override GenericConsoleMetadata Extract(GenericConsole entity)
+    {
+        return new(entity.gotUsed);
+    }
+}

NitroxClient/GameLogic/Spawning/Metadata/Extractor/PrecursorComputerTerminalMetadataExtractor.cs

@@ -0,0 +1,12 @@
+using Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+using NitroxClient.GameLogic.Spawning.Metadata.Extractor.Abstract;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata.Extractor;
+
+public class PrecursorComputerTerminalMetadataExtractor : EntityMetadataExtractor<PrecursorComputerTerminal, PrecursorComputerTerminalMetadata>
+{
+    public override PrecursorComputerTerminalMetadata Extract(PrecursorComputerTerminal entity)
+    {
+        return new(entity.used);
+    }
+}

NitroxClient/GameLogic/Spawning/Metadata/Processor/GenericConsoleMetadataProcessor.cs

@@ -0,0 +1,19 @@
+using Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+using NitroxClient.GameLogic.Spawning.Metadata.Processor.Abstract;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata.Processor;
+
+public class GenericConsoleMetadataProcessor : EntityMetadataProcessor<GenericConsoleMetadata>
+{
+    public override void ProcessMetadata(GameObject gameObject, GenericConsoleMetadata metadata)
+    {
+        GenericConsole console = gameObject.GetComponent<GenericConsole>();
+        if (console && !console.gotUsed && metadata.GotUsed)
+        {
+            // OnStoryHandTarget sets gotUsed and updates visual state (icon color, hand target).
+            // This is equivalent to deserializing fields since OnProtoDeserialize just calls UpdateState().
+            console.OnStoryHandTarget();
+        }
+    }
+}

NitroxClient/GameLogic/Spawning/Metadata/Processor/PrecursorComputerTerminalMetadataProcessor.cs

@@ -0,0 +1,17 @@
+using Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+using NitroxClient.GameLogic.Spawning.Metadata.Processor.Abstract;
+using UnityEngine;
+
+namespace NitroxClient.GameLogic.Spawning.Metadata.Processor;
+
+public class PrecursorComputerTerminalMetadataProcessor : EntityMetadataProcessor<PrecursorComputerTerminalMetadata>
+{
+    public override void ProcessMetadata(GameObject gameObject, PrecursorComputerTerminalMetadata metadata)
+    {
+        PrecursorComputerTerminal terminal = gameObject.GetComponent<PrecursorComputerTerminal>();
+        if (terminal && !terminal.used && metadata.Used)
+        {
+            terminal.OnStoryHandTarget();
+        }
+    }
+}

NitroxPatcher/Patches/Dynamic/StoryHandTarget_OnHandClick_Patch.cs

@@ -0,0 +1,37 @@
+using System.Reflection;
+using NitroxClient.Communication.Abstract;
+using NitroxClient.GameLogic;
+using Nitrox.Model.DataStructures;
+using Nitrox.Model.Subnautica.DataStructures.GameLogic.Entities.Metadata;
+using Nitrox.Model.Subnautica.Packets;
+
+namespace NitroxPatcher.Patches.Dynamic;
+
+public sealed partial class StoryHandTarget_OnHandClick_Patch : NitroxPatch, IDynamicPatch
+{
+    private static readonly MethodInfo TARGET_METHOD = Reflect.Method((StoryHandTarget t) => t.OnHandClick(default(GUIHand)));
+
+    public static void Postfix(StoryHandTarget __instance)
+    {
+        if (__instance.destroyGameObject == __instance.gameObject &&
+            __instance.gameObject.TryGetNitroxId(out NitroxId destroyId))
+        {
+            Resolve<IPacketSender>().Send(new EntityDestroyed(destroyId));
+            return;
+        }
+
+        if (__instance.informGameObject)
+        {
+            if (__instance.informGameObject.TryGetComponent(out PrecursorComputerTerminal terminal) &&
+                __instance.informGameObject.TryGetNitroxId(out NitroxId terminalId))
+            {
+                Resolve<Entities>().BroadcastMetadataUpdate(terminalId, new PrecursorComputerTerminalMetadata(terminal.used));
+            }
+            else if (__instance.informGameObject.TryGetComponent(out GenericConsole console) &&
+                     __instance.informGameObject.TryGetNitroxId(out NitroxId consoleId))
+            {
+                Resolve<Entities>().BroadcastMetadataUpdate(consoleId, new GenericConsoleMetadata(console.gotUsed));
+            }
+        }
+    }
+}