Added a public Combinations collection and associated constructor to Keybind

CHANGELOG.md

@@ -18,6 +18,7 @@ Jump to version:
 ### MLEM
 Additions
 - **Added the ability for formatted (tokenized) strings to be drawn with custom rotation, origin and flipping**
+- **Added a public Combinations collection and associated constructor to Keybind**
 - Added a RectangleF.FromCorners overload that accepts points
 - Added indexers and Count to SpriteAnimation and SpriteAnimationGroup
 

MLEM/Input/Keybind.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Linq;
 using System.Runtime.Serialization;
 
@@ -20,27 +21,43 @@ namespace MLEM.Input {
         private static readonly Combination[] EmptyCombinations = new Combination[0];
         private static readonly GenericInput[] EmptyInputs = new GenericInput[0];
 
+        /// <summary>
+        /// A read-only collection containing all combinations that this keybind has.
+        /// This property is serializable using the <see cref="DataMemberAttribute"/>.
+        /// </summary>
         [DataMember]
-        private Combination[] combinations = Keybind.EmptyCombinations;
+        public readonly IList<Combination> Combinations;
+
+        private readonly List<Combination> combinations = new List<Combination>();
 
         /// <summary>
         /// Creates a new keybind and adds the given key and modifiers using <see cref="Add(MLEM.Input.GenericInput,MLEM.Input.GenericInput[])"/>
         /// </summary>
         /// <param name="key">The key to be pressed.</param>
         /// <param name="modifiers">The modifier keys that have to be held down.</param>
-        public Keybind(GenericInput key, params GenericInput[] modifiers) {
+        public Keybind(GenericInput key, params GenericInput[] modifiers) : this() {
             this.Add(key, modifiers);
         }
 
         /// <inheritdoc cref="Keybind(GenericInput, GenericInput[])"/>
-        public Keybind(GenericInput key, ModifierKey modifier) {
+        public Keybind(GenericInput key, ModifierKey modifier) : this() {
             this.Add(key, modifier);
         }
 
+        /// <summary>
+        /// Creates a new keybind from the given set of <paramref name="combinations"/>. This constructor can be used when manually serializing and deserializing a keybind's <see cref="Combinations"/>.
+        /// </summary>
+        /// <param name="combinations">The combinations to add.</param>
+        public Keybind(IList<Combination> combinations) : this() {
+            this.combinations.AddRange(combinations);
+        }
+
         /// <summary>
         /// Creates a new keybind with no default combinations
         /// </summary>
-        public Keybind() {}
+        public Keybind() {
+            this.Combinations = new ReadOnlyCollection<Combination>(this.combinations);
+        }
 
         /// <summary>
         /// Adds a new key combination to this keybind that can optionally be pressed for the keybind to trigger.
@@ -58,7 +75,7 @@ namespace MLEM.Input {
         /// <param name="combination">The combination to add.</param>
         /// <returns>This keybind, for chaining</returns>
         public Keybind Add(Combination combination) {
-            this.combinations = this.combinations.Append(combination).ToArray();
+            this.combinations.Add(combination);
             return this;
         }
 
@@ -87,7 +104,7 @@ namespace MLEM.Input {
         /// <param name="combination">The combination to insert.</param>
         /// <returns>This keybind, for chaining.</returns>
         public Keybind Insert(int index, Combination combination) {
-            this.combinations = this.combinations.Take(index).Append(combination).Concat(this.combinations.Skip(index)).ToArray();
+            this.combinations.Insert(index, combination);
             return this;
         }
 
@@ -103,7 +120,7 @@ namespace MLEM.Input {
         /// </summary>
         /// <returns>This keybind, for chaining</returns>
         public Keybind Clear() {
-            this.combinations = Keybind.EmptyCombinations;
+            this.combinations.Clear();
             return this;
         }
 
@@ -113,7 +130,10 @@ namespace MLEM.Input {
         /// <param name="predicate">The predicate to match against</param>
         /// <returns>This keybind, for chaining</returns>
         public Keybind Remove(Func<Combination, int, bool> predicate) {
-            this.combinations = this.combinations.Where((c, i) => !predicate(c, i)).ToArray();
+            // we can't use RemoveAll here because it doesn't provide an index
+            var keep = this.combinations.Where((c, i) => !predicate(c, i)).ToArray();
+            this.combinations.Clear();
+            this.combinations.AddRange(keep);
             return this;
         }
 
@@ -124,7 +144,7 @@ namespace MLEM.Input {
         /// <param name="other">The keybind to copy from</param>
         /// <returns>This keybind, for chaining</returns>
         public Keybind CopyFrom(Keybind other) {
-            this.combinations = this.combinations.Concat(other.combinations).ToArray();
+            this.combinations.AddRange(other.combinations);
             return this;
         }
 
@@ -285,7 +305,7 @@ namespace MLEM.Input {
         /// <param name="combination">The combination, or default if this method returns false.</param>
         /// <returns>Whether the combination could be successfully retrieved or the index was out of bounds of this keybind's combination collection.</returns>
         public bool TryGetCombination(int index, out Combination combination) {
-            if (index >= 0 && index < this.combinations.Length) {
+            if (index >= 0 && index < this.combinations.Count) {
                 combination = this.combinations[index];
                 return true;
             } else {