Add Vanilla Button Click Event (& Cancel Event)

MiraAPI.Example/ExampleEventHandlers.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Globalization;
+using System.Linq;
 using MiraAPI.Events;
 using MiraAPI.Events.Mira;
 using MiraAPI.Events.Vanilla.Gameplay;
@@ -17,7 +18,7 @@ public static class ExampleEventHandlers
 {
     public static void Initialize()
     {
-        // You can register event handlers with the MiraEventManager class.
+        // You can register event handlers with the MiraEventManager class
         var handle = MiraEventManager.RegisterEventHandler<BeforeMurderEvent>(@event =>
         {
             Logger<ExamplePlugin>.Info($"{@event.Source.Data.PlayerName} is about to kill {@event.Target.Data.PlayerName}");
@@ -37,6 +38,21 @@ public static class ExampleEventHandlers
         MiraEventManager.UnregisterEventHandler(handle);
     }
 
+    // If you want to check vanilla buttons, use something like this!
+    [RegisterEvent]
+    public static void VanillaButtonClickHandler(VanillaButtonClickEvent @event)
+    {
+        Logger<ExamplePlugin>.Info($"{@event.Button.buttonLabelText.text} is being used!");
+        if (@event.PlayerTarget != null)
+        {
+            Logger<ExamplePlugin>.Info($"{@event.PlayerTarget.Data.PlayerName} is being targeted!");
+        }
+        else if (@event.VentTarget != null)
+        {
+            Logger<ExamplePlugin>.Info($"Vent with id {@event.VentTarget.Id.ToString(CultureInfo.InvariantCulture)} is being targeted!");
+        }
+    }
+
     // If you want to add extra votes to a player, do something like this.
     [RegisterEvent]
     public static void StartMeetingEvent(StartMeetingEvent _)

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonCancelledEvent.cs

@@ -0,0 +1,44 @@
+using MiraAPI.Hud;
+
+namespace MiraAPI.Events.Vanilla.Gameplay;
+
+/// <summary>
+/// Invoked when a Vanilla Button click is cancelled. Do not use for custom buttons.
+/// </summary>
+/// <typeparam name="T">The Vanilla Button type.</typeparam>
+public sealed class VanillaButtonCancelledEvent<T> : MiraEvent where T : AbilityButton
+{
+    /// <summary>
+    /// Gets Vanilla Button whose click was cancelled.
+    /// </summary>
+    public T Button { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonCancelledEvent{T}"/> class.
+    /// </summary>
+    /// <param name="button">The Mira Button whose click was cancelled.</param>
+    public VanillaButtonCancelledEvent(T button)
+    {
+        Button = button;
+    }
+}
+
+/// <summary>
+/// Invoked when a Vanilla Button click is cancelled. Do not use for custom buttons.
+/// </summary>
+public sealed class VanillaButtonCancelledEvent : MiraEvent
+{
+    /// <summary>
+    /// Gets Vanilla Button whose click was cancelled.
+    /// </summary>
+    public AbilityButton Button { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonCancelledEvent"/> class.
+    /// </summary>
+    /// <param name="button">The Vanilla Button whose click was cancelled.</param>
+    public VanillaButtonCancelledEvent(AbilityButton button)
+    {
+        Button = button;
+    }
+}

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonClickEvent.cs

@@ -0,0 +1,65 @@
+using MiraAPI.Hud;
+
+namespace MiraAPI.Events.Vanilla.Gameplay;
+
+/// <summary>
+/// Button click event for Vanilla Buttons only. Do not use for custom buttons.
+/// </summary>
+/// <typeparam name="T">The Vanilla Button type.</typeparam>
+public sealed class VanillaButtonClickEvent<T> : MiraCancelableEvent where T : AbilityButton
+{
+    /// <summary>
+    /// Gets Vanilla Button that was clicked.
+    /// </summary>
+    public T Button { get; }
+
+    /// <summary>
+    /// Gets the generic click event that is invoked before this button-specific event.
+    /// </summary>
+    public VanillaButtonClickEvent GenericClickEvent { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonClickEvent{T}"/> class.
+    /// </summary>
+    /// <param name="button">The Mira Button that was clicked.</param>
+    /// <param name="genericClickEvent">The generic click event invoked before button-specific events.</param>
+    public VanillaButtonClickEvent(T button, VanillaButtonClickEvent genericClickEvent)
+    {
+        GenericClickEvent = genericClickEvent;
+        Button = button;
+    }
+}
+
+/// <summary>
+/// Button click event for Vanilla Buttons only. Do not use for custom buttons.
+/// </summary>
+public sealed class VanillaButtonClickEvent : MiraCancelableEvent
+{
+    /// <summary>
+    /// Gets Vanilla Button that was clicked.
+    /// </summary>
+    public AbilityButton Button { get; }
+
+    /// <summary>
+    /// Gets the target player, if any, of the Vanilla Button that was clicked.
+    /// </summary>
+    public PlayerControl? PlayerTarget { get; }
+
+    /// <summary>
+    /// Gets the target vent, if any, of the Vanilla Button that was clicked.
+    /// </summary>
+    public Vent? VentTarget { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonClickEvent"/> class.
+    /// </summary>
+    /// <param name="button">The Vanilla Button that was clicked.</param>
+    /// <param name="playerTarget">The Player target, if any.</param>
+    /// <param name="ventTarget">The Vent target, if any.</param>
+    public VanillaButtonClickEvent(AbilityButton button, PlayerControl? playerTarget = null, Vent? ventTarget = null)
+    {
+        Button = button;
+        PlayerTarget = playerTarget;
+        VentTarget = ventTarget;
+    }
+}

MiraAPI/Patches/Events/VanillaButtonPatches.cs

@@ -0,0 +1,75 @@
+using System.Linq;
+using AmongUs.GameOptions;
+using HarmonyLib;
+using MiraAPI.Events;
+using MiraAPI.Events.Vanilla.Gameplay;
+using MiraAPI.Events.Vanilla.Usables;
+
+namespace MiraAPI.Patches.Events;
+
+/// <summary>
+/// Patches to invoke vent related MiraEvents.
+/// </summary>
+[HarmonyPatch]
+public static class VanillaButtonPatches
+{
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(AbilityButton), nameof(AbilityButton.DoClick))]
+    public static bool DoClickPrefix(AbilityButton __instance)
+    {
+        // Invoke the generic button click event.
+        PlayerControl? playerTarget = null;
+        Vent? ventTarget = null;
+        var role = PlayerControl.LocalPlayer.Data.Role;
+        if (role.Role is RoleTypes.Tracker)
+        {
+            playerTarget = role.Cast<TrackerRole>().currentTarget;
+        }
+        else if (role.Role is RoleTypes.GuardianAngel)
+        {
+            playerTarget = role.Cast<GuardianAngelRole>().currentTarget;
+        }
+        else if (role.Role is RoleTypes.Engineer)
+        {
+            ventTarget = role.Cast<EngineerRole>().currentTarget;
+        }
+        var genericEvent = new VanillaButtonClickEvent(__instance, playerTarget, ventTarget);
+        MiraEventManager.InvokeEvent(genericEvent);
+        if (genericEvent.IsCancelled)
+        {
+            MiraEventManager.InvokeEvent(new VanillaButtonCancelledEvent(__instance));
+        }
+
+        if (!genericEvent.IsCancelled)
+        {
+            return true;
+        }
+
+        return false;
+    }
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(SecondaryAbilityButton), nameof(SecondaryAbilityButton.DoClick))]
+    public static bool SecondaryDoClickPrefix(AbilityButton __instance)
+    {
+        // Invoke the generic button click event.
+        PlayerControl? playerTarget = null;
+        var role = PlayerControl.LocalPlayer.Data.Role;
+        if (role.Role is RoleTypes.Detective)
+        {
+            playerTarget = role.Cast<DetectiveRole>().currentTarget;
+        }
+        var genericEvent = new VanillaButtonClickEvent(__instance, playerTarget);
+        MiraEventManager.InvokeEvent(genericEvent);
+        if (genericEvent.IsCancelled)
+        {
+            MiraEventManager.InvokeEvent(new VanillaButtonCancelledEvent(__instance));
+        }
+
+        if (!genericEvent.IsCancelled)
+        {
+            return true;
+        }
+
+        return false;
+    }
+}