Add ModeListMonitor

Author: arthurkehrwald

Runtime/MediaController/Messages/Mode/Mode.cs

@@ -9,9 +9,11 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+using System;
+
 namespace VisualPinball.Engine.Mpf.Unity.MediaController.Messages.Mode
 {
-    public readonly struct Mode
+    public readonly struct Mode : IEquatable<Mode>
     {
         public readonly string Name;
         public readonly int Priority;
@@ -21,5 +23,20 @@ public Mode(string name, int priority)
             Name = name;
             Priority = priority;
         }
+
+        public bool Equals(Mode other)
+        {
+            return Name == other.Name && Priority == other.Priority;
+        }
+
+        public override bool Equals(object obj)
+        {
+            return obj is Mode other && Equals(other);
+        }
+
+        public override int GetHashCode()
+        {
+            return HashCode.Combine(Name, Priority);
+        }
     }
 }

Runtime/MediaController/Messages/Mode/ModeList.cs

@@ -0,0 +1,49 @@
+// 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 System.Collections.ObjectModel;
+using System.Linq;
+
+namespace VisualPinball.Engine.Mpf.Unity.MediaController.Messages.Mode
+{
+    public class ModeList : IEquatable<ModeList>
+    {
+        private readonly ReadOnlyCollection<Mode> _list;
+
+        public ModeList(ReadOnlyCollection<Mode> list)
+        {
+            _list = list;
+        }
+
+        public bool Equals(ModeList other)
+        {
+            if (other is null) return false;
+            if (ReferenceEquals(this, other)) return true;
+            if (Equals(_list, other._list)) return true;
+            if (_list == null || other._list == null) return false;
+            return _list.Count == other._list.Count && _list.All(other._list.Contains);
+        }
+
+        public override bool Equals(object obj)
+        {
+            if (obj is null) return false;
+            if (ReferenceEquals(this, obj)) return true;
+            if (obj.GetType() != GetType()) return false;
+            return Equals((ModeList)obj);
+        }
+
+        public override int GetHashCode()
+        {
+            return _list != null ? _list.GetHashCode() : 0;
+        }
+    }
+}

Runtime/MediaController/Messages/Mode/ModeList.cs.meta

@@ -10,7 +10,6 @@
 // SOFTWARE.
 
 using System;
-using System.Collections.ObjectModel;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
@@ -20,39 +19,35 @@ public class ModeListMessage : EventArgs
     {
         public const string Command = "mode_list";
         public const string RunningModesParamName = "running_modes";
-        public ReadOnlyCollection<Mode> RunningModes => Array.AsReadOnly(_runningModes);
-        private readonly Mode[] _runningModes;
+        public readonly ModeList RunningModes;
 
-        public ModeListMessage(Mode[] runningModes)
+        public ModeListMessage(ModeList runningModes)
         {
-            _runningModes = runningModes;
+            RunningModes = runningModes;
         }
 
         public static ModeListMessage FromGenericMessage(BcpMessage bcpMessage)
         {
             try
             {
                 var jArr = bcpMessage.GetParamValue<JArray>(RunningModesParamName);
-                Mode[] runningModes = new Mode[jArr.Count];
+                var runningModes = new Mode[jArr.Count];
 
-                for (int i = 0; i < jArr.Count; i++)
+                for (var i = 0; i < jArr.Count; i++)
                 {
                     var modeJArr = (JArray)jArr[i];
                     var modeName = (string)modeJArr[0];
                     var modePrio = (int)modeJArr[1];
                     runningModes[i] = new Mode(modeName, modePrio);
                 }
 
-                return new ModeListMessage(runningModes);
+                return new ModeListMessage(new ModeList(Array.AsReadOnly(runningModes)));
             }
             catch (Exception e)
-                when (e is JsonException
-                    || e is InvalidCastException
-                    || e is IndexOutOfRangeException
-                )
+                when (e is JsonException or InvalidCastException or IndexOutOfRangeException)
             {
-                throw new ParameterException(RunningModesParamName, null, e);
+                throw new ParameterException(RunningModesParamName, bcpMessage, e);
             }
         }
     }
-}
+}

Runtime/MediaController/Messages/Mode/ModeListMessage.cs

@@ -0,0 +1,24 @@
+// 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.
+
+namespace VisualPinball.Engine.Mpf.Unity.MediaController.Messages.Mode
+{
+    public class ModeListMonitor : MonitorBase<ModeList, ModeListMessage>
+    {
+        public ModeListMonitor(BcpInterface bcpInterface) : base(bcpInterface)
+        {
+        }
+
+        protected override string BcpCommand => ModeListMessage.Command;
+
+        protected override ModeList GetValueFromMessage(ModeListMessage msg) => msg.RunningModes;
+    }
+}