1.22.0 (#902)

## Major features

- Added `GlobalMusic` module to system config (change end times, bramble
dimension, and final end times music) (Resolves #894)
- Slides are now loaded in the background instead of freezing your game.
Brings load time of current Eyes of the Past dev build from 2.5 minutes
to 40 seconds (hooray). (Fixes #812)

## Improvements

- Setting `parentPath` will be more robust on most props (retries the
build operation until it finds the parent)

## Bug fixes

- Fix quantum planet NRE when body gets updated (astro object gets
recreated)
- Fix custom signal NRE that happens when going to solar system to get
prefabs for eye
- Fixed global bramble music not playing because all dimensions have an
ambient audio volume
- No more infinite load when warping back to Outer Wilds system with the
Vessel

NewHorizons/Builder/Props/Audio/SignalBuilder.cs

@@ -121,6 +121,7 @@ public static SignalFrequency AddFrequency(string str)
 
         public static string GetCustomFrequencyName(SignalFrequency frequencyName)
         {
+            if (_customFrequencyNames == null) return string.Empty;
             _customFrequencyNames.TryGetValue(frequencyName, out string name);
             return name;
         }
@@ -140,6 +141,7 @@ public static SignalName AddSignalName(string str)
 
         public static string GetCustomSignalName(SignalName signalName)
         {
+            if (_customSignalNames == null) return string.Empty;
             _customSignalNames.TryGetValue(signalName, out string name);
             return name;
         }

NewHorizons/Builder/Props/BrambleNodeBuilder.cs

@@ -113,6 +113,10 @@ private static void PropagateSignals(PlanetConfig[] dimensionConfigs)
                 if (dimension.Bramble.nodes == null) continue;
                 foreach (var node in dimension.Bramble.nodes)
                 {
+                    if (!dimensionNameToIndex.ContainsKey(node.linksTo))
+                    {
+                        NHLogger.LogError($"There is no bramble dimension named {node.linksTo}");
+                    }
                     var destinationDimensionIndex = dimensionNameToIndex[node.linksTo];
                     access[dimensionIndex, destinationDimensionIndex] = true;
                 }

NewHorizons/Builder/Props/RemoteBuilder.cs

@@ -12,6 +12,7 @@
 using OWML.Common;
 using System;
 using UnityEngine;
+using NewHorizons.External.Modules;
 
 namespace NewHorizons.Builder.Props
 {
@@ -122,10 +123,36 @@ internal static void InitPrefabs()
             }
         }
 
-        public static void Make(GameObject go, Sector sector, RemoteInfo info, NewHorizonsBody nhBody)
+        public static void MakeGeneralProps(GameObject go, Sector sector, RemoteInfo[] remotes, NewHorizonsBody nhBody)
         {
-            InitPrefabs();
+            if (remotes != null)
+            {
+                foreach (var remoteInfo in remotes)
+                {
+                    try
+                    {
+                        var mod = nhBody.Mod;
+                        var id = RemoteHandler.GetPlatformID(remoteInfo.id);
 
+                        Texture2D decal = Texture2D.whiteTexture;
+                        if (!string.IsNullOrWhiteSpace(remoteInfo.decalPath)) decal = ImageUtilities.GetTexture(mod, remoteInfo.decalPath, false, false, false);
+                        else NHLogger.LogError($"Missing decal path on [{remoteInfo.id}] for [{go.name}]");
+
+                        PropBuildManager.MakeGeneralProp(go, remoteInfo.platform, (platform) => MakePlatform(go, sector, id, decal, platform, mod), (platform) => remoteInfo.id);
+                        PropBuildManager.MakeGeneralProp(go, remoteInfo.whiteboard, (whiteboard) => MakeWhiteboard(go, sector, id, decal, whiteboard, nhBody), (whiteboard) => remoteInfo.id);
+                        PropBuildManager.MakeGeneralProps(go, remoteInfo.stones, (stone) => MakeStone(go, sector, id, decal, stone, mod), (stone) => remoteInfo.id);
+                    }
+                    catch (Exception ex)
+                    {
+                        NHLogger.LogError($"Couldn't make remote [{remoteInfo.id}] for [{go.name}]:\n{ex}");
+                    }
+                }
+            }
+        }
+
+        [Obsolete("Use MakeGeneralProps instead")]
+        public static void Make(GameObject go, Sector sector, RemoteInfo info, NewHorizonsBody nhBody)
+        {
             var mod = nhBody.Mod;
             var id = RemoteHandler.GetPlatformID(info.id);
 
@@ -149,7 +176,7 @@ public static void Make(GameObject go, Sector sector, RemoteInfo info, NewHorizo
             {
                 try
                 {
-                    MakeWhiteboard(go, sector, nhBody.Mod, id, decal, info.whiteboard, nhBody);
+                    MakeWhiteboard(go, sector, id, decal, info.whiteboard, nhBody);
                 }
                 catch (Exception ex)
                 {
@@ -173,8 +200,10 @@ public static void Make(GameObject go, Sector sector, RemoteInfo info, NewHorizo
             }
         }
 
-        public static void MakeWhiteboard(GameObject go, Sector sector, IModBehaviour mod, NomaiRemoteCameraPlatform.ID id, Texture2D decal, RemoteWhiteboardInfo info, NewHorizonsBody nhBody)
+        public static void MakeWhiteboard(GameObject go, Sector sector, NomaiRemoteCameraPlatform.ID id, Texture2D decal, RemoteWhiteboardInfo info, NewHorizonsBody nhBody)
         {
+            InitPrefabs();
+            var mod = nhBody.Mod;
             var whiteboard = DetailBuilder.Make(go, sector, mod, _whiteboardPrefab, new DetailInfo(info));
             whiteboard.SetActive(false);
 
@@ -213,8 +242,9 @@ public static void MakeWhiteboard(GameObject go, Sector sector, IModBehaviour mo
             whiteboard.SetActive(true);
         }
 
-        public static void MakePlatform(GameObject go, Sector sector, NomaiRemoteCameraPlatform.ID id, Texture2D decal, PlatformInfo info, IModBehaviour mod)
+        public static void MakePlatform(GameObject go, Sector sector, NomaiRemoteCameraPlatform.ID id, Texture2D decal, RemotePlatformInfo info, IModBehaviour mod)
         {
+            InitPrefabs();
             var platform = DetailBuilder.Make(go, sector, mod, _remoteCameraPlatformPrefab, new DetailInfo(info));
             platform.SetActive(false);
 
@@ -239,8 +269,9 @@ public static void MakePlatform(GameObject go, Sector sector, NomaiRemoteCameraP
             platform.SetActive(true);
         }
 
-        public static void MakeStone(GameObject go, Sector sector, NomaiRemoteCameraPlatform.ID id, Texture2D decal, StoneInfo info, IModBehaviour mod)
+        public static void MakeStone(GameObject go, Sector sector, NomaiRemoteCameraPlatform.ID id, Texture2D decal, ProjectionStoneInfo info, IModBehaviour mod)
         {
+            InitPrefabs();
             var shareStone = GeneralPropBuilder.MakeFromPrefab(_shareStonePrefab, "ShareStone_" + id.ToString(), go, sector, info);
 
             shareStone.GetComponent<SharedStone>()._connectedPlatform = id;

NewHorizons/Builder/Props/TranslatorText/TranslatorTextBuilder.cs

@@ -471,7 +471,7 @@ internal static void RefreshArcs(NomaiWallText nomaiWallText, GameObject convers
 
             if (info.arcInfo != null && info.arcInfo.Count() != dict.Values.Count())
             {
-                NHLogger.LogError($"Can't make NomaiWallText, arcInfo length [{info.arcInfo.Count()}] doesn't equal text entries [{dict.Values.Count()}]");
+                NHLogger.LogError($"Can't make NomaiWallText, arcInfo length [{info.arcInfo.Count()}] doesn't equal number of TextBlocks [{dict.Values.Count()}] in the xml");
                 return;
             }
 

NewHorizons/Components/EOTE/DreamWorldEndTimes.cs

@@ -0,0 +1,32 @@
+using NewHorizons.Utility.Files;
+using OWML.Common;
+using UnityEngine;
+
+namespace NewHorizons.Components.EOTE
+{
+    public class DreamWorldEndTimes : MonoBehaviour
+    {
+        private AudioType _endTimesAudio = AudioType.EndOfTime;
+        private AudioType _endTimesDreamAudio = AudioType.EndOfTime_Dream;
+
+        public void SetEndTimesAudio(AudioType audio)
+        {
+            _endTimesAudio = audio;
+        }
+
+        public void AssignEndTimes(OWAudioSource endTimesSource) => Assign(endTimesSource, _endTimesAudio);
+
+        public void SetEndTimesDreamAudio(AudioType audio)
+        {
+            _endTimesDreamAudio = audio;
+        }
+
+        public void AssignEndTimesDream(OWAudioSource endTimesSource) => Assign(endTimesSource, _endTimesDreamAudio);
+
+        public static void Assign(OWAudioSource endTimesSource, AudioType audio)
+        {
+            endTimesSource.Stop();
+            endTimesSource.AssignAudioLibraryClip(audio);
+        }
+    }
+}

NewHorizons/Components/Quantum/QuantumPlanet.cs

@@ -22,6 +22,16 @@ public class QuantumPlanet : QuantumObject
         private OWRigidbody _rb;
         private OrbitLine _orbitLine;
 
+        public NHAstroObject astroObject
+        {
+            get
+            {
+                if (_astroObject == null)
+                    _astroObject = GetComponent<NHAstroObject>();
+                return _astroObject;
+            }
+        }
+
         public int CurrentIndex { get; private set; }
 
         public override void Awake()
@@ -97,7 +107,7 @@ public override bool ChangeQuantumState(bool skipInstantVisibilityCheck)
 
                 primaryBody = AstroObjectLocator.GetAstroObject(newOrbit.primaryBody);
                 var primaryGravity = new Gravity(primaryBody.GetGravityVolume());
-                var secondaryGravity = new Gravity(_astroObject.GetGravityVolume());
+                var secondaryGravity = new Gravity(astroObject.GetGravityVolume());
                 orbitalParams = newOrbit.GetOrbitalParameters(primaryGravity, secondaryGravity);
 
                 var pos = primaryBody.transform.position + orbitalParams.InitialPosition;
@@ -139,15 +149,16 @@ private void SetNewSector(State oldState, State newState)
 
         private void SetNewOrbit(AstroObject primaryBody, OrbitalParameters orbitalParameters)
         {
-            _astroObject._primaryBody = primaryBody;
-            DetectorBuilder.SetDetector(primaryBody, _astroObject, _detector);
+            astroObject._primaryBody = primaryBody;
+            DetectorBuilder.SetDetector(primaryBody, astroObject, _detector);
             _detector._activeInheritedDetector = primaryBody.GetComponentInChildren<ForceDetector>();
             _detector._activeVolumes = new List<EffectVolume>() { primaryBody.GetGravityVolume() };
             if (_alignment != null) _alignment.SetTargetBody(primaryBody.GetComponent<OWRigidbody>());
 
-            _astroObject.SetOrbitalParametersFromTrueAnomaly(orbitalParameters.eccentricity, orbitalParameters.semiMajorAxis, orbitalParameters.inclination, orbitalParameters.argumentOfPeriapsis, orbitalParameters.longitudeOfAscendingNode, orbitalParameters.trueAnomaly);
+            astroObject.SetOrbitalParametersFromTrueAnomaly(orbitalParameters.eccentricity, orbitalParameters.semiMajorAxis, orbitalParameters.inclination, orbitalParameters.argumentOfPeriapsis, orbitalParameters.longitudeOfAscendingNode, orbitalParameters.trueAnomaly);
 
-            PlanetCreationHandler.UpdatePosition(gameObject, orbitalParameters, primaryBody, _astroObject);
+            PlanetCreationHandler.UpdatePosition(gameObject, orbitalParameters, primaryBody, astroObject);
+            gameObject.transform.parent = null;
 
             if (!Physics.autoSyncTransforms)
             {

NewHorizons/External/Configs/StarSystemConfig.cs

@@ -82,10 +82,13 @@ public class StarSystemConfig
         [Obsolete("travelAudioFilePath is deprecated, please use travelAudio instead")]
         public string travelAudioFilePath;
 
+        [Obsolete("travelAudio is deprecated, please use travelAudio instead")]
+        public string travelAudio;
+
         /// <summary>
-        /// The audio that will play when travelling in space. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+        /// Replace music that plays globally
         /// </summary>
-        public string travelAudio;
+        public GlobalMusicModule GlobalMusic;
 
         /// <summary>
         /// Configure warping to this system with the vessel
@@ -192,6 +195,45 @@ public class SkyboxModule
             public string backPath;
         }
 
+        [JsonObject]
+        public class GlobalMusicModule
+        {
+            /// <summary>
+            /// The audio that will play when travelling in space. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string travelAudio;
+
+            /// <summary>
+            /// The audio that will play right before the loop ends. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string endTimesAudio;
+
+            /// <summary>
+            /// The audio that will play right before the loop ends while inside the dreamworld. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string endTimesDreamAudio;
+
+            /// <summary>
+            /// The audio that will play when travelling through a bramble dimension. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string brambleDimensionAudio;
+
+            /// <summary>
+            /// The audio that will play when you leave the ash twin project after taking out the advanced warp core. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string finalEndTimesIntroAudio;
+
+            /// <summary>
+            /// The audio that will loop after the final end times intro. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string finalEndTimesLoopAudio;
+
+            /// <summary>
+            /// The audio that will loop after the final end times intro while inside a bramble dimension. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.
+            /// </summary>
+            public string finalEndTimesBrambleDimensionAudio;
+        }
+
         [JsonObject]
         public class VesselModule
         {
@@ -283,7 +325,6 @@ public void Merge(StarSystemConfig otherConfig)
             // If current one is null take the other
             factRequiredForWarp = string.IsNullOrEmpty(factRequiredForWarp) ? otherConfig.factRequiredForWarp : factRequiredForWarp;
             Skybox = Skybox == null ? otherConfig.Skybox : Skybox;
-            travelAudio = string.IsNullOrEmpty(travelAudio) ? otherConfig.travelAudio : travelAudio;
 
             // False by default so if one is true go true
             mapRestricted = mapRestricted || otherConfig.mapRestricted;
@@ -302,6 +343,21 @@ public void Merge(StarSystemConfig otherConfig)
                 Vessel ??= otherConfig.Vessel;
             }
 
+            if (GlobalMusic != null && otherConfig.GlobalMusic != null)
+            {
+                GlobalMusic.travelAudio = string.IsNullOrEmpty(GlobalMusic.travelAudio) ? otherConfig.GlobalMusic.travelAudio : GlobalMusic.travelAudio;
+                GlobalMusic.endTimesAudio = string.IsNullOrEmpty(GlobalMusic.endTimesAudio) ? otherConfig.GlobalMusic.endTimesAudio : GlobalMusic.endTimesAudio;
+                GlobalMusic.endTimesDreamAudio = string.IsNullOrEmpty(GlobalMusic.endTimesDreamAudio) ? otherConfig.GlobalMusic.endTimesDreamAudio : GlobalMusic.endTimesDreamAudio;
+                GlobalMusic.brambleDimensionAudio = string.IsNullOrEmpty(GlobalMusic.brambleDimensionAudio) ? otherConfig.GlobalMusic.brambleDimensionAudio : GlobalMusic.brambleDimensionAudio;
+                GlobalMusic.finalEndTimesIntroAudio = string.IsNullOrEmpty(GlobalMusic.finalEndTimesIntroAudio) ? otherConfig.GlobalMusic.finalEndTimesIntroAudio : GlobalMusic.finalEndTimesIntroAudio;
+                GlobalMusic.finalEndTimesLoopAudio = string.IsNullOrEmpty(GlobalMusic.finalEndTimesLoopAudio) ? otherConfig.GlobalMusic.finalEndTimesLoopAudio : GlobalMusic.finalEndTimesLoopAudio;
+                GlobalMusic.finalEndTimesBrambleDimensionAudio = string.IsNullOrEmpty(GlobalMusic.finalEndTimesBrambleDimensionAudio) ? otherConfig.GlobalMusic.finalEndTimesBrambleDimensionAudio : GlobalMusic.finalEndTimesBrambleDimensionAudio;
+            }
+            else
+            {
+                GlobalMusic ??= otherConfig.GlobalMusic;
+            }
+
             entryPositions = Concatenate(entryPositions, otherConfig.entryPositions);
             curiosities = Concatenate(curiosities, otherConfig.curiosities);
             initialReveal = Concatenate(initialReveal, otherConfig.initialReveal);
@@ -319,6 +375,11 @@ public void Migrate()
 #pragma warning disable 612, 618
             if (!string.IsNullOrEmpty(travelAudioClip)) travelAudio = travelAudioClip;
             if (!string.IsNullOrEmpty(travelAudioFilePath)) travelAudio = travelAudioFilePath;
+            if (!string.IsNullOrEmpty(travelAudio))
+            {
+                if (GlobalMusic == null) GlobalMusic = new GlobalMusicModule();
+                if (string.IsNullOrEmpty(GlobalMusic.travelAudio)) GlobalMusic.travelAudio = travelAudio;
+            }
             if (coords != null || vesselPosition != null || vesselRotation != null || warpExitPosition != null || warpExitRotation != null)
             {
                 if (Vessel == null)

NewHorizons/External/Modules/GeneralPropInfo.cs

@@ -5,27 +5,31 @@
 namespace NewHorizons.External.Modules
 {
     [JsonObject]
-    public abstract class GeneralPointPropInfo
+    public abstract class BasePropInfo
     {
         /// <summary>
-        /// Position of the object
+        /// The relative path from the planet to the parent of this object. Optional (will default to the root sector).
         /// </summary>
-        public MVector3 position;
+        public string parentPath;
 
         /// <summary>
-        /// The relative path from the planet to the parent of this object. Optional (will default to the root sector).
+        /// An optional rename of this object
         /// </summary>
-        public string parentPath;
+        public string rename;
+    }
 
+    [JsonObject]
+    public abstract class GeneralPointPropInfo : BasePropInfo
+    {
         /// <summary>
-        /// Whether the positional and rotational coordinates are relative to parent instead of the root planet object.
+        /// Position of the object
         /// </summary>
-        public bool isRelativeToParent;
+        public MVector3 position;
 
         /// <summary>
-        /// An optional rename of this object
+        /// Whether the positional and rotational coordinates are relative to parent instead of the root planet object.
         /// </summary>
-        public string rename;
+        public bool isRelativeToParent;
     }
 
     [JsonObject]

NewHorizons/External/Modules/Props/Remote/StoneInfo.cs → NewHorizons/External/Modules/Props/Remote/ProjectionStoneInfo.cs

@@ -3,7 +3,7 @@
 namespace NewHorizons.External.Modules.Props.Remote
 {
     [JsonObject]
-    public class StoneInfo : GeneralPropInfo
+    public class ProjectionStoneInfo : GeneralPropInfo
     {
 
     }

NewHorizons/External/Modules/Props/Remote/RemoteInfo.cs

@@ -23,11 +23,11 @@ public class RemoteInfo
         /// <summary>
         /// Camera platform that the stones can project to and from
         /// </summary>
-        public PlatformInfo platform;
+        public RemotePlatformInfo platform;
 
         /// <summary>
         /// Projection stones
         /// </summary>
-        public StoneInfo[] stones;
+        public ProjectionStoneInfo[] stones;
     }
 }

NewHorizons/External/Modules/Props/Remote/PlatformInfo.cs → NewHorizons/External/Modules/Props/Remote/RemotePlatformInfo.cs

@@ -4,7 +4,7 @@
 namespace NewHorizons.External.Modules.Props.Remote
 {
     [JsonObject]
-    public class PlatformInfo : GeneralPropInfo
+    public class RemotePlatformInfo : GeneralPropInfo
     {
         /// <summary>
         /// A ship log fact to reveal when the platform is connected to.