Fix cyclops initsync (SubnauticaNitrox#1065)

* Added logging and TryGetVehicle variant to check return value instead of exception

* Added ToString for VehicleModel.cs

* Fixed CyclopsLightingPanel trying to get NitroxID from wrong GO

It checked the instance.gameObject which is the LightsControl sub GO of the Cyclops GO.
So it's fixed by getting the parent of the instance.gameObject, being the Cyclops main GO.

* Used Optional.OfNullable for TryGetVehicle instead of .Of()

* Handled Unity object destroyed case for Optional.OfNullable()

Author: Measurity

NitroxClient/GameLogic/Vehicles.cs

@@ -412,6 +412,7 @@ public void SetOnPilotMode(NitroxId vehicleId, ushort playerId, bool isPiloting)
         public void AddVehicle(VehicleModel vehicleModel)
         {
             vehiclesById.Add(vehicleModel.Id, vehicleModel);
+            Log.Debug($"{nameof(Vehicles)}: Added vehicle {vehicleModel}");
         }
 
         public bool RemoveVehicle(VehicleModel vehicleModel)
@@ -428,5 +429,12 @@ public T GetVehicles<T>(NitroxId vehicleId) where T : VehicleModel
         {            
             return (T)vehiclesById[vehicleId];
         }
+
+        public Optional<T> TryGetVehicle<T>(NitroxId vehicleId) where T : VehicleModel
+        {
+            VehicleModel vehicle;
+            vehiclesById.TryGetValue(vehicleId, out vehicle);
+            return Optional.OfNullable((T)vehicle);
+        }
     }
 }

NitroxModel/DataStructures/GameLogic/VehicleModel.cs

@@ -61,5 +61,10 @@ public VehicleModel(TechType techType, NitroxId id, Vector3 position, Quaternion
             Colours = colours;
             Health = health;
         }
+
+        public override string ToString()
+        {
+            return $"{nameof(TechType)}: {TechType}, {nameof(Id)}: {Id}, {nameof(Position)}: {Position}, {nameof(Name)}: {Name}";
+        }
     }
 }

NitroxModel/DataStructures/Optional.cs

@@ -22,27 +22,27 @@ public struct Optional<T> : ISerializable
         public T Value { get; private set; }
 
         private bool hasValue;
-        
+
         [ProtoMember(2)]
         public bool HasValue
         {
             get
             {
-                if (ReferenceEquals(Value, null))
-                {
-                    return false;
-                }
-
-                // Check to satisfy unity objects.  Sometimes they are internally destroyed but are not considered null.
-                // For the purpose of optional, we consider a dead object to be the same as null.
-                return Value.ToString() != "null";
+                return !IsDestroyedUnityObjectOrNull(Value);
             }
             set
             {
                 hasValue = value;
             }
         }
 
+        private static bool IsDestroyedUnityObjectOrNull<TValue>(TValue value)
+        {
+            // Check to satisfy unity objects. Sometimes they are internally destroyed but are not considered null.
+            // For the purpose of optional, we consider a dead object to be the same as null.
+            return ReferenceEquals(value, null) || value.ToString() == "null";
+        }
+
         private Optional(T value)
         {
             Value = value;
@@ -66,6 +66,10 @@ internal static Optional<T> Of(T value)
 
         internal static Optional<T> OfNullable(T value)
         {
+            if (IsDestroyedUnityObjectOrNull(value))
+            {
+                return Optional.Empty;
+            }
             return Equals(default(T), value) ? Optional.Empty : new Optional<T>(value);
         }
 
@@ -88,7 +92,10 @@ public void GetObjectData(SerializationInfo info, StreamingContext context)
             info.AddValue("hasValue", HasValue);
         }
 
-        public static implicit operator Optional<T>(OptionalEmpty none) => new Optional<T>();
+        public static implicit operator Optional<T>(OptionalEmpty none)
+        {
+            return new Optional<T>();
+        }
 
         public static implicit operator Optional<T>?(T obj)
         {
@@ -118,8 +125,15 @@ public static class Optional
     {
         public static OptionalEmpty Empty { get; } = new OptionalEmpty();
 
-        public static Optional<T> Of<T>(T value) => Optional<T>.Of(value);
-        public static Optional<T> OfNullable<T>(T value) => Optional<T>.OfNullable(value);
+        public static Optional<T> Of<T>(T value)
+        {
+            return Optional<T>.Of(value);
+        }
+
+        public static Optional<T> OfNullable<T>(T value)
+        {
+            return Optional<T>.OfNullable(value);
+        }
     }
 
     public sealed class OptionalNullException<T> : Exception

NitroxPatcher/Patches/Dynamic/CyclopsLightingPanel_OnSubConstructionComplete_Patch.cs

@@ -3,8 +3,11 @@
 using Harmony;
 using NitroxClient.GameLogic;
 using NitroxClient.MonoBehaviours;
+using NitroxClient.Unity.Helper;
 using NitroxModel.Core;
 using NitroxModel.DataStructures;
+using NitroxModel.DataStructures.Util;
+using NitroxModel.Logger;
 using NitroxModel_Subnautica.DataStructures.GameLogic;
 using UnityEngine;
 
@@ -18,11 +21,16 @@ class CyclopsLightingPanel_OnSubConstructionComplete_Patch : NitroxPatch, IDynam
         public static bool Prefix(CyclopsLightingPanel __instance)
         {
             // Suppress powered on if a cyclops´s floodlight is set to false            
-            GameObject gameObject = __instance.gameObject;
+            GameObject gameObject = __instance.gameObject.transform.parent.gameObject; // GO = LightsControl, Parent = main cyclops game object
             NitroxId id = NitroxEntity.GetId(gameObject);
-            CyclopsModel model = NitroxServiceLocator.LocateService<Vehicles>().GetVehicles<CyclopsModel>(id);
-            
-            return model.FloodLightsOn;
+            Optional<CyclopsModel> model = NitroxServiceLocator.LocateService<Vehicles>().TryGetVehicle<CyclopsModel>(id);
+            if (!model.HasValue)
+            {
+                Log.Error($"{nameof(CyclopsLightingPanel_OnSubConstructionComplete_Patch)}: Could not find {nameof(CyclopsModel)} by Nitrox id {id}.\nGO containing wrong id: {__instance.GetHierarchyPath()}");
+                return false;
+            }
+
+            return model.Value.FloodLightsOn;
         }
 
         public override void Patch(HarmonyInstance harmony)