Add media controller object toggle components

Author: arthurkehrwald

Editor/Inspector/DisabledParentObjectHelpBox.cs

@@ -0,0 +1,58 @@
+// 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.Linq;
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    public class DisabledParentObjectHelpBox : VisualElement
+    {
+        private readonly HelpBox _box;
+        private readonly UnityEditor.Editor _editor;
+
+        public DisabledParentObjectHelpBox(UnityEditor.Editor editor)
+        {
+            _editor = editor;
+            _box = new HelpBox(
+                "The game object this component is attached to or one of its parents is disabled. This component" +
+                " cannot initialize until its parent object becomes active in the hierarchy. It is possible that" +
+                " events from MPF will be missed.",
+                HelpBoxMessageType.Warning);
+            Add(_box);
+
+            RegisterCallback<AttachToPanelEvent>(evt =>
+            {
+                UpdateHelpBoxVisibility();
+                EditorApplication.hierarchyChanged += OnHierarchyChanged;
+            });
+
+            RegisterCallback<DetachFromPanelEvent>(evt =>
+            {
+                EditorApplication.hierarchyChanged -= OnHierarchyChanged;
+            });
+        }
+
+        private void OnHierarchyChanged() => UpdateHelpBoxVisibility();
+
+        private void UpdateHelpBoxVisibility()
+        {
+            _box.style.display = _editor.targets.ToList().Any(IsParentObjectDisabled)
+                ? DisplayStyle.Flex
+                : DisplayStyle.None;
+        }
+
+        private static bool IsParentObjectDisabled(UnityEngine.Object target) =>
+            !((Component)target).gameObject.activeInHierarchy;
+    }
+}

Editor/Inspector/DisabledParentObjectHelpBox.cs.meta

@@ -0,0 +1,31 @@
+// 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 UnityEditor.UIElements;
+using UnityEngine.UIElements;
+using VisualPinball.Engine.Mpf.Unity.MediaController.ObjectToggle;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    [CustomEditor(typeof(EnableDuringMode)), CanEditMultipleObjects]
+    public class EnableDuringModeInspector : UnityEditor.Editor
+    {
+        public override VisualElement CreateInspectorGUI()
+        {
+            var root = new VisualElement();
+            root.Add(new MissingGleHelpBoxes(this));
+            root.Add(new DisabledParentObjectHelpBox(this));
+            InspectorElement.FillDefaultInspector(root, serializedObject, this);
+            return root;
+        }
+    }
+}

Editor/Inspector/EnableDuringModeInspector.cs

@@ -0,0 +1,71 @@
+using System.Linq;
+using UnityEditor;
+using UnityEngine;
+using UnityEngine.UIElements;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    public class MissingGleHelpBoxes : VisualElement
+    {
+        private readonly HelpBox _missingGleHelpBox;
+        private readonly HelpBox _misconfiguredGleHelpBox;
+        private readonly UnityEditor.Editor _editor;
+
+        public MissingGleHelpBoxes(UnityEditor.Editor editor)
+        {
+            _editor = editor;
+            _missingGleHelpBox = new HelpBox(
+                "This component must be on a game object that is underneath an "
+                + "'MPF Game Logic' component in the scene hierarchy.",
+                HelpBoxMessageType.Error
+            );
+            Add(_missingGleHelpBox);
+
+            _misconfiguredGleHelpBox = new HelpBox(
+                "The MPF game logic engine is not configured to use the included media "
+                + $"controller. Set 'Media Controller' to '{MpfMediaController.Included}' "
+                + "in the game logic engine inspector.",
+                HelpBoxMessageType.Error
+            );
+            Add(_misconfiguredGleHelpBox);
+
+            RegisterCallback<AttachToPanelEvent>(evt =>
+            {
+                UpdateHelpBoxVisibility();
+                EditorApplication.hierarchyChanged += OnHierarchyChanged;
+            });
+
+            RegisterCallback<DetachFromPanelEvent>(evt =>
+            {
+                EditorApplication.hierarchyChanged -= OnHierarchyChanged;
+            });
+        }
+
+        private void OnHierarchyChanged() => UpdateHelpBoxVisibility();
+
+        private void UpdateHelpBoxVisibility()
+        {
+            if (_editor.targets.ToList().Any(IsGleMissing))
+                _missingGleHelpBox.style.display = DisplayStyle.Flex;
+            else
+                _missingGleHelpBox.style.display = DisplayStyle.None;
+            if (_editor.targets.ToList().Any(IsGleMisconfigured))
+                _misconfiguredGleHelpBox.style.display = DisplayStyle.Flex;
+            else
+                _misconfiguredGleHelpBox.style.display = DisplayStyle.None;
+        }
+
+        private MpfGamelogicEngine GetParentGle(UnityEngine.Object target)
+        {
+            return ((Component)target).GetComponentInParent<MpfGamelogicEngine>();
+        }
+
+        private bool IsGleMissing(UnityEngine.Object target) => GetParentGle(target) == null;
+
+        private bool IsGleMisconfigured(UnityEngine.Object target)
+        {
+            return !IsGleMissing(target)
+                   && GetParentGle(target).MediaControllerSetting != MpfMediaController.Included;
+        }
+    }
+}

Editor/Inspector/EnableDuringModeInspector.cs.meta

@@ -0,0 +1,33 @@
+// 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 UnityEditor.UIElements;
+using UnityEngine.UIElements;
+using VisualPinball.Engine.Mpf.Unity.MediaController.Text;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    [
+        CustomEditor(typeof(MonitoredVariableTextBase), editorForChildClasses: true),
+        CanEditMultipleObjects
+    ]
+    public class MonitoredVariableTextInspector : UnityEditor.Editor
+    {
+        public override VisualElement CreateInspectorGUI()
+        {
+            var root = new VisualElement();
+            root.Add(new MissingGleHelpBoxes(this));
+            InspectorElement.FillDefaultInspector(root, serializedObject, this);
+            return root;
+        }
+    }
+}

Editor/Inspector/MissingGleHelpBoxes.cs

@@ -0,0 +1,31 @@
+// 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 UnityEditor.UIElements;
+using UnityEngine.UIElements;
+using VisualPinball.Engine.Mpf.Unity.MediaController.ObjectToggle;
+
+namespace VisualPinball.Engine.Mpf.Unity.Editor
+{
+    [CustomEditor(typeof(ToggleOnEvent)), CanEditMultipleObjects]
+    public class ToggleOnEventIInspector : UnityEditor.Editor
+    {
+        public override VisualElement CreateInspectorGUI()
+        {
+            var root = new VisualElement();
+            root.Add(new MissingGleHelpBoxes(this));
+            root.Add(new DisabledParentObjectHelpBox(this));
+            InspectorElement.FillDefaultInspector(root, serializedObject, this);
+            return root;
+        }
+    }
+}