update the default value system for methiods

Author: Elektryk-Andrzej

ArgumentSystem/Arguments/PlayersArgument.cs

@@ -1,5 +1,4 @@
-using System.Collections.Generic;
-using System.Linq;
+using System.Linq;
 using JetBrains.Annotations;
 using LabApi.Features.Wrappers;
 using SER.ArgumentSystem.BaseArguments;
@@ -17,19 +16,19 @@ public class PlayersArgument(string name) : Argument(name)
     public override string InputDescription => $"Player variable e.g. {PlayerVariableToken.Example} or * for every player";
 
     [UsedImplicitly]
-    public DynamicTryGet<List<Player>> GetConvertSolution(BaseToken token)
+    public DynamicTryGet<Player[]> GetConvertSolution(BaseToken token)
     {
         if (token is SymbolToken { IsJoker: true })
         {
-            return new(() => Player.ReadyList.ToList());
+            return new(() => Player.ReadyList.ToArray());
         }
 
         if (token is not IValueToken valToken || !valToken.CanReturn<PlayerValue>(out var get))
         {
             return $"Value '{token.RawRep}' does not represent a valid player variable.";
         }
 
-        return new(() => get().OnSuccess(v => v.Players.ToList()));
+        return new(() => get().OnSuccess(v => v.Players));
     }
 }
 

ArgumentSystem/BaseArguments/Argument.cs

@@ -17,22 +17,14 @@ public abstract class Argument(string name)
     /// The short description of the argument. Use IAdditionalDescription to add more if needed.
     /// </summary>
     public string? Description { get; init; } = null;
-    
-    public bool IsOptional { get; private set; } = false;
+
+    public record Default(object? Value, string? StringRep);
 
     /// <summary>
     /// Sets the default value for this argument, allowing it to be skipped by the user.
     /// Null values are allowed, the method must handle it accordingly.
     /// </summary>
-    public object? DefaultValue
-    {
-        get;
-        init
-        {
-            IsOptional = true;
-            field = value;
-        }
-    }
+    public Default? DefaultValue;
 
     public abstract string InputDescription { get; }
 

ContextSystem/Contexts/MethodContext.cs

@@ -36,7 +36,7 @@ public override TryAddTokenRes TryAddToken(BaseToken token)
 
     public override Result VerifyCurrentState()
     {
-        return Result.Assert(_providedArguments >= Method.ExpectedArguments.Count(arg => !arg.IsOptional),
+        return Result.Assert(_providedArguments >= Method.ExpectedArguments.Count(arg => arg.DefaultValue is not null),
             $"Method '{Method.Name}' is missing required arguments: " +
             $"{", ".Join(Method.ExpectedArguments.Skip(_providedArguments).Select(arg => arg.Name))}");
     }

MethodSystem/Methods/CASSIEMethods/CassieMethod.cs

@@ -21,12 +21,12 @@ public class CassieMethod : SynchronousMethod
         new TextArgument("message"),
         new TextArgument("translation")
         {
-            DefaultValue = "",
+            DefaultValue = new("", "empty"),
         },
         new BoolArgument("should glitch")
         {
             Description = "If true, SER will add random glitch effects to the announcement.",
-            DefaultValue = false,
+            DefaultValue = new(false, null),
         }
     ];
 

MethodSystem/Methods/DoorMethods/BreakDoorMethod.cs

@@ -19,7 +19,7 @@ internal class BreakDoorMethod : SynchronousMethod
         },
         new EnumArgument<DoorDamageType>("damage type")
         {
-            DefaultValue = DoorDamageType.ServerCommand,
+            DefaultValue = new(DoorDamageType.ServerCommand, null),
             Description = "Type of damage to be applied on doors"
         }
     ];

MethodSystem/Methods/DoorMethods/LockDoorMethod.cs

@@ -14,7 +14,7 @@ public class LockDoorMethod : SynchronousMethod
         new DoorsArgument("doors"),
         new EnumArgument<DoorLockReason>("lock")
         {
-            DefaultValue = DoorLockReason.AdminCommand
+            DefaultValue = new(DoorLockReason.AdminCommand, null)
         }
     ];
 

MethodSystem/Methods/HealthMethods/DamageMethod.cs

@@ -14,7 +14,7 @@ public class DamageMethod : SynchronousMethod
         new FloatArgument("amount", 0),
         new TextArgument("reason")
         {
-            DefaultValue = string.Empty
+            DefaultValue = new(string.Empty, "empty")
         }
     ];
 

MethodSystem/Methods/HealthMethods/HealMethod.cs

@@ -13,7 +13,7 @@ public class HealMethod : SynchronousMethod
         new PlayersArgument("players to heal"),
         new FloatArgument("amount", 0)
         {
-            DefaultValue = float.MaxValue,
+            DefaultValue = new(float.MaxValue, "max amount"),
             Description = "If this argument is not provided, all players will be fully healed."
         }  
     ];

MethodSystem/Methods/HealthMethods/KillMethod.cs

@@ -13,7 +13,7 @@ public class KillMethod : SynchronousMethod
         new PlayersArgument("players"),
         new TextArgument("reason")
         {
-            DefaultValue = string.Empty,
+            DefaultValue = new(string.Empty, "empty"),
         }
     ];
 

MethodSystem/Methods/HealthMethods/SetAHPMethod.cs

@@ -20,27 +20,27 @@ public class SetAHPMethod : SynchronousMethod
         },
         new FloatArgument("limit", 0)
         {
-            DefaultValue = 75,
+            DefaultValue = new(75, null),
             Description = "The upper limit of AHP."
         },
         new FloatArgument("decay", 0)
         {
-            DefaultValue = 1.2,
+            DefaultValue = new(1.2, null),
             Description = "How much AHP is lost per second."
         },
         new FloatArgument("efficacy", 0, 1)
         {
-            DefaultValue = 0.7,
+            DefaultValue = new(0.7, "70%"),
             Description = "The percent of incoming damage absorbed by AHP."
         },
         new DurationArgument("sustain")
         {
-            DefaultValue = TimeSpan.Zero,
+            DefaultValue = new(TimeSpan.Zero, "instant (0 seconds)"),
             Description = "The amount of time before the AHP begins to decay."
         },
         new BoolArgument("isPersistent")
         {
-            DefaultValue = false,
+            DefaultValue = new(false, null),
             Description = "Whether or not the AHP process stays after AHP reaches 0."
         }
     ];