feat: [😭] Firearm AmmoModules Api

EXILED/Exiled.API/Enums/RevolverChamberState.cs

@@ -0,0 +1,33 @@
+// -----------------------------------------------------------------------
+// <copyright file="RevolverChamberState.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Enums
+{
+    using Exiled.API.Features.Items.FirearmModules.Primary;
+
+    /// <summary>
+    /// States for chamber in revolver cylindric magazine.
+    /// </summary>
+    /// <seealso cref="CylinderMagazine"/>
+    public enum RevolverChamberState
+    {
+        /// <summary>
+        /// State for empty chamber.
+        /// </summary>
+        Empty,
+
+        /// <summary>
+        /// State for chamber with a bullet.
+        /// </summary>
+        Live,
+
+        /// <summary>
+        /// State for discharged chamber.
+        /// </summary>
+        Discharged,
+    }
+}

EXILED/Exiled.API/Features/Items/Firearm.cs

@@ -13,6 +13,10 @@ namespace Exiled.API.Features.Items
 
     using CameraShaking;
     using Enums;
+
+    using Exiled.API.Features.Items.FirearmModules;
+    using Exiled.API.Features.Items.FirearmModules.Barrel;
+    using Exiled.API.Features.Items.FirearmModules.Primary;
     using Exiled.API.Features.Pickups;
     using Exiled.API.Interfaces;
     using Exiled.API.Structs;
@@ -55,6 +59,20 @@ public Firearm(BaseFirearm itemBase)
             : base(itemBase)
         {
             Base = itemBase;
+
+            foreach (ModuleBase module in Base.Modules)
+            {
+                if (module is IPrimaryAmmoContainerModule primaryAmmoModule)
+                {
+                    PrimaryMagazine ??= (PrimaryMagazine)Magazine.Get(primaryAmmoModule);
+                    continue;
+                }
+
+                if (module is IAmmoContainerModule ammoModule)
+                {
+                    BarrelMagazine ??= (BarrelMagazine)Magazine.Get(ammoModule);
+                }
+            }
         }
 
         /// <summary>
@@ -105,24 +123,97 @@ public static IReadOnlyDictionary<Player, Dictionary<FirearmType, AttachmentIden
         public new BaseFirearm Base { get; }
 
         /// <summary>
-        /// Gets or sets the amount of ammo in the firearm.
+        /// Gets a primaty magazine for current firearm.
+        /// </summary>
+        public PrimaryMagazine PrimaryMagazine { get; }
+
+        /// <summary>
+        /// Gets a barrel magazine for current firearm.
+        /// </summary>
+        /// <remarks>
+        /// <see langword="null"/> for Revolver and ParticleDisruptor.
+        /// </remarks>
+        public BarrelMagazine BarrelMagazine { get; }
+
+        /// <summary>
+        /// Gets or sets the amount of ammo in the firearm magazine.
+        /// </summary>
+        public int MagazineAmmo
+        {
+            get => PrimaryMagazine.Ammo;
+            set => PrimaryMagazine.Ammo = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the amount of ammo in the firearm barrel.
         /// </summary>
-        public int Ammo
+        /// <remarks>
+        /// not working for Revolver and ParticleDisruptor.
+        /// </remarks>
+        public int BarrelAmmo
         {
-            get => (Base.Modules[Array.IndexOf(Base.Modules, typeof(MagazineModule))] as MagazineModule).AmmoStored;
-            set => (Base.Modules[Array.IndexOf(Base.Modules, typeof(MagazineModule))] as MagazineModule).AmmoStored = value;
+            get
+            {
+                return BarrelMagazine?.Ammo ?? 0;
+            }
+
+            set
+            {
+                if (BarrelMagazine != null)
+                    BarrelMagazine.Ammo = value;
+            }
         }
 
+        /// <summary>
+        /// Gets the total amount of ammo in the firearm.
+        /// </summary>
+        public int TotalAmmo =>
+            Base.GetTotalStoredAmmo();
+
         /// <summary>
         /// Gets or sets the max ammo for this firearm.
         /// </summary>
-        /// <remarks>Disruptor can't be used for MaxAmmo.</remarks>
-        public int MaxAmmo
+        public int MaxMagazineAmmo
+        {
+            get => PrimaryMagazine.MaxAmmo;
+            set => PrimaryMagazine.MaxAmmo = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the amount of max ammo in the firearm barrel.
+        /// </summary>
+        /// <remarks>
+        /// not working for Revolver and ParticleDisruptor.
+        /// </remarks>
+        public int MaxBarrelAmmo
         {
-            get => (Base.Modules[Array.IndexOf(Base.Modules, typeof(MagazineModule))] as MagazineModule).AmmoMax;
-            set => (Base.Modules[Array.IndexOf(Base.Modules, typeof(MagazineModule))] as MagazineModule)._defaultCapacity = value; // Synced?
+            get
+            {
+                return BarrelMagazine?.MaxAmmo ?? 0;
+            }
+
+            set
+            {
+                if (BarrelMagazine != null)
+                    BarrelMagazine.MaxAmmo = value;
+            }
         }
 
+        /// <summary>
+        /// Gets the total amount of ammo in the firearm.
+        /// </summary>
+        public int TotalMaxAmmo =>
+            Base.GetTotalMaxAmmo();
+
+        /// <summary>
+        /// Gets or sets a ammo drain per shoot.
+        /// </summary>
+        /// <remarks>
+        /// Always <see langword="1"/> by default.
+        /// Applied on a high layer nether basegame ammo controllers.
+        /// </remarks>
+        public int AmmoDrain { get; set; } = 2;
+
         /// <summary>
         /// Gets the <see cref="Enums.FirearmType"/> of the firearm.
         /// </summary>
@@ -602,20 +693,10 @@ public void ClearPreferences()
         /// <param name="emptyMagazine">Whether empty magazine should be loaded.</param>
         public void Reload(bool emptyMagazine = false)
         {
-            MagazineModule magazineModule = Base.Modules.OfType<MagazineModule>().FirstOrDefault();
-
-            if (magazineModule == null)
-                return;
-
-            magazineModule.ServerRemoveMagazine();
-
-            Timing.CallDelayed(0.1f, () =>
+            if (Base.TryGetModule(out AnimatorReloaderModuleBase module))
             {
-                if (emptyMagazine)
-                    magazineModule.ServerInsertEmptyMagazine();
-                else
-                    magazineModule.ServerInsertMagazine();
-            });
+                module.StartReloading();
+            }
         }
 
         /// <summary>
@@ -626,7 +707,6 @@ public override Item Clone()
         {
             Firearm cloneableItem = new(Type)
             {
-                Ammo = Ammo,
             };
 
             // TODO Not finish
@@ -651,6 +731,10 @@ internal override void ChangeOwner(Player oldOwner, Player newOwner)
         {
             Base.Owner = newOwner.ReferenceHub;
             Base._footprintCacheSet = false;
+            foreach (ModuleBase module in Base.Modules)
+            {
+                module.OnAdded();
+            }
         }
 
         /// <inheritdoc/>

EXILED/Exiled.API/Features/Items/FirearmModules/Barrel/AutomaticBarrelMagazine.cs

@@ -0,0 +1,121 @@
+// -----------------------------------------------------------------------
+// <copyright file="AutomaticBarrelMagazine.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Items.FirearmModules.Barrel
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Text;
+    using System.Threading.Tasks;
+
+    using InventorySystem.Items.Firearms.Modules;
+
+    using UnityEngine;
+
+    /// <summary>
+    /// Basic realization of <see cref="AutomaticActionModule"/> barrel.
+    /// </summary>
+    public class AutomaticBarrelMagazine : BarrelMagazine
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AutomaticBarrelMagazine"/> class.
+        /// </summary>
+        /// <param name="automaticModule">Target <see cref="AutomaticActionModule"/>.</param>
+        public AutomaticBarrelMagazine(AutomaticActionModule automaticModule)
+            : base(automaticModule)
+        {
+            AutomaticBarrel = automaticModule;
+            Firearm = (Firearm)Item.Get(AutomaticBarrel.Firearm);
+        }
+
+        /// <summary>
+        /// Gets an original <see cref="IAmmoContainerModule"/>.
+        /// </summary>
+        public AutomaticActionModule AutomaticBarrel { get; }
+
+        /// <inheritdoc/>
+        public override Firearm Firearm { get; }
+
+        /// <inheritdoc/>
+        public override int Ammo
+        {
+            get
+            {
+                return AutomaticBarrel.AmmoStored;
+            }
+
+            set
+            {
+                AutomaticBarrel.AmmoStored = Mathf.Max(value, 0);
+
+                Resync();
+            }
+        }
+
+        /// <inheritdoc/>
+        /// <remarks>
+        /// Will be ranged between <see langword="0"/> and <see langword="16"/> due basegame logic.
+        /// </remarks>
+        public override int MaxAmmo
+        {
+            get
+            {
+                return AutomaticBarrel.ChamberSize;
+            }
+
+            set
+            {
+                AutomaticBarrel.ChamberSize = Mathf.Clamp(value, 0, 16);
+            }
+        }
+
+        /// <inheritdoc/>
+        public override bool IsCocked
+        {
+            get
+            {
+                return AutomaticBarrel.Cocked;
+            }
+
+            set
+            {
+                AutomaticBarrel.Cocked = value;
+                Resync();
+            }
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether barrel magazine has open bolt or not.
+        /// </summary>
+        public bool IsOpenBolted =>
+            AutomaticBarrel.OpenBolt;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether barrel bolt is currently locked.
+        /// </summary>
+        public bool BoltLocked
+        {
+            get
+            {
+                return AutomaticBarrel.BoltLocked;
+            }
+
+            set
+            {
+                AutomaticBarrel.BoltLocked = value;
+                Resync();
+            }
+        }
+
+        /// <inheritdoc/>
+        public override void Resync()
+        {
+            AutomaticBarrel.ServerResync();
+        }
+    }
+}

EXILED/Exiled.API/Features/Items/FirearmModules/Barrel/BarrelMagazine.cs

@@ -0,0 +1,31 @@
+// -----------------------------------------------------------------------
+// <copyright file="BarrelMagazine.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Items.FirearmModules.Barrel
+{
+    using InventorySystem.Items.Firearms.Modules;
+
+    /// <summary>
+    /// Basic abstraction of <see cref="IAmmoContainerModule"/> whose are logically used to be a barrels magazines.
+    /// </summary>
+    public abstract class BarrelMagazine : Magazine
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BarrelMagazine"/> class.
+        /// </summary>
+        /// <param name="module">target <see cref="IAmmoContainerModule"/>.</param>
+        public BarrelMagazine(IAmmoContainerModule module)
+            : base(module)
+        {
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether barrel is cocked.
+        /// </summary>
+        public abstract bool IsCocked { get; set; }
+    }
+}