MiraAPI/MiraAPI/Keybinds/KeybindUtils.cs

using System;
using Rewired;

namespace MiraAPI.Keybinds;

/// <summary>
/// Collection of keybind-related utility classes.
/// </summary>
public static class KeybindUtils
{
    /// <summary>
    /// Gets the Rewired <see cref="InputManager_Base"/> instance.
    /// </summary>
    public static InputManager_Base? RewiredInputManager { get; internal set; }

    /// <summary>
    /// Returns the currently assigned keycode of a <see cref="BaseKeybind"/>.
    /// </summary>
    /// <param name="keybind">The <see cref="BaseKeybind"/> to get the keycode from.</param>
    /// <returns>The currently assigned keycode.</returns>
    public static KeyboardKeyCode GetKeycodeByKeybind(BaseKeybind keybind)
    {
        if (keybind.RewiredInputAction == null)
        {
            return KeyboardKeyCode.None;
        }

        return GetKeycodeByActionId(keybind.RewiredInputAction.id);
    }

    /// <summary>
    /// Gets the keycode for an action with <see cref="ReInput"/>.
    /// </summary>
    /// <param name="actionId">The action ID.</param>
    /// <returns>The keyboard keycode.</returns>
    public static KeyboardKeyCode GetKeycodeByActionId(int actionId)
    {
        return GetActionElementMap(actionId)?.keyboardKeyCode ?? KeyboardKeyCode.None;
    }

    /// <summary>
    /// Gets a <see cref="ActionElementMap"/> by id with <see cref="ReInput"/>.
    /// </summary>
    /// <param name="actionId">The action ID.</param>
    /// <returns>The keyboard keycode.</returns>
    public static ActionElementMap? GetActionElementMap(int actionId)
    {
        var player = ReInput.players.GetPlayer(0);
        return player.controllers.maps.GetFirstElementMapWithAction(ControllerType.Keyboard, actionId, false);
    }

    /// <summary>
    /// Gets an <see cref="InputAction"/> by id.
    /// </summary>
    /// <param name="id">The action identifier name.</param>
    /// <returns>The keyboard keycode.</returns>
    public static InputAction? GetInputActionById(int id)
    {
        return RewiredInputManager?.userData?.GetActionById(id);
    }

    /// <summary>
    /// Finds and returns an unused KeyCode that is not equal to the excluded key.
    /// </summary>
    /// <param name="exclude">The KeyCode to skip during the search.</param>
    /// <returns>
    /// The first available KeyCode not currently used by any registered keybind,
    /// or <see cref="KeyboardKeyCode.None"/> if none are available.
    /// </returns>
    public static KeyboardKeyCode FindAvailableKey(KeyboardKeyCode exclude)
    {
        foreach (KeyboardKeyCode key in Enum.GetValues<KeyboardKeyCode>())
        {
            if (key == exclude) continue;
            bool used = KeybindManager.Keybinds.Exists(e => e.DefaultKey == key);
            if (!used) return key;
        }
        return KeyboardKeyCode.None;
    }
}