Skip to content

feat: Gun sound types #808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
MS-crew wants to merge 1 commit into
base: dev
Choose a base branch
from
+389 −0
Draft

feat: Gun sound types #808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions EXILED/Exiled.API/Enums/GunSoundType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
// -----------------------------------------------------------------------
// <copyright file="GunSoundType.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
{
/// <summary>
/// Represents the type of sound a firearm can produce.
/// </summary>
/// <seealso cref="Extensions.ItemExtensions.GetSoundType(ItemType, int)"/>
public enum GunSoundType
{
/// <summary>
/// Unknown or unmapped sound.
/// </summary>
Unknown,

/// <summary>
/// Sound of a gunshot.
/// </summary>
Fire,

/// <summary>
/// Sound of a suppressed gunshot.
/// </summary>
SuppressedFire,

/// <summary>
/// Sound of a dry fire (trigger pulled with an empty chamber).
/// </summary>
DryFire,

/// <summary>
/// Sound of a firearm being equipped or drawn.
/// </summary>
Equip,

/// <summary>
/// Sound of a rare or special equip animation.
/// </summary>
EquipRare,

/// <summary>
/// Sound of a firearm being cocked or charged.
/// </summary>
Cock,

/// <summary>
/// Sound of an initial or special cocking animation.
/// </summary>
CockInitial,

/// <summary>
/// Sound of a magazine being inserted.
/// </summary>
ReloadInsert,

/// <summary>
/// Sound of a magazine being ejected.
/// </summary>
ReloadEject,

/// <summary>
/// Sound of a general reload action (often used for revolvers or shotguns).
/// </summary>
Reload,

/// <summary>
/// Sound of a bolt or slide being pulled back.
/// </summary>
BoltOpen,

/// <summary>
/// Sound of a bolt or slide releasing forward.
/// </summary>
BoltClose,

/// <summary>
/// Sound of a round being ejected from the chamber.
/// </summary>
ChamberEject,

/// <summary>
/// Sound of a revolver's cylinder rotating.
/// </summary>
CylinderRotate,

/// <summary>
/// Sound of a revolver's cylinder being spun playfully.
/// </summary>
CylinderSpin,

/// <summary>
/// Sound of a gunshot using special buckshot ammunition.
/// </summary>
FireBuckshot,

/// <summary>
/// Sound of loading buckshot ammunition into an empty firearm.
/// </summary>
ReloadBuckshotEmpty,

/// <summary>
/// Sound of ejecting or emptying buckshot ammunition.
/// </summary>
EjectBuckshot,

/// <summary>
/// Sound of the weapon being inspected.
/// </summary>
Inspect,

/// <summary>
/// Sound of a single shot in Disintegrator mode.
/// </summary>
FireDisintegrator,

/// <summary>
/// Sound of the last shot in Disintegrator mode.
/// </summary>
FireDisintegratorLast,

/// <summary>
/// Sound of a shot in 3x Burst mode.
/// </summary>
FireBurst3x,

/// <summary>
/// Sound of the last shot in a 3x Burst sequence.
/// </summary>
FireBurst3xLast,

/// <summary>
/// Sound of general weapon handling, rustling, or adjusting grip.
/// </summary>
WeaponHandling,

/// <summary>
/// Sound of a weapon's stock being extended or adjusted.
/// </summary>
StockExtend,

/// <summary>
/// Sound of the second sequential shot, often used in double-shot shotgun modes.
/// </summary>
FireDouble,

/// <summary>
/// Sound of a single shotgun shell being ejected during unload.
/// </summary>
ShellEject,

/// <summary>
/// Sound indicating the completion of a shotgun unload sequence.
/// </summary>
UnloadComplete,

/// <summary>
/// Sound of a magazine being firmly tapped or locked into the firearm.
/// </summary>
ReloadLock,

/// <summary>
/// Sound of a drum or extended magazine being ejected.
/// </summary>
ReloadEjectDrum,

/// <summary>
/// Sound of a drum or extended magazine being inserted.
/// </summary>
ReloadInsertDrum,

/// <summary>
/// Sound of a drum or extended magazine being firmly tapped or locked into place.
/// </summary>
ReloadLockDrum,
}
}
209 changes: 209 additions & 0 deletions EXILED/Exiled.API/Extensions/ItemExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,215 @@ public static uint GetBaseCode(this FirearmType type)
/// <returns><see cref="ItemCategory"/> of the specified <see cref="ItemType"/>.</returns>
public static ItemCategory GetCategory(this ItemType type) => GetItemBase(type).Category;

/// <summary>
/// Gets the <see cref="GunSoundType"/> associated with a specific <see cref="ItemType"/> and sound index.
/// </summary>
/// <param name="type">The <see cref="ItemType"/> of the firearm.</param>
/// <param name="index">The mapped index of the sound.</param>
/// <returns>The mapped <see cref="GunSoundType"/>, or <see cref="GunSoundType.Unknown"/> if not found.</returns>
public static GunSoundType GetSoundType(this ItemType type, int index) => type switch
{
ItemType.GunCOM15 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
4 => GunSoundType.Equip,
5 => GunSoundType.ReloadInsert,
6 => GunSoundType.ReloadEject,
7 => GunSoundType.Cock,
8 => GunSoundType.BoltOpen,
9 => GunSoundType.BoltClose,
11 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

ItemType.GunCOM18 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
3 => GunSoundType.Equip,
4 => GunSoundType.ReloadInsert,
5 => GunSoundType.ReloadEject,
6 => GunSoundType.BoltOpen,
7 => GunSoundType.BoltClose,
8 => GunSoundType.ChamberEject,
9 => GunSoundType.EquipRare,
_ => GunSoundType.Unknown
},

ItemType.GunRevolver => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.CylinderRotate,
4 => GunSoundType.Fire,
5 => GunSoundType.FireBuckshot,
7 => GunSoundType.Equip,
8 => GunSoundType.CylinderSpin,
9 => GunSoundType.CockInitial,
11 => GunSoundType.ReloadBuckshotEmpty,
14 => GunSoundType.Reload,
15 => GunSoundType.EquipRare,
16 => GunSoundType.EjectBuckshot,
_ => GunSoundType.Unknown
},

ItemType.GunCom45 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.Equip,
3 => GunSoundType.CockInitial,
4 => GunSoundType.ReloadInsert,
5 => GunSoundType.ReloadEject,
6 => GunSoundType.BoltOpen,
7 => GunSoundType.BoltClose,
_ => GunSoundType.Unknown
},

ItemType.ParticleDisruptor => index switch
{
0 => GunSoundType.Reload,
2 => GunSoundType.CockInitial,
3 => GunSoundType.Inspect,
4 => GunSoundType.Inspect,
5 => GunSoundType.Inspect,
6 => GunSoundType.Equip,
7 => GunSoundType.FireDisintegrator,
9 => GunSoundType.FireDisintegrator,
8 => GunSoundType.FireDisintegratorLast,
10 => GunSoundType.FireDisintegratorLast,
11 => GunSoundType.FireBurst3x,
13 => GunSoundType.FireBurst3x,
12 => GunSoundType.FireBurst3xLast,
14 => GunSoundType.FireBurst3xLast,
_ => GunSoundType.Unknown
},

ItemType.GunFSP9 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
3 => GunSoundType.WeaponHandling,
4 => GunSoundType.Equip,
5 => GunSoundType.WeaponHandling,
7 => GunSoundType.ReloadEject,
8 => GunSoundType.BoltOpen,
9 => GunSoundType.StockExtend,
11 => GunSoundType.BoltClose,
12 => GunSoundType.ReloadInsert,
13 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

ItemType.GunShotgun => index switch
{
0 => GunSoundType.FireDouble,
1 => GunSoundType.Fire,
2 => GunSoundType.DryFire,
3 => GunSoundType.WeaponHandling,
4 => GunSoundType.ReloadInsert,
5 => GunSoundType.ReloadInsert,
6 => GunSoundType.BoltOpen,
7 => GunSoundType.BoltClose,
8 => GunSoundType.UnloadComplete,
9 => GunSoundType.ShellEject,
10 => GunSoundType.Equip,
_ => GunSoundType.Unknown
},

ItemType.GunFRMG0 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
5 => GunSoundType.Equip,
7 => GunSoundType.ReloadEject,
8 => GunSoundType.ReloadEjectDrum,
9 => GunSoundType.Cock,
10 => GunSoundType.ReloadInsert,
11 => GunSoundType.ReloadInsertDrum,
13 => GunSoundType.ReloadLock,
14 => GunSoundType.ReloadLockDrum,
16 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

ItemType.GunAK => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
6 => GunSoundType.Equip,
7 => GunSoundType.ReloadEject,
8 => GunSoundType.ReloadEjectDrum,
10 => GunSoundType.Cock,
11 => GunSoundType.CockInitial,
12 => GunSoundType.ReloadInsertDrum,
14 => GunSoundType.ReloadInsert,
19 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

ItemType.GunA7 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.CockInitial,
3 => GunSoundType.Equip,
5 => GunSoundType.ReloadEject,
6 => GunSoundType.WeaponHandling,
7 => GunSoundType.ReloadInsert,
8 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

ItemType.GunSCP127 => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.CockInitial,
4 => GunSoundType.Equip,
5 => GunSoundType.Cock,
6 => GunSoundType.WeaponHandling,
_ => GunSoundType.Unknown
},

ItemType.GunLogicer => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.Equip,
3 => GunSoundType.Cock,
4 => GunSoundType.BoltOpen,
5 => GunSoundType.ReloadEject,
6 => GunSoundType.ReloadInsert,
7 => GunSoundType.BoltClose,
8 => GunSoundType.WeaponHandling,
_ => GunSoundType.Unknown
},

ItemType.GunCrossvec => index switch
{
0 => GunSoundType.DryFire,
1 => GunSoundType.Fire,
2 => GunSoundType.SuppressedFire,
4 => GunSoundType.Equip,
5 => GunSoundType.StockExtend,
6 => GunSoundType.BoltOpen,
7 => GunSoundType.BoltClose,
8 => GunSoundType.ReloadEject,
9 => GunSoundType.ReloadInsert,
10 => GunSoundType.WeaponHandling,
15 => GunSoundType.ChamberEject,
_ => GunSoundType.Unknown
},

_ => GunSoundType.Unknown
};

/// <summary>
/// Checks if the specified <see cref="Firearm"/> has the specified <see cref="AttachmentName"/>.
/// </summary>
Expand Down
Loading