Merge pull request #521 from futureboxsystems/sound-upgrades

Sound upgrades

Author: freezy

VisualPinball.Unity/VisualPinball.Unity.Editor/AssetBrowser/AssetLibrary.cs

@@ -30,7 +30,7 @@ namespace VisualPinball.Unity.Editor
 	/// This is the root node of the asset library.
 	///
 	/// The data itself is stored in a sub object, <see cref="_db"/>. This sub object contains
-	/// references to the asset meta data, as well as the categories.
+	/// references to the asset metadata, as well as the categories.
 	/// </summary>
 	[CreateAssetMenu(fileName = "Library", menuName = "Pinball/Asset Library", order = 300)]
 	public class AssetLibrary : ScriptableObject, ISerializationCallbackReceiver

VisualPinball.Unity/VisualPinball.Unity.Editor/Import/VpxSceneConverter.cs

@@ -163,6 +163,8 @@ public GameObject Convert(bool applyPatch = true, string tableName = null)
 
 			ConfigurePlayer(componentLookup);
 
+			SetUpAudio();
+
 			// patch
 			if (_applyPatch) {
 				_patcher?.PostPatch(_tableGo);
@@ -523,6 +525,12 @@ private void CreateTrough(Dictionary<string, IMainComponent> components)
 			InstantiateAndPersistPrefab(item, components);
 		}
 
+		private void SetUpAudio()
+		{
+			_tableGo.AddComponent<CalloutCoordinator>();
+			_tableGo.AddComponent<MusicCoordinator>();
+		}
+
 		private void CreateFileHierarchy()
 		{
 			if (!Directory.Exists("Assets/Tables/")) {

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/BinaryEventSoundInspector.cs

@@ -0,0 +1,37 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace VisualPinball.Unity.Editor
+{
+	[CanEditMultipleObjects]
+	public class BinaryEventSoundInspector : SoundComponentInspector
+	{
+		[SerializeField]
+		private VisualTreeAsset binaryEventSoundInspectorXml;
+
+		public override VisualElement CreateInspectorGUI()
+		{
+			var root = base.CreateInspectorGUI();
+			var inspectorUi = binaryEventSoundInspectorXml.Instantiate();
+			root.Add(inspectorUi);
+			return root;
+		}
+	}
+}

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/BinaryEventSoundInspector.cs.meta

@@ -0,0 +1,4 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
+    <uie:PropertyField binding-path="StartWhen" label="Start When" tooltip="When to start playing the sound" />
+    <uie:PropertyField binding-path="StopWhen" label="Stop When" tooltip="When to stop playing the sound" />
+</ui:UXML>

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/BinaryEventSoundInspector.uxml

@@ -0,0 +1,41 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+// ReSharper disable InconsistentNaming
+
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace VisualPinball.Unity.Editor
+{
+	[CustomEditor(typeof(CalloutAsset)), CanEditMultipleObjects]
+	public class CalloutAssetInspector : SoundAssetInspector
+	{
+		[SerializeField]
+		private VisualTreeAsset _calloutAssetInspector;
+
+		public override VisualElement CreateInspectorGUI()
+		{
+			var root = new VisualElement();
+			var baseUi = base.CreateInspectorGUI();
+			root.Add(baseUi);
+			var subUi = _calloutAssetInspector.Instantiate();
+			root.Add(subUi);
+			return root;
+		}
+	}
+}

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/BinaryEventSoundInspector.uxml.meta

@@ -0,0 +1,3 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
+    <uie:PropertyField binding-path="_volume" label="Volume" />
+</ui:UXML>

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/CalloutAssetInspector.cs

@@ -1,5 +1,5 @@
 // Visual Pinball Engine
-// Copyright (C) 2023 freezy and VPE Team
+// Copyright (C) 2025 freezy and VPE Team
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -23,15 +23,15 @@
 namespace VisualPinball.Unity.Editor
 {
 	[CustomEditor(typeof(CoilSoundComponent)), CanEditMultipleObjects]
-	public class CoilSoundComponentInspector : SoundComponentInspector
+	public class CoilSoundInspector : BinaryEventSoundInspector
 	{
 		[SerializeField]
-		private VisualTreeAsset inspectorXml;
+		private VisualTreeAsset coilSoundInspectorXml;
 
 		public override VisualElement CreateInspectorGUI()
 		{
 			var root = base.CreateInspectorGUI();
-			var inspectorUi = inspectorXml.Instantiate();
+			var inspectorUi = coilSoundInspectorXml.Instantiate();
 			root.Add(inspectorUi);
 			var coilNameDropdown = root.Q<DropdownField>("coil-name");
 			var coilNameProp = serializedObject.FindProperty(nameof(CoilSoundComponent.CoilName));
@@ -43,7 +43,11 @@ public override VisualElement CreateInspectorGUI()
 		private Dictionary<string, string> GetAvailableCoils()
 		{
 			var targetComponent = target as Component;
-			if (targetComponent != null && targetComponent.TryGetComponent<ICoilDeviceComponent>(out var coilDevice)) {
+			if (
+				targetComponent != null
+				&& targetComponent.TryGetComponent<ICoilDeviceComponent>(out var coilDevice)
+			)
+			{
 				return coilDevice.AvailableCoils.ToDictionary(
 					i => i.Id,
 					i => string.IsNullOrWhiteSpace(i.Description) ? i.Id : i.Description

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/CalloutAssetInspector.cs.meta

@@ -0,0 +1,39 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace VisualPinball.Unity.Editor
+{
+	[CustomEditor(typeof(MusicAsset)), CanEditMultipleObjects]
+	public class MusicAssetInspector : SoundAssetInspector
+	{
+		[SerializeField]
+		private VisualTreeAsset _musicAssetInspectorAsset;
+
+		public override VisualElement CreateInspectorGUI()
+		{
+			var root = new VisualElement();
+			var baseUi = base.CreateInspectorGUI();
+			root.Add(baseUi);
+			var subUi = _musicAssetInspectorAsset.Instantiate();
+			root.Add(subUi);
+			return root;
+		}
+	}
+}

VisualPinball.Unity/VisualPinball.Unity.Editor/Sound/CalloutAssetInspector.uxml

@@ -0,0 +1,3 @@
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
+    <uie:PropertyField binding-path="_volume" label="Volume" />
+</ui:UXML>