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,94 @@ 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 => 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 => 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; } = 1;
+
+        /// <summary>
+        /// Gets a value indicating whether the weapon is reloading.
+        /// </summary>
+        public bool IsReloading => Base.TryGetModule(out IReloaderModule module) && module.IsReloading;
+
         /// <summary>
         /// Gets the <see cref="Enums.FirearmType"/> of the firearm.
         /// </summary>
@@ -131,12 +219,12 @@ public int MaxAmmo
         /// <summary>
         /// Gets the <see cref="Enums.AmmoType"/> of the firearm.
         /// </summary>
-        public AmmoType AmmoType => (Base.Modules.OfType<MagazineModule>().FirstOrDefault()?.AmmoType ?? ItemType.None).GetAmmoType();
+        public AmmoType AmmoType => PrimaryMagazine.AmmoType;
 
         /// <summary>
         /// Gets a value indicating whether the firearm is being aimed.
         /// </summary>
-        public bool Aiming => Base.Modules.OfType<LinearAdsModule>().FirstOrDefault()?.AdsTarget ?? false;
+        public bool Aiming => Base.TryGetModule(out LinearAdsModule module) && module.AdsTarget;
 
         /// <summary>
         /// Gets a value indicating whether the firearm's flashlight module is enabled.
@@ -156,7 +244,7 @@ public int MaxAmmo
         /// <summary>
         /// Gets a value indicating whether the firearm is automatic.
         /// </summary>
-        public bool IsAutomatic => Array.Exists(Base.Modules, x => x is AutomaticActionModule);
+        public bool IsAutomatic => BarrelMagazine is AutomaticBarrelMagazine;
 
         /// <summary>
         /// Gets the <see cref="Attachment"/>s of the firearm.
@@ -180,47 +268,21 @@ public IEnumerable<AttachmentIdentifier> AttachmentIdentifiers
         /// </summary>
         public uint BaseCode => BaseCodesValue[FirearmType];
 
-        /// <summary>
-        /// Gets or sets the fire rate of the firearm, if it is an automatic weapon.
-        /// </summary>
-        /// <remarks>This property will not do anything if the firearm is not an automatic weapon.</remarks>
-        /// <seealso cref="IsAutomatic"/>
-        public float FireRate
-        {
-            get => Base.Modules.OfType<AutomaticActionModule>().FirstOrDefault()?.BaseFireRate ?? 0f;
-            set
-            {
-                AutomaticActionModule module = Base.Modules.OfType<AutomaticActionModule>().FirstOrDefault();
-
-                if (module != null)
-                    module.BaseFireRate = value;
-            }
-        }
-
         /// <summary>
         /// Gets or sets the recoil settings of the firearm, if it's an automatic weapon.
         /// </summary>
         /// <remarks>This property will not do anything if the firearm is not an automatic weapon.</remarks>
         /// <seealso cref="IsAutomatic"/>
         public RecoilSettings Recoil
         {
-            get => Base.Modules.OfType<RecoilPatternModule>().FirstOrDefault()?.BaseRecoil ?? default;
+            get => Base.TryGetModule(out RecoilPatternModule module) ? module.BaseRecoil : default;
             set
             {
-                RecoilPatternModule module = Base.Modules.OfType<RecoilPatternModule>().FirstOrDefault();
-
-                if (module != null)
+                if (Base.TryGetModule(out RecoilPatternModule module))
                     module.BaseRecoil = value;
             }
         }
 
-        /*
-        /// <summary>
-        /// Gets the firearm's <see cref="FirearmRecoilPattern"/>. Will be <see langword="null"/> for non-automatic weapons.
-        /// </summary>
-        public FirearmRecoilPattern RecoilPattern => Base is AutomaticFirearm auto ? auto._recoilPattern : null;
-        */
-
         /// <summary>
         /// Gets a <see cref="Dictionary{TKey, TValue}"/> of <see cref="ItemType"/> and <see cref="AttachmentIdentifier"/>[] which contains all available attachments for all firearms.
         /// </summary>
@@ -587,23 +649,15 @@ public void ClearPreferences()
         /// <summary>
         /// Reloads current <see cref="Firearm"/>.
         /// </summary>
-        /// <param name="emptyMagazine">Whether empty magazine should be loaded.</param>
-        public void Reload(bool emptyMagazine = false)
+        /// <remarks>
+        /// For specific reloading logic you also can use <see cref="NormalMagazine"/> for avaible weapons.
+        /// </remarks>
+        public void Reload()
         {
-            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>
@@ -614,7 +668,6 @@ public override Item Clone()
         {
             Firearm cloneableItem = new(Type)
             {
-                Ammo = Ammo,
             };
 
             // TODO Not finish
@@ -639,6 +692,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/>
@@ -648,8 +705,8 @@ internal override void ReadPickupInfo(Pickup pickup)
 
             if (pickup is FirearmPickup firearmPickup)
             {
-                // TODO If synced
-                // MaxAmmo = firearmPickup.MaxAmmo;
+                PrimaryMagazine.MaxAmmo = firearmPickup.MaxAmmo;
+                AmmoDrain = firearmPickup.AmmoDrain;
             }
         }
     }