Fix getting stuck in cinematic bugs

Also skip intro by default for creative
SubnauticaNitrox · Jan 7, 2024 · 9edf7e9 · 9edf7e9
1 parent b2df797
commit 9edf7e9
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 17 deletions.
diff --git a/NitroxClient/GameLogic/PlayerLogic/PlayerCinematics.cs b/NitroxClient/GameLogic/PlayerLogic/PlayerCinematics.cs
@@ -1,4 +1,5 @@
-using NitroxClient.Communication.Abstract;
+using System.Collections.Generic;
+using NitroxClient.Communication.Abstract;
 using NitroxModel.DataStructures;
 using NitroxModel.DataStructures.GameLogic;
 using NitroxModel.Packets;
@@ -10,6 +11,11 @@ public class PlayerCinematics
     private readonly IPacketSender packetSender;
     private readonly LocalPlayer localPlayer;
 
+    /// <summary>
+    /// Some cinematics should not be played. Example the intro as it's completely handled by a dedicated system.
+    /// </summary>
+    private readonly HashSet<string> blacklistedKeys = ["escapepod_intro"];
+
     public PlayerCinematics(IPacketSender packetSender, LocalPlayer localPlayer)
     {
         this.packetSender = packetSender;
@@ -18,12 +24,18 @@ public PlayerCinematics(IPacketSender packetSender, LocalPlayer localPlayer)
 
     public void StartCinematicMode(ushort playerId, NitroxId controllerID, int controllerNameHash, string key)
     {
-        packetSender.Send(new PlayerCinematicControllerCall(playerId, controllerID, controllerNameHash, key, true));
+        if (!blacklistedKeys.Contains(key))
+        {
+            packetSender.Send(new PlayerCinematicControllerCall(playerId, controllerID, controllerNameHash, key, true));
+        }
     }
 
     public void EndCinematicMode(ushort playerId, NitroxId controllerID, int controllerNameHash, string key)
     {
-        packetSender.Send(new PlayerCinematicControllerCall(playerId, controllerID, controllerNameHash, key, false));
+        if (!blacklistedKeys.Contains(key))
+        {
+            packetSender.Send(new PlayerCinematicControllerCall(playerId, controllerID, controllerNameHash, key, false));
+        }
     }
 
     public void SetLocalIntroCinematicMode(IntroCinematicMode introCinematicMode)

diff --git a/NitroxClient/GameLogic/Spawning/WorldEntities/EscapePodWorldEntitySpawner.cs b/NitroxClient/GameLogic/Spawning/WorldEntities/EscapePodWorldEntitySpawner.cs
@@ -48,7 +48,7 @@ private GameObject CreateNewEscapePod(EscapePodWorldEntity escapePodEntity)
             // TODO: When we want to implement multiple escape pods, instantiate the prefab. Backlog task: #1945
             //       This will require some work as instantiating the prefab as-is will not make it visible.
             //GameObject escapePod = Object.Instantiate(EscapePod.main.gameObject);
-            
+
             GameObject escapePod = EscapePod.main.gameObject;
             UnityEngine.Component.DestroyImmediate(escapePod.GetComponent<NitroxEntity>()); // if template has a pre-existing NitroxEntity, remove.
             NitroxEntity.SetNewId(escapePod, escapePodEntity.Id);
@@ -69,13 +69,6 @@ private GameObject CreateNewEscapePod(EscapePodWorldEntity escapePodEntity)
 
             FixStartMethods(escapePod);
 
-            // Start() isn't executed for the EscapePod, why? Idk, maybe because it's a scene...
-            MultiplayerCinematicReference reference = escapePod.AddComponent<MultiplayerCinematicReference>();
-            foreach (PlayerCinematicController controller in escapePod.GetComponentsInChildren<PlayerCinematicController>())
-            {
-                reference.AddController(controller);
-            }
-
             return escapePod;
         }
 
@@ -84,15 +77,21 @@ private GameObject CreateNewEscapePod(EscapePodWorldEntity escapePodEntity)
         /// </summary>
         private static void FixStartMethods(GameObject escapePod)
         {
-            foreach (FMOD_CustomEmitter customEmitter in escapePod.GetComponentsInChildren<FMOD_CustomEmitter>())
+            foreach (FMOD_CustomEmitter customEmitter in escapePod.GetComponentsInChildren<FMOD_CustomEmitter>(true))
             {
                 customEmitter.Start();
             }
 
-            foreach (FMOD_StudioEventEmitter studioEventEmitter in escapePod.GetComponentsInChildren<FMOD_StudioEventEmitter>())
+            foreach (FMOD_StudioEventEmitter studioEventEmitter in escapePod.GetComponentsInChildren<FMOD_StudioEventEmitter>(true))
             {
                 studioEventEmitter.Start();
             }
+
+            MultiplayerCinematicReference reference = escapePod.AddComponent<MultiplayerCinematicReference>();
+            foreach (PlayerCinematicController controller in escapePod.GetComponentsInChildren<PlayerCinematicController>(true))
+            {
+                reference.AddController(controller);
+            }
         }
 
         public bool SpawnsOwnChildren()

diff --git a/NitroxClient/MonoBehaviours/CinematicController/MultiplayerCinematicReference.cs b/NitroxClient/MonoBehaviours/CinematicController/MultiplayerCinematicReference.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using NitroxClient.GameLogic;
 using NitroxClient.Unity.Helper;
+using NitroxModel.DataStructures.GameLogic;
 using UnityEngine;
 
 namespace NitroxClient.MonoBehaviours.Overrides;
@@ -10,8 +11,18 @@ public class MultiplayerCinematicReference : MonoBehaviour
 {
     private readonly Dictionary<string, Dictionary<int, MultiplayerCinematicController>> controllerByKey = new();
 
+    private bool isEscapePod;
+
+    private void Start()
+    {
+        // TODO: Currently only single EscapePod is supported, therefor EscapePod.main. Can probably be removed after we use one pod per intro sequence
+        isEscapePod = gameObject == EscapePod.main.gameObject;
+    }
+
     public void CallStartCinematicMode(string key, int identifier, RemotePlayer player)
     {
+        if(isEscapePod && this.Resolve<LocalPlayer>().IntroCinematicMode is IntroCinematicMode.PLAYING or IntroCinematicMode.SINGLEPLAYER) return;
+
         if (!controllerByKey.TryGetValue(key, out Dictionary<int, MultiplayerCinematicController> controllers))
         {
             throw new KeyNotFoundException($"There was no entry for the key {key} at {gameObject.GetFullHierarchyPath()}");
@@ -27,6 +38,8 @@ public void CallStartCinematicMode(string key, int identifier, RemotePlayer play
 
     public void CallCinematicModeEnd(string key, int identifier, RemotePlayer player)
     {
+        if(isEscapePod && this.Resolve<LocalPlayer>().IntroCinematicMode is IntroCinematicMode.PLAYING or IntroCinematicMode.SINGLEPLAYER) return;
+
         if (!controllerByKey.TryGetValue(key, out Dictionary<int, MultiplayerCinematicController> controllers))
         {
             throw new KeyNotFoundException($"There was no entry for the key {key} at {gameObject.GetFullHierarchyPath()}");
@@ -44,7 +57,6 @@ public void CallCinematicModeEnd(string key, int identifier, RemotePlayer player
 
     public void AddController(PlayerCinematicController playerController)
     {
-
         MultiplayerCinematicController[] allControllers = controllerByKey.SelectMany(n => n.Value.Select(x => x.Value)).ToArray();
 
         if (!controllerByKey.TryGetValue(playerController.playerViewAnimationName, out Dictionary<int, MultiplayerCinematicController> controllers))
@@ -59,7 +71,7 @@ public void AddController(PlayerCinematicController playerController)
         {
             return;
         }
-        
+
         MultiplayerCinematicController controller = MultiplayerCinematicController.Initialize(playerController);
         controller.AddOtherControllers(allControllers);
         allControllers.ForEach(x => x.AddOtherControllers(new[] { controller }));

diff --git a/NitroxModel/DataStructures/GameLogic/IntroCinematicMode.cs b/NitroxModel/DataStructures/GameLogic/IntroCinematicMode.cs
@@ -6,6 +6,7 @@ public enum IntroCinematicMode : byte
     LOADING,
     WAITING,
     START,
+    PLAYING,
     SINGLEPLAYER,
     COMPLETED
 }
diff --git a/NitroxPatcher/Patches/Dynamic/uGUI_SceneIntro_IntroSequence_Patch.cs b/NitroxPatcher/Patches/Dynamic/uGUI_SceneIntro_IntroSequence_Patch.cs
@@ -93,6 +93,7 @@ private static float GetSkipTime()
     private static bool IsRemoteCinematicReady(uGUI_SceneIntro uGuiSceneIntro)
     {
         if (callbackRun) return true;
+        if (GameModeUtils.currentGameMode.HasFlag(GameModeOption.Creative)) uGuiSceneIntro.Stop(true); // Stopping intro if Creative like in normal SN
 
         if (Resolve<LocalPlayer>().IntroCinematicMode == IntroCinematicMode.COMPLETED)
         {
@@ -120,6 +121,7 @@ private static bool IsRemoteCinematicReady(uGUI_SceneIntro uGuiSceneIntro)
         {
             partner = firstWaitingRemotePlayer;
             EnqueueStartCinematic(uGuiSceneIntro);
+            Resolve<PlayerCinematics>().SetLocalIntroCinematicMode(IntroCinematicMode.PLAYING);
         }
 
         return false;

diff --git a/NitroxServer/Communication/Packets/Processors/SetIntroCinematicModeProcessor.cs b/NitroxServer/Communication/Packets/Processors/SetIntroCinematicModeProcessor.cs
@@ -14,6 +14,7 @@ public SetIntroCinematicModeProcessor(PlayerManager playerManager)
     {
         this.playerManager = playerManager;
     }
+
     public override void Process(SetIntroCinematicMode packet, Player player)
     {
         if (packet.PlayerId != player.Id)
@@ -31,8 +32,8 @@ public override void Process(SetIntroCinematicMode packet, Player player)
             Log.Info($"Starting IntroCinematic for {allWaitingPlayers[0].PlayerContext.PlayerName} and {allWaitingPlayers[1].PlayerContext.PlayerName}");
 
             allWaitingPlayers[0].PlayerContext.IntroCinematicMode = allWaitingPlayers[1].PlayerContext.IntroCinematicMode = IntroCinematicMode.START;
-            allWaitingPlayers[0].SendPacket(new SetIntroCinematicMode(allWaitingPlayers[1].Id, IntroCinematicMode.START));
-            allWaitingPlayers[1].SendPacket(new SetIntroCinematicMode(allWaitingPlayers[0].Id, IntroCinematicMode.START));
+            playerManager.SendPacketToAllPlayers(new SetIntroCinematicMode(allWaitingPlayers[0].Id, IntroCinematicMode.START));
+            playerManager.SendPacketToAllPlayers(new SetIntroCinematicMode(allWaitingPlayers[1].Id, IntroCinematicMode.START));
         }
     }
 }