Add summary and some fixes

SerbiaStrong-220 · Aug 14, 2024 · c767cda · c767cda
1 parent 84fab77
commit c767cda
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/Content.Client/SS220/Weapons/Ranged/Systems/BatteryWeaponFireModesSystem.cs b/Content.Client/SS220/Weapons/Ranged/Systems/BatteryWeaponFireModesSystem.cs
@@ -4,6 +4,7 @@
 using static Content.Shared.Weapons.Ranged.Systems.BatteryWeaponFireModesSystem;
 
 namespace Content.Client.SS220.Weapons.Ranged.Systems;
+
 public sealed partial class BatteryWeaponFireModesSystem : EntitySystem
 {
     [Dependency] private readonly GunSystem _gunSystem = default!;

diff --git a/Content.Shared/Weapons/Ranged/Components/BatteryWeaponFireModesComponent.cs b/Content.Shared/Weapons/Ranged/Components/BatteryWeaponFireModesComponent.cs
@@ -38,12 +38,21 @@ public sealed partial class BatteryWeaponFireMode
     public string Prototype = default!; //SS220 Add Multifaze gun
 
     //SS220 Add Multifaze gun begin
-    [DataField("fireModeName")]
+    /// <summary>
+    /// Name of the fire mode
+    /// </summary>
+    [DataField]
     public string? FireModeName;
 
+    /// <summary>
+    /// Sound of a gunshot that is used in the selected fire mode
+    /// </summary>
     [DataField]
     public string? SoundGunshot;
 
+    /// <summary>
+    /// Sprite of the remaining charge that is used in the selected fire mode
+    /// </summary>
     [DataField]
     public string? MagState;
     //SS220 Add Multifaze gun end

diff --git a/Content.Shared/Weapons/Ranged/Systems/BatteryWeaponFireModesSystem.cs b/Content.Shared/Weapons/Ranged/Systems/BatteryWeaponFireModesSystem.cs
@@ -6,7 +6,6 @@
 using Content.Shared.Verbs;
 using Content.Shared.Weapons.Ranged.Components;
 using Robust.Shared.Prototypes;
-using Robust.Shared.Serialization;
 using Robust.Shared.Timing;
 
 namespace Content.Shared.Weapons.Ranged.Systems;
@@ -207,6 +206,12 @@ private void OnInit(EntityUid uid, BatteryWeaponFireModesComponent component, re
         SetFireMode(uid, component, component.CurrentFireMode);
     }
 
+    /// <summary>
+    /// The event that rises when the fire mode is selected
+    /// </summary>
+    /// <param name="Uid"></param>
+    /// <param name="Component"></param>
+    /// <param name="Index"></param>
     [ByRefEvent]
     public record struct ChangeFireModeEvent(EntityUid Uid, BatteryWeaponFireModesComponent Component, int Index);
     //SS220 Add Multifaze gun end