make descriptions of methods not nullable for reference resolving

Author: Elektryk-Andrzej

Code/MethodSystem/MethodDescriptors/IReferenceResolvingMethod.cs

@@ -1,9 +1,17 @@
-namespace SER.Code.MethodSystem.MethodDescriptors;
+using SER.Code.Helpers.Extensions;
+using SER.Code.MethodSystem.BaseMethods;
+
+namespace SER.Code.MethodSystem.MethodDescriptors;
 
 /// <summary>
 /// A method which takes a reference as an input and returns information about it in a readable format.
 /// </summary>
 public interface IReferenceResolvingMethod
 {
     public Type ReferenceType { get; }
+
+    public static class Desc
+    {
+        public static string Get(IReferenceResolvingMethod method) => $"Extracts information from {method.ReferenceType.AccurateName} objects.";
+    }
 }

Code/MethodSystem/Methods/DoorMethods/DoorInfoMethod.cs

@@ -18,7 +18,7 @@ public class DoorInfoMethod : LiteralValueReturningMethod, IReferenceResolvingMe
     public Type ReferenceType => typeof(Door);
     public override Type[] LiteralReturnTypes => [typeof(TextValue), typeof(BoolValue), typeof(NumberValue)];
 
-    public override string Description => null!;
+    public override string Description => IReferenceResolvingMethod.Desc.Get(this);
 
     public override Argument[] ExpectedArguments { get; } =
     [

Code/MethodSystem/Methods/HealthMethods/DamageInfoMethod.cs

@@ -15,9 +15,14 @@ namespace SER.Code.MethodSystem.Methods.HealthMethods;
 public class DamageInfoMethod : ReturningMethod, IReferenceResolvingMethod, IAdditionalDescription
 {
     public Type ReferenceType => typeof(DamageHandlerBase);
+    
     public override Type[] ReturnTypes => [typeof(TextValue), typeof(ReferenceValue)];
 
-    public override string Description => null!;
+    public override string Description => IReferenceResolvingMethod.Desc.Get(this);
+
+    public string AdditionalDescription =>
+        "A lot of options here might not be available depending on which DamageHandler is used in game. " +
+        "It's advised you check every accessed value for 'none' before using it.";
 
     public override Argument[] ExpectedArguments { get; } =
     [
@@ -45,8 +50,4 @@ public override void Execute()
             _ => throw new AndrzejFuckedUpException("out of range")
         };
     }
-
-    public string AdditionalDescription =>
-        "A lot of options here might not be available depending on which DamageHandler is used in game. " +
-        "It's advised you check every accessed value for 'none' before using it.";
 }

Code/MethodSystem/Methods/ItemMethods/ItemInfoMethod.cs

@@ -13,7 +13,7 @@ namespace SER.Code.MethodSystem.Methods.ItemMethods;
 [UsedImplicitly]
 public class ItemInfoMethod : ReturningMethod, IReferenceResolvingMethod
 {
-    public override string Description => null!;
+    public override string Description => IReferenceResolvingMethod.Desc.Get(this);
 
     public override Type[] ReturnTypes => [typeof(TextValue), typeof(PlayerValue), typeof(BoolValue)];
     public Type ReferenceType => typeof(Item);

Code/MethodSystem/Methods/RespawnMethods/RespawnWaveInfoMethod.cs

@@ -18,7 +18,7 @@ public class RespawnWaveInfoMethod : LiteralValueReturningMethod, IReferenceReso
 
     public override Type[] LiteralReturnTypes => [typeof(NumberValue), typeof(TextValue)];
 
-    public override string Description => null!;
+    public override string Description => IReferenceResolvingMethod.Desc.Get(this);
 
     public override Argument[] ExpectedArguments { get; } =
     [

Code/MethodSystem/Methods/RoleMethods/RoleInfoMethod.cs

@@ -15,7 +15,7 @@ public class RoleInfoMethod : ReturningMethod<TextValue>, IReferenceResolvingMet
 {
     public Type ReferenceType => typeof(PlayerRoleBase);
 
-    public override string Description => null!;
+    public override string Description => IReferenceResolvingMethod.Desc.Get(this);
 
     public override Argument[] ExpectedArguments { get; } =
     [

Code/Plugin/Commands/HelpSystem/HelpCommand.cs

@@ -478,14 +478,8 @@ private static string GetVariableList()
     private static string GetMethodHelp(Method method)
     {
         var sb = new StringBuilder($"=== {method.Name} ===\n");
-        if (method is IReferenceResolvingMethod refRes && method.Description is null)
-        {
-            sb.AppendLine($"> Extracts information from {refRes.ReferenceType.Name} objects.");
-        }
-        else
-        {
-            sb.AppendLine($"> {method.Description}");
-        }
+
+        sb.AppendLine($"> {method.Description}");
 
         if (method is IAdditionalDescription addDesc)
         {