More descriptions added

Exiled.CustomModules/API/Features/CustomAbilities/Settings/AbilitySettings.cs

@@ -9,6 +9,7 @@ namespace Exiled.CustomModules.API.Features.CustomAbilities.Settings
 {
     using Exiled.API.Features.Core;
     using Exiled.API.Features.Core.Interfaces;
+    using YamlDotNet.Serialization;
 
     /// <summary>
     /// Represents the base class for player-specific ability behaviors.
@@ -18,6 +19,7 @@ public class AbilitySettings : TypeCastObject<AbilitySettings>, IAdditivePropert
         /// <summary>
         /// Gets the default <see cref="AbilitySettings"/> values.
         /// </summary>
+        [YamlIgnore]
         public static AbilitySettings Default { get; } = new();
     }
 }

Exiled.CustomModules/API/Features/CustomAbilities/Settings/ActiveAbilitySettings.cs

@@ -7,6 +7,8 @@
 
 namespace Exiled.CustomModules.API.Features.CustomAbilities.Settings
 {
+    using System.ComponentModel;
+
     using Exiled.API.Features;
 
     /// <summary>
@@ -17,51 +19,61 @@ public class ActiveAbilitySettings : AbilitySettings
         /// <summary>
         /// Gets or sets a value indicating whether <see cref="AbilityInputComponent"/> should be used with this ability.
         /// </summary>
+        [Description("Indicates whether the AbilityInputComponent should be used with this ability.")]
         public virtual bool UseAbilityInputComponent { get; set; }
 
         /// <summary>
         /// Gets or sets the required cooldown before using the ability again.
         /// </summary>
+        [Description("The required cooldown time in seconds before the ability can be used again.")]
         public virtual float Cooldown { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the cooldown should be forced when the ability is added, making it already usable.
         /// </summary>
+        [Description("Indicates whether the cooldown should be forced when the ability is added, making it immediately usable.")]
         public virtual bool ForceCooldownOnAdded { get; set; }
 
         /// <summary>
         /// Gets or sets the time to wait before the ability is activated.
         /// </summary>
+        [Description("The time to wait before the ability is activated.")]
         public virtual float WindupTime { get; set; }
 
         /// <summary>
         /// Gets or sets the duration of the ability.
         /// </summary>
+        [Description("The duration of the ability's effect.")]
         public virtual float Duration { get; set; }
 
         /// <summary>
         /// Gets or sets the message to display when the ability is used.
         /// </summary>
+        [Description("The message to display when the ability is activated.")]
         public virtual TextDisplay Activated { get; set; }
 
         /// <summary>
-        /// Gets or sets the message to display when the ability activation is denied regardless any conditions.
+        /// Gets or sets the message to display when the ability activation is denied regardless of any conditions.
         /// </summary>
+        [Description("The message to display when the ability activation is denied regardless of any conditions.")]
         public virtual TextDisplay CannotBeUsed { get; set; }
 
         /// <summary>
-        /// Gets or sets the message to display when the ability activation in on cooldown.
+        /// Gets or sets the message to display when the ability activation is on cooldown.
         /// </summary>
+        [Description("The message to display when the ability is on cooldown.")]
         public virtual TextDisplay OnCooldown { get; set; }
 
         /// <summary>
         /// Gets or sets the message to display when the ability is expired.
         /// </summary>
+        [Description("The message to display when the ability is expired.")]
         public virtual TextDisplay Expired { get; set; }
 
         /// <summary>
         /// Gets or sets the message to display when the ability is ready.
         /// </summary>
+        [Description("The message to display when the ability is ready for use.")]
         public virtual TextDisplay OnReady { get; set; }
     }
 }

Exiled.CustomModules/API/Features/CustomAbilities/Settings/LevelAbilitySettings.cs

@@ -7,6 +7,8 @@
 
 namespace Exiled.CustomModules.API.Features.CustomAbilities.Settings
 {
+    using System.ComponentModel;
+
     using Exiled.API.Features;
 
     /// <summary>
@@ -17,26 +19,33 @@ public class LevelAbilitySettings : ActiveAbilitySettings
         /// <summary>
         /// Gets or sets the default level the ability should start from.
         /// </summary>
+        [Description("The default level at which the ability starts.")]
         public virtual byte DefaultLevel { get; set; }
 
         /// <summary>
-        /// Gets or sets the maxiumum level the ability cannot exceed.
+        /// Gets or sets the maximum level the ability cannot exceed.
         /// </summary>
+        [Description("The highest level that the ability can reach.")]
         public virtual byte MaxLevel { get; set; }
 
         /// <summary>
         /// Gets or sets the message to display when the ability returns to a previous level.
         /// </summary>
+        [Description("The message shown when the ability reverts to a previous level.")]
         public virtual TextDisplay PreviousLevel { get; set; }
 
         /// <summary>
         /// Gets or sets the message to display when the ability reaches a new level.
         /// </summary>
+        [Description("The message shown when the ability advances to a new level.")]
         public virtual TextDisplay NextLevel { get; set; }
 
         /// <summary>
-        /// Gets or sets the message to display when the ability reached the maximum level.
+        /// Gets or sets the message to display when the ability has reached the maximum level.
         /// </summary>
+        [Description("The message shown when the ability reaches its maximum level.")]
         public virtual TextDisplay MaxLevelReached { get; set; }
+
+
     }
 }

Exiled.CustomModules/API/Features/CustomAbilities/Settings/UnlockableAbilitySettings.cs

@@ -7,6 +7,8 @@
 
 namespace Exiled.CustomModules.API.Features.CustomAbilities.Settings
 {
+    using System.ComponentModel;
+
     using Exiled.API.Features;
 
     /// <summary>
@@ -17,6 +19,7 @@ public class UnlockableAbilitySettings : LevelAbilitySettings
         /// <summary>
         /// Gets or sets the message to display when the ability is unlocked.
         /// </summary>
+        [Description("The message to display when the ability is unlocked.")]
         public virtual TextDisplay Unlocked { get; set; }
     }
 }

Exiled.CustomModules/API/Features/CustomGamemodes/GameModeSettings.cs

@@ -7,6 +7,8 @@
 
 namespace Exiled.CustomModules.API.Features.CustomGameModes
 {
+    using System.ComponentModel;
+
     using Exiled.API.Enums;
     using Exiled.API.Features.Core;
     using Exiled.API.Features.Core.Interfaces;
@@ -27,6 +29,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// The game mode will start automatically if the specified probability condition is met and the minimum player requirement (<see cref="MinimumPlayers"/>) is satisfied.
         /// </remarks>
+        [Description("Indicates whether the game mode operates automatically, managed by the World.")]
         public virtual bool Automatic { get; set; }
 
         /// <summary>
@@ -37,98 +40,117 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// If the specified probability condition is met and the minimum player requirement (<see cref="MinimumPlayers"/>) is satisfied, the game mode will activate automatically.
         /// </remarks>
+        [Description("The probability condition for automatic activation of the game mode.")]
         public virtual float AutomaticProbability { get; set; }
 
         /// <summary>
         /// Gets or sets the minimum amount of players to start the game mode.
         /// </summary>
+        [Description("The minimum number of players required to start the game mode.")]
         public virtual uint MinimumPlayers { get; set; }
 
         /// <summary>
         /// Gets or sets the maximum allowed amount of players managed by the game mode.
         /// </summary>
+        [Description("The maximum number of players that the game mode can manage.")]
         public virtual uint MaximumPlayers { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the exceeding players should be rejected.
         /// </summary>
+        [Description("Indicates whether players exceeding the maximum allowed number should be rejected.")]
         public virtual bool RejectExceedingPlayers { get; set; }
 
         /// <summary>
         /// Gets or sets the message to be displayed when a player is rejected due to exceeding amount of players.
         /// </summary>
+        [Description("The message displayed when a player is rejected due to exceeding the allowed player count.")]
         public virtual string RejectExceedingMessage { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the players can respawn.
         /// </summary>
+        [Description("Indicates whether players are allowed to respawn.")]
         public virtual bool IsRespawnEnabled { get; set; }
 
         /// <summary>
         /// Gets or sets the respawn time for individual players.
         /// </summary>
+        [Description("The respawn time for individual players.")]
         public virtual float RespawnTime { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether teams can regularly respawn.
         /// </summary>
+        [Description("Indicates whether teams are allowed to respawn regularly.")]
         public virtual bool IsTeamRespawnEnabled { get; set; }
 
         /// <summary>
         /// Gets or sets the respawn time for individual teams.
         /// </summary>
+        [Description("The respawn time for individual teams.")]
         public virtual int TeamRespawnTime { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether custom ending conditions should be used over predefined conditions.
         /// </summary>
+        [Description("Indicates whether custom ending conditions should override predefined conditions.")]
         public virtual bool UseCustomEndingConditions { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether server should be restarted when the game mode ends.
+        /// Gets or sets a value indicating whether the server should be restarted when the game mode ends.
         /// </summary>
+        [Description("Indicates whether the server should be restarted when the game mode ends.")]
         public virtual bool RestartRoundOnEnd { get; set; }
 
         /// <summary>
         /// Gets or sets the amount of time to await before restarting the server.
         /// </summary>
+        [Description("The time to wait before restarting the server.")]
         public virtual float RestartWindupTime { get; set; }
 
         /// <summary>
         /// Gets or sets a <see cref="ZoneType"/>[] containing all zones that should be permanently locked.
         /// </summary>
+        [Description("An array of zones that should be permanently locked.")]
         public virtual ZoneType[] LockedZones { get; set; }
 
         /// <summary>
         /// Gets or sets a <see cref="DoorType"/>[] containing all doors that should be permanently locked.
         /// </summary>
+        [Description("An array of doors that should be permanently locked.")]
         public virtual DoorType[] LockedDoors { get; set; }
 
         /// <summary>
         /// Gets or sets a <see cref="ElevatorType"/>[] containing all elevators that should be permanently locked.
         /// </summary>
+        [Description("An array of elevators that should be permanently locked.")]
         public virtual ElevatorType[] LockedElevators { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the decontamination should be enabled.
         /// </summary>
+        [Description("Indicates whether decontamination should be enabled.")]
         public virtual bool IsDecontaminationEnabled { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the Alpha Warhead is enabled.
         /// </summary>
+        [Description("Indicates whether the Alpha Warhead is enabled.")]
         public virtual bool IsWarheadEnabled { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the Alpha Warhead interactions are allowed.
         /// </summary>
+        [Description("Indicates whether interactions with the Alpha Warhead are allowed.")]
         public virtual bool IsWarheadInteractable { get; set; }
 
         /// <summary>
         /// Gets or sets the amount of time, expressed in seconds, after which the Alpha Warhead will be automatically started.
         /// <para/>
         /// <see cref="IsWarheadEnabled"/> must be set to <see langword="true"/>.
         /// </summary>
+        [Description("The time in seconds after which the Alpha Warhead will automatically start, if enabled.")]
         public virtual float AutoWarheadTime { get; set; }
 
         /// <summary>
@@ -138,6 +160,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="NonSpawnableRoles"/>.
         /// </summary>
+        [Description("An array of spawnable roles. If specified, only these roles can spawn.")]
         public virtual RoleTypeId[] SpawnableRoles { get; set; }
 
         /// <summary>
@@ -147,6 +170,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="NonSpawnableCustomRoles"/>.
         /// </summary>
+        [Description("An array of spawnable custom roles. If specified, only these custom roles can spawn.")]
         public virtual uint[] SpawnableCustomRoles { get; set; }
 
         /// <summary>
@@ -156,6 +180,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="NonSpawnableTeams"/>.
         /// </summary>
+        [Description("An array of spawnable teams. If specified, only these teams can spawn.")]
         public virtual SpawnableTeamType[] SpawnableTeams { get; set; }
 
         /// <summary>
@@ -165,6 +190,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="NonSpawnableCustomTeams"/>.
         /// </summary>
+        [Description("An array of spawnable custom teams. If specified, only these custom teams can spawn.")]
         public virtual uint[] SpawnableCustomTeams { get; set; }
 
         /// <summary>
@@ -174,6 +200,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="SpawnableRoles"/>.
         /// </summary>
+        [Description("An array of non-spawnable roles. If specified, these roles cannot spawn.")]
         public virtual RoleTypeId[] NonSpawnableRoles { get; set; }
 
         /// <summary>
@@ -183,6 +210,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="SpawnableCustomRoles"/>.
         /// </summary>
+        [Description("An array of non-spawnable custom roles. If specified, these custom roles cannot spawn.")]
         public virtual uint[] NonSpawnableCustomRoles { get; set; }
 
         /// <summary>
@@ -192,6 +220,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="SpawnableTeams"/>.
         /// </summary>
+        [Description("An array of non-spawnable custom teams. If specified, these custom teams cannot spawn.")]
         public virtual SpawnableTeamType[] NonSpawnableTeams { get; set; }
 
         /// <summary>
@@ -201,6 +230,7 @@ public class GameModeSettings : TypeCastObject<GameModeSettings>, IAdditivePrope
         /// <br/>
         /// It's highly recommended to not use it along with <see cref="SpawnableCustomTeams"/>.
         /// </summary>
+        [Description("An array of non-spawnable custom teams. If specified, these custom teams cannot spawn.")]
         public virtual uint[] NonSpawnableCustomTeams { get; set; }
     }
 }

Exiled.CustomModules/API/Features/CustomGamemodes/GameState.cs

@@ -11,15 +11,13 @@ namespace Exiled.CustomModules.API.Features.CustomGameModes
     using System.Collections.Generic;
     using System.Diagnostics;
     using System.Linq;
-    using System.Reflection;
 
     using Exiled.API.Extensions;
     using Exiled.API.Features;
     using Exiled.API.Features.Core;
     using Exiled.API.Features.Core.Interfaces;
     using Exiled.API.Features.Doors;
     using Exiled.API.Features.Roles;
-    using Exiled.API.Interfaces;
     using Exiled.CustomModules.API.Enums;
     using Exiled.CustomModules.API.Features.CustomRoles;
     using Exiled.CustomModules.API.Features.Generic;