feat: ShowingHitMarkerEventArgs

EXILED/Exiled.Events/EventArgs/Player/ShowingHitMarkerEventArgs.cs

@@ -0,0 +1,66 @@
+// -----------------------------------------------------------------------
+// <copyright file="ShowingHitMarkerEventArgs.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.Events.EventArgs.Player
+{
+    using API.Features;
+    using Interfaces;
+
+    /// <summary>
+    /// Contains all information before a hitmarker is show to player.
+    /// </summary>
+    public class ShowingHitMarkerEventArgs : IPlayerEvent, IDeniableEvent
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ShowingHitMarkerEventArgs" /> class.
+        /// </summary>
+        /// <param name="hub">
+        /// <inheritdoc cref="Player" />
+        /// </param>
+        /// <param name="size">
+        /// <inheritdoc cref="Size" />
+        /// </param>
+        /// <param name="shouldPlayAudio">
+        /// <inheritdoc cref="ShouldPlayAudio" />
+        /// </param>
+        /// <param name="hitmarkerType">
+        /// <inheritdoc cref="HitmarkerType" />
+        /// </param>
+        public ShowingHitMarkerEventArgs(ReferenceHub hub, float size, bool shouldPlayAudio, HitmarkerType hitmarkerType)
+        {
+            Player = Player.Get(hub);
+            Size = size;
+            ShouldPlayAudio = shouldPlayAudio;
+            HitmarkerType = hitmarkerType;
+        }
+
+        /// <summary>
+        /// Gets or sets the player that the hitmarker is being shown to.
+        /// </summary>
+        public Player Player { get; set; }
+
+        /// <summary>
+        /// Gets or sets the target size multiplier.
+        /// </summary>
+        public float Size { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the hitmarker sound effect should play.
+        /// </summary>
+        public bool ShouldPlayAudio { get; set; }
+
+        /// <summary>
+        /// Gets or sets a the type of the hitmarker.
+        /// </summary>
+        public HitmarkerType HitmarkerType { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the hitmarker should be shown.
+        /// </summary>
+        public bool IsAllowed { get; set; } = true;
+    }
+}

EXILED/Exiled.Events/Handlers/Player.cs

@@ -32,6 +32,11 @@ public class Player
         /// </summary>
         public static Event<HitEventArgs> Hit { get; set; } = new ();
 
+        /// <summary>
+        /// Invoked before a player is shown a hitmarker.
+        /// </summary>
+        public static Event<ShowingHitMarkerEventArgs> ShowingHitMarker { get; set; } = new ();
+
         /// <summary>
         /// Invoked before authenticating a <see cref="API.Features.Player"/>.
         /// </summary>
@@ -1423,6 +1428,12 @@ public static void OnItemRemoved(ReferenceHub referenceHub, InventorySystem.Item
         /// <param name="ev">The <see cref="HitEventArgs"/> instance.</param>
         public static void OnHit(HitEventArgs ev) => Hit.InvokeSafely(ev);
 
+        /// <summary>
+        /// Called before a player is shown a hitmarker.
+        /// </summary>
+        /// <param name="ev">The <see cref="ShowingHitMarkerEventArgs"/> instance.</param>
+        public static void OnShowingHitMarker(ShowingHitMarkerEventArgs ev) => ShowingHitMarker.InvokeSafely(ev);
+
         /// <summary>
         /// Called before Emergency Release Button is pressed.
         /// </summary>

EXILED/Exiled.Events/Patches/Events/Player/ShowingHitMarker.cs

@@ -0,0 +1,81 @@
+// -----------------------------------------------------------------------
+// <copyright file="ShowingHitMarker.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.Events.Patches.Events.Player
+{
+    using System.Collections.Generic;
+    using System.Reflection.Emit;
+
+    using Exiled.API.Features.Pools;
+    using Exiled.Events.Attributes;
+    using Exiled.Events.EventArgs.Player;
+    using HarmonyLib;
+
+    using static HarmonyLib.AccessTools;
+
+    /// <summary>
+    /// Patch the <see cref="Hitmarker.SendHitmarkerDirectly(ReferenceHub, float, bool, HitmarkerType)"/> method.
+    /// Adds the <see cref="Handlers.Player.ShowingHitMarker"/> event.
+    /// </summary>
+    [EventPatch(typeof(Handlers.Player), nameof(Handlers.Player.ShowingHitMarker))]
+    [HarmonyPatch(typeof(Hitmarker), nameof(Hitmarker.SendHitmarkerDirectly), typeof(ReferenceHub), typeof(float), typeof(bool), typeof(HitmarkerType))]
+    internal static class ShowingHitMarker
+    {
+        private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions, ILGenerator generator)
+        {
+            List<CodeInstruction> newInstructions = ListPool<CodeInstruction>.Pool.Get(instructions);
+
+            LocalBuilder ev = generator.DeclareLocal(typeof(ShowingHitMarkerEventArgs));
+            Label continueLabel = generator.DefineLabel();
+
+            int offset = 1;
+
+            int index = newInstructions.FindIndex(instruction => instruction.opcode == OpCodes.Ret) + offset;
+
+            newInstructions.InsertRange(index, new[]
+            {
+                // ShowingHitMarkerEventArgs ev = new(hub, size, playAudio, hitmarkerType)
+                new CodeInstruction(OpCodes.Ldarg_0).MoveLabelsFrom(newInstructions[index]),
+                new(OpCodes.Ldarg_1),
+                new(OpCodes.Ldarg_2),
+                new(OpCodes.Ldarg_3),
+                new(OpCodes.Newobj, GetDeclaredConstructors(typeof(ShowingHitMarkerEventArgs))[0]),
+                new(OpCodes.Dup),
+                new(OpCodes.Stloc_S, ev.LocalIndex),
+
+                // Handlers.Player.OnShowingHitMarker(ev)
+                new(OpCodes.Call, Method(typeof(Handlers.Player), nameof(Handlers.Player.OnShowingHitMarker))),
+
+                // if (!ev.IsAllowed) return;
+                new(OpCodes.Ldloc_S, ev.LocalIndex),
+                new(OpCodes.Callvirt, PropertyGetter(typeof(ShowingHitMarkerEventArgs), nameof(ShowingHitMarkerEventArgs.IsAllowed))),
+                new(OpCodes.Brtrue_S, continueLabel),
+                new(OpCodes.Ret),
+
+                // size = ev.Size;
+                new CodeInstruction(OpCodes.Ldloc_S, ev.LocalIndex).WithLabels(continueLabel),
+                new(OpCodes.Callvirt, PropertyGetter(typeof(ShowingHitMarkerEventArgs), nameof(ShowingHitMarkerEventArgs.Size))),
+                new(OpCodes.Starg_S, 1),
+
+                // playAudio = ev.ShouldPlayAudio;
+                new(OpCodes.Ldloc_S, ev.LocalIndex),
+                new(OpCodes.Callvirt, PropertyGetter(typeof(ShowingHitMarkerEventArgs), nameof(ShowingHitMarkerEventArgs.ShouldPlayAudio))),
+                new(OpCodes.Starg_S, 2),
+
+                // hitmarkerType = ev.HitmarkerType;
+                new(OpCodes.Ldloc_S, ev.LocalIndex),
+                new(OpCodes.Callvirt, PropertyGetter(typeof(ShowingHitMarkerEventArgs), nameof(ShowingHitMarkerEventArgs.HitmarkerType))),
+                new(OpCodes.Starg_S, 3),
+            });
+
+            for (int z = 0; z < newInstructions.Count; z++)
+                yield return newInstructions[z];
+
+            ListPool<CodeInstruction>.Pool.Return(newInstructions);
+        }
+    }
+}