Prevent ChildParentAudioClipPlayer component crashing the game

Adds a fix for Yellow-Dog-Man/Resonite-Issues#1457

Author: Banane9

CommunityBugFixCollection/Locale/de.json

@@ -38,6 +38,7 @@
     "CommunityBugFixCollection.NodeNameAdjustments.Description": "Verbessert die verwirrenden Namen der Remap [-1; 1] zu [0; 1] ProtoFlux Nodes.",
     "CommunityBugFixCollection.NonHDRColorClamping.Description": "Korrigiert, dass die nicht-HDR Varianten der Color(X) Kanal-Additionen die Werte nicht limitieren.",
     "CommunityBugFixCollection.NonLinearColorXFromHexCode.Description": "Zwingt colorX From HexCode das sRGB statt dem Linearen Farbprofil zu nutzen.",
+    "CommunityBugFixCollection.NoParentUnderSelfAudioClipPlayer.Description": "Verhindert, dass die ChildParentAudioClipPlayer-Komponente das Spiel crasht, wenn ihr <i>ParentUnder</i>-Feld auf den Slot, auf dem sie ist, gesetzt ist. Fügt außerdem eine Erklärung des Problems im Header hinzu.",
     "CommunityBugFixCollection.PauseAnimatorUpdates.Description": "Verhindert, dass Animatoren jeden Frame in alle assoziierten Felder schreiben, obwohl sie nicht am animieren sind.",
     "CommunityBugFixCollection.ReallyNoDestroyUndo.Description": "Sorgt dafür, dass die NoDestroyUndo Komponente tatsächlich verhindert, dass das Zerstören eines Objekts rückgängig gemacht werden kann.",
     "CommunityBugFixCollection.SmoothDraggables.Description": "Umgeht, dass Slider und Joints in Headless-Sessions verrutschen.",
@@ -50,6 +51,8 @@
     "CommunityBugFixCollection.Config.Options.Name": "Optionen",
     "CommunityBugFixCollection.Config.Options.Description": "Enthällt die Einstellungen für die wenigen Fixes die diese anbieten.",
     "CommunityBugFixCollection.Config.Options.UseIecByteFormat.Name": "IEC Byte-Format Benutzen",
-    "CommunityBugFixCollection.Config.Options.UseIecByteFormat.Description": "Ob Bytes nach IEC (Faktor 1024) statt dezimal (Faktor 1000) formatiert werden sollen, wenn <i>LocalizedByteFormatting</i> aktiviert ist."
+    "CommunityBugFixCollection.Config.Options.UseIecByteFormat.Description": "Ob Bytes nach IEC (Faktor 1024) statt dezimal (Faktor 1000) formatiert werden sollen, wenn <i>LocalizedByteFormatting</i> aktiviert ist.",
+
+    "CommunityBugFixCollection.ChildParentAudioClipPlayer.Header": "Das <i>ParentUnder</i>-Feld dieser AudioClipPlayer-Komponente darf niemals auf den Slot, auf dem sie ist, gesetzt werden. Andernfalls crasht das Spiel wenn ein Clip ausgelöst wird."
   }
 }

CommunityBugFixCollection/Locale/en.json

@@ -44,6 +44,7 @@
     "CommunityBugFixCollection.NodeNameAdjustments.Description": "Fixes the confusing names of the Remap [-1; 1] to [0; 1] ProtoFlux nodes.",
     "CommunityBugFixCollection.NonHDRColorClamping.Description": "Fixes non-HDR variants of Color(X) channel addition not clamping.",
     "CommunityBugFixCollection.NonLinearColorXFromHexCode.Description": "Forces colorX From HexCode to use the sRGB rather than Linear profile.",
+    "CommunityBugFixCollection.NoParentUnderSelfAudioClipPlayer.Description": "Prevents the ChildParentAudioClipPlayer components from crashing the game if their <i>ParentUnder</i> field is set to the slot that it's on. Also adds a header text explaining the problem.",
     "CommunityBugFixCollection.PauseAnimatorUpdates.Description": "Fixes animators updating all associated fields every frame while enabled but not playing.",
     "CommunityBugFixCollection.ReallyNoDestroyUndo.Description": "Makes the NoDestroyUndo component actually prevent undoing destroying something.",
     "CommunityBugFixCollection.SmoothDraggables.Description": "Workaround for Sliders and Joints snapping in sessions hosted by a headless.",
@@ -70,6 +71,8 @@
     "CommunityBugFixCollection.StorageUnits.MB": "MB",
     "CommunityBugFixCollection.StorageUnits.GB": "GB",
     "CommunityBugFixCollection.StorageUnits.TB": "TB",
-    "CommunityBugFixCollection.StorageUnits.PB": "PB"
+    "CommunityBugFixCollection.StorageUnits.PB": "PB",
+
+    "CommunityBugFixCollection.ChildParentAudioClipPlayer.Header": "This AudioClipPlayer component's <i>ParentUnder</i> field must never be set to the slot it's on. Otherwise, the game will crash when a clip is triggered."
   }
 }

CommunityBugFixCollection/NoParentUnderSelfAudioClipPlayer.cs

@@ -0,0 +1,46 @@
+using FrooxEngine;
+using HarmonyLib;
+using MonkeyLoader.Resonite;
+using MonkeyLoader.Resonite.UI.Inspectors;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CommunityBugFixCollection
+{
+    [HarmonyPatch(typeof(ChildParentAudioClipPlayer))]
+    [HarmonyPatchCategory(nameof(NoParentUnderSelfAudioClipPlayer))]
+    internal sealed class NoParentUnderSelfAudioClipPlayer : ResoniteEventHandlerMonkey<NoParentUnderSelfAudioClipPlayer, ResolveInspectorHeaderTextEvent>
+    {
+        public override IEnumerable<string> Authors => Contributors.Banane9;
+
+        public override bool CanBeDisabled => true;
+
+        public override int Priority => HarmonyLib.Priority.Low;
+
+        protected override void Handle(ResolveInspectorHeaderTextEvent eventData)
+            => eventData.AddItem(new(Mod.GetLocaleString("ChildParentAudioClipPlayer.Header")));
+
+        [HarmonyPostfix]
+        [HarmonyPatch(nameof(ChildParentAudioClipPlayer.OnAwake))]
+        private static void OnAwakePostfix(ChildParentAudioClipPlayer __instance)
+        {
+            if (Enabled && __instance.ParentUnder.Target == __instance.Slot)
+                __instance.ParentUnder.Target = null!;
+
+            __instance.ParentUnder.OnTargetChange += _ =>
+            {
+                if (Enabled && __instance.ParentUnder.Target == __instance.Slot)
+                    __instance.RunSynchronously(() => __instance.ParentUnder.Target = null!);
+            };
+        }
+
+        [HarmonyPostfix]
+        [HarmonyPatch(nameof(ChildParentAudioClipPlayer.PlayClip))]
+        private static void PlayClipPrefix(ChildParentAudioClipPlayer __instance)
+        {
+            if (Enabled && __instance.World.CanMakeSynchronousChanges && __instance.ParentUnder.Target == __instance.Slot)
+                __instance.ParentUnder.Target = null!;
+        }
+    }
+}

README.md

@@ -53,6 +53,7 @@ just disable them in the settings in the meantime.
 	* https://github.com/Yellow-Dog-Man/Locale/issues/186
 * FlipAtUser component does not respect view position (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1335)
 * ColorX From HexCode (ProtoFlux node) defaults to Linear profile (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1404)
+* ChildParentAudioClipPlayer component crashes the game when it's triggered while its *ParentUnder* field is set to the slot it's on (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1457)
 * Resolution scale may get stuck at 0.5 when opening and closing the SteamVR dashboard while the game is hitching (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2337)
 * `ValueMod<Decimal>` node crashes the game when B input is set to zero or disconnected. (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2746)
 * Grid World grid being off-center (https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/2754)