Command overloads can now specify multiple per-parameter parsers with selective property paths + overload names can now contain spaces too

Author: marchellcx

LabExtended/API/Custom/Items/CustomItem.cs

@@ -62,7 +62,6 @@ public abstract class CustomItem : CustomObject<CustomItem>
         /// item-specific data.
         /// </summary>
         /// <param name="item">The item being processed. Represents the current item held by the player.</param>
-        /// <param name="owner">The player who owns the item.</param>
         /// <param name="itemData">A reference to an object containing additional data associated with the item. Can be modified within the
         /// delegate to update item-specific information.</param>
         public delegate void ForEachPickupDelegate(ItemPickupBase item, ref object? itemData);
@@ -1119,7 +1118,7 @@ public virtual void OnTogglingLight(PlayerTogglingFlashlightEventArgs args, ref
         /// </summary>
         /// <param name="args">The event data associated with the player's flashlight toggle action, including information about the player
         /// and the flashlight state.</param>
-        /// <param name="itemData">A reference to the item-specific data./param>
+        /// <param name="itemData">A reference to the item-specific data.</param>
         public virtual void OnToggledLight(PlayerToggledFlashlightEventArgs args, ref object? itemData)
         {
 
@@ -1194,7 +1193,7 @@ public virtual void OnUpgradedPickup(Scp914ProcessedPickupEventArgs args, ref ob
         /// </summary>
         /// <param name="args">The event data containing information about the player being disarmed and the context of the disarming
         /// action.</param>
-        /// <param name="itemData">A reference to the item's data./param>
+        /// <param name="itemData">A reference to the item's data.</param>
         public virtual void OnDisarming(PlayerCuffingEventArgs args, ref object? itemData)
         {
 

LabExtended/API/PlayerStorage.cs

@@ -108,8 +108,8 @@ public bool TryGet<T>(string name, out T value)
         /// <param name="name">The name the value was saved under.</param>
         /// <param name="defaultValue">The value to return if the specified name was not found.</param>
         /// <returns>The saved value if found, otherwise <paramref name="defaultValue"/>.</returns>
-        public object Get(string name, object defaultValue = null)
-            => _storage.TryGetValue(name, out var value) ? value : defaultValue;
+        public object Get(string name, object? defaultValue = null)
+            => _storage!.TryGetValue(name, out var value) ? value : defaultValue!;
 
         /// <summary>
         /// Gets the value saved under the <paramref name="name"/>.
@@ -118,12 +118,12 @@ public object Get(string name, object defaultValue = null)
         /// <param name="name">The name the value was saved under.</param>
         /// <param name="defaultValue">The value to return if the specified name was not found.</param>
         /// <returns>The saved value if found, otherwise <paramref name="defaultValue"/>.</returns>
-        public T Get<T>(string name, T defaultValue = default)
+        public T Get<T>(string name, T? defaultValue = default)
         {
-            if (_storage.TryGetValue(name, out var cachedValue) && cachedValue != null && cachedValue is T castValue)
+            if (_storage!.TryGetValue(name, out var cachedValue) && cachedValue != null && cachedValue is T castValue)
                 return castValue;
 
-            return defaultValue;
+            return defaultValue!;
         }
 
         /// <summary>

LabExtended/API/Toys/AdminToy.cs

@@ -201,7 +201,7 @@ public byte MovementSmoothing
     }
 
     /// <summary>
-    /// Disables / enables position & rotation synchronization.
+    /// Disables / enables position and rotation synchronization.
     /// </summary>
     public bool IsStatic
     {

LabExtended/Commands/Attributes/CommandAttribute.cs

@@ -27,7 +27,7 @@ public class CommandAttribute : Attribute
     public bool IsStatic { get; set; } = true;
 
     /// <summary>
-    /// Whether or not this command should be hidden from the help command & Remote Admin's suggestions.
+    /// Whether or not this command should be hidden from the help command and Remote Admin's suggestions.
     /// </summary>
     public bool IsHidden { get; set; } = false;
 

LabExtended/Commands/Attributes/CommandParameterAttribute.cs

@@ -75,6 +75,49 @@ public CommandParameterAttribute()
         /// <param name="description">A description of the command parameter. If not specified, defaults to "No description".</param>
         public CommandParameterAttribute(string name, string description = "No description")
         {
+            Name = name;
+            Description = description;
+
+            InitRestriction();
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the CommandParameterAttribute class with the specified restriction types. This
+        /// constructor is obsolete.
+        /// </summary>
+        /// <remarks>This constructor is deprecated. Use the parameterless constructor and set the
+        /// RestrictionType property separately to specify restrictions. Using this constructor will result in a
+        /// compile-time error.</remarks>
+        /// <param name="restrictionTypes">An array of types used to restrict the allowed values for the parameter. Only the first type in the array is
+        /// used.</param>
+        [Obsolete("This constructor is deprecated. Use the constructor without restrictionTypes and set RestrictionType property separately.", true)]
+        public CommandParameterAttribute(params Type[] restrictionTypes)
+        {
+            if (restrictionTypes.Length > 0)
+                RestrictionType = restrictionTypes[0];
+
+            InitRestriction();
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the CommandParameterAttribute class with the specified name, description, and
+        /// restriction types.
+        /// </summary>
+        /// <remarks>This constructor is obsolete. Use the constructor without restrictionTypes and set
+        /// the RestrictionType property separately.</remarks>
+        /// <param name="name">The name of the command parameter. Cannot be null.</param>
+        /// <param name="description">A description of the command parameter. Cannot be null.</param>
+        /// <param name="restrictionTypes">An array of types that restrict the allowed values for the parameter. If multiple types are provided, only
+        /// the first is used.</param>
+        [Obsolete("This constructor is deprecated. Use the constructor without restrictionTypes and set RestrictionType property separately.", true)]
+        public CommandParameterAttribute(string name, string description, params Type[] restrictionTypes)
+        {
+            Name = name;
+            Description = description;
+
+            if (restrictionTypes.Length > 0)
+                RestrictionType = restrictionTypes[0];
+
             InitRestriction();
         }
 

LabExtended/Commands/CommandBase.cs

@@ -2,19 +2,17 @@
 
 using LabApi.Features.Enums;
 
+using LabExtended.Commands.Tokens;
+using LabExtended.Commands.Utilities;
 using LabExtended.Commands.Interfaces;
 using LabExtended.Commands.Parameters;
 
 using LabExtended.API;
-using LabExtended.Commands.Tokens;
-using LabExtended.Commands.Utilities;
-using LabExtended.Extensions;
 using LabExtended.Utilities;
+using LabExtended.Extensions;
 
 using NorthwoodLib.Pools;
 
-#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
-
 namespace LabExtended.Commands;
 
 /// <summary>
@@ -62,66 +60,63 @@ public class CommandBase
     /// </summary>
     public string Line => Context.Line;
 
+    /// <summary>
+    /// Gets the dictionary of the overload that is currently being initialized.
+    /// </summary>
+    public Dictionary<string, CommandParameterBuilder> Parameters { get; } = new();
+
     /// <summary>
     /// Gets or sets the context's response.
     /// </summary>
     public CommandResponse? Response
     {
         get => Context.Response;
-        set => Context.Response = value;
+        set => Context.Response = value!;
     }
 
-    /// <summary>
-    /// Called when an overload is called for the first time.
-    /// <remarks><b><paramref name="overloadName"/> will be null if the default overload is being initialized!</b></remarks>
-    /// </summary>
-    /// <param name="overloadName">Name of the overload that is being initialized.</param>
-    /// <param name="parameters">The overload's parameters.</param>
-    public virtual void OnInitializeOverload(string? overloadName, Dictionary<string, CommandParameterBuilder> parameters) { }
-
     /// <summary>
     /// Responds to the command.
     /// </summary>
     /// <param name="content">The message to respond with.</param>
     /// <param name="isSuccess">Whether or not the command was successfully executed.</param>
     public void Respond(object content, bool isSuccess = true)
-        => Response = new(isSuccess, false, false, null, content.ToString());
+        => Response = new(isSuccess, false, false, null!, content.ToString());
 
     /// <summary>
     /// Responds to the command.
     /// </summary>
     /// <param name="contentBuilder">Delegate used to build the command's response.</param>
     /// <param name="isSuccess">Whether or not the command was successfully executed.</param>
     public void Respond(Action<StringBuilder> contentBuilder, bool isSuccess = true)
-        => Response = new(isSuccess, false, false, null, StringBuilderPool.Shared.BuildString(contentBuilder));
+        => Response = new(isSuccess, false, false, null!, StringBuilderPool.Shared.BuildString(contentBuilder));
 
     /// <summary>
     /// Responds to the command with a success.
     /// </summary>
     /// <param name="content">The message to respond with.</param>
     public void Ok(object content)
-        => Response = new(true, false, false, null, content.ToString());
+        => Response = new(true, false, false, null!, content.ToString());
 
     /// <summary>
     /// Responds to the command with a success.
     /// </summary>
     /// <param name="contentBuilder">The delegate used to build the command's response.</param>
     public void Ok(Action<StringBuilder> contentBuilder)
-        => Response = new(true, false, false, null, StringBuilderPool.Shared.BuildString(contentBuilder));
+        => Response = new(true, false, false, null!, StringBuilderPool.Shared.BuildString(contentBuilder));
 
     /// <summary>
     /// Responds to the command with a failure.
     /// </summary>
     /// <param name="content">The message to respond with.</param>
     public void Fail(object content)
-        => Response = new(false, false, false, null, content.ToString());
+        => Response = new(false, false, false, null!, content.ToString());
 
     /// <summary>
     /// Responds to the command with a failure.
     /// </summary>
     /// <param name="contentBuilder">The delegate used to build the command's response.</param>
     public void Fail(Action<StringBuilder> contentBuilder)
-        => Response = new(false, false, false, null, StringBuilderPool.Shared.BuildString(contentBuilder));
+        => Response = new(false, false, false, null!, StringBuilderPool.Shared.BuildString(contentBuilder));
 
     /// <summary>
     /// Responds to the command with an input request.
@@ -155,7 +150,7 @@ void OnInput(string result)
             var argList = ListPool<string>.Shared.Rent();
 
             var ctx = new CommandContext();
-            var parameter = new CommandParameter(typeof(T), string.Empty, string.Empty, null, false);
+            var parameter = new CommandParameter(typeof(T), string.Empty, string.Empty, null!, false);
 
             ctx.Args = argList;
             ctx.Line = result;
@@ -181,7 +176,7 @@ void OnInput(string result)
                 return;
             }
 
-            onInput?.InvokeSafe((T)parsed.Value);
+            onInput?.InvokeSafe((T)parsed.Value!);
 
             ListPool<string>.Shared.Return(argList);
             ListPool<ICommandToken>.Shared.Return(list);
@@ -219,17 +214,14 @@ public void Write(Action<StringBuilder> contentBuilder, bool success = true)
     /// <param name="content">The content of the message.</param>
     /// <param name="success">Whether or not to show the message as successful.</param>
     public void WriteThread(object content, bool success = true)
-    {
-        ThreadUtils.RunOnMainThread(() => Write(content, success));
-    }
+        => ThreadUtils.RunOnMainThread(() => Write(content, success));
+
 
     /// <summary>
     /// Writes a message into the sender's console (you should use this method if you want to respond from another thread).
     /// </summary>
     /// <param name="contentBuilder">The delegate used to build the message.</param>
     /// <param name="success">Whether or not to show the message as successful.</param>
     public void WriteThread(Action<StringBuilder> contentBuilder, bool success = true)
-    {
-        ThreadUtils.RunOnMainThread(() => Write(contentBuilder, success));
-    }
+        => ThreadUtils.RunOnMainThread(() => Write(contentBuilder, success));
 }

LabExtended/Commands/CommandData.cs

@@ -50,7 +50,7 @@ public class CommandData
     /// <summary>
     /// Gets the command's overloads.
     /// </summary>
-    public Dictionary<string, CommandOverload> Overloads { get; } = new();
+    public List<CommandOverload> Overloads { get; } = new();
 
     /// <summary>
     /// Gets the constructor of the command's type.