Add sound support

Author: arthurkehrwald

Editor/Inspector/MpfEventSoundInspector.cs

@@ -0,0 +1,34 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+using VisualPinball.Engine.Mpf.Unity.MediaController.Sound;
+using VisualPinball.Unity.Editor;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    [CustomEditor(typeof(MpfEventSound)), CanEditMultipleObjects]
+    public class MpfEventSoundInspector : SoundComponentInspector
+    {
+        [SerializeField]
+        private VisualTreeAsset mpfEventSoundInspectorXml;
+
+        public override VisualElement CreateInspectorGUI()
+        {
+            var root = base.CreateInspectorGUI();
+            var inspectorUi = mpfEventSoundInspectorXml.Instantiate();
+            root.Add(inspectorUi);
+            return root;
+        }
+    }
+}

Editor/Inspector/MpfEventSoundInspector.cs.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="_eventName" label="Event" tooltip="The name of the MPF event that should trigger the sound" />
+</ui:UXML>

Editor/Inspector/MpfEventSoundInspector.uxml

@@ -0,0 +1,34 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+using VisualPinball.Engine.Mpf.Unity.MediaController.Sound;
+using VisualPinball.Unity.Editor;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    [CustomEditor(typeof(MpfModeSound)), CanEditMultipleObjects]
+    public class MpfModeSoundInspector : BinaryEventSoundComponentInspector
+    {
+        [SerializeField]
+        private VisualTreeAsset mpfModeSoundInspectorXml;
+
+        public override VisualElement CreateInspectorGUI()
+        {
+            var root = base.CreateInspectorGUI();
+            var inspectorUi = mpfModeSoundInspectorXml.Instantiate();
+            root.Add(inspectorUi);
+            return root;
+        }
+    }
+}

Editor/Inspector/MpfEventSoundInspector.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="_modeName" label="Mode" tooltip="The name of the MPF mode that should trigger the sound" />
+</ui:UXML>

Editor/Inspector/MpfModeSoundInspector.cs

@@ -0,0 +1,47 @@
+// Visual Pinball Engine
+// Copyright (C) 2025 freezy and VPE Team
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+using System;
+using UnityEngine;
+using VisualPinball.Engine.Mpf.Unity.MediaController.Messages.Trigger;
+using VisualPinball.Unity;
+
+namespace VisualPinball.Engine.Mpf.Unity.MediaController.Sound
+{
+    [AddComponentMenu("Visual Pinball/Sound/Mpf Event Sound")]
+    public class MpfEventSound : EventSoundComponent<MpfEventListener, EventArgs>
+    {
+        [SerializeField]
+        private string _eventName;
+
+        protected override void Subscribe(MpfEventListener eventSource)
+        {
+            eventSource.Triggered += OnEvent;
+        }
+
+        protected override void Unsubscribe(MpfEventListener eventSource)
+        {
+            eventSource.Triggered -= OnEvent;
+        }
+
+        protected override bool TryFindEventSource(out MpfEventListener eventSource)
+        {
+            if (MpfGamelogicEngine.TryGetBcpInterface(this, out var bcpInterface))
+            {
+                eventSource = new MpfEventListener(bcpInterface, _eventName);
+                return true;
+            }
+
+            eventSource = null;
+            return false;
+        }
+    }
+}