RobustToolbox/Robust.Client/Interfaces/Input/IInputManager.cs

using Robust.Shared;
using Robust.Shared.IoC;
using System;
using System.Collections.Generic;
using Robust.Client.Input;
using Robust.Shared.Maths;
using Robust.Shared.Input;
using Robust.Shared.Input.Binding;

namespace Robust.Client.Interfaces.Input
{
    /// <summary>
    ///     Manages key bindings, input commands and other misc. input systems.
    /// </summary>
    public interface IInputManager
    {
        bool Enabled { get; set; }

        Vector2 MouseScreenPosition { get; }

        BoundKeyMap NetworkBindMap { get; }

        IInputContextContainer Contexts { get; }

        void Initialize();

        void KeyDown(KeyEventArgs e);
        void KeyUp(KeyEventArgs e);

        /// <summary>
        /// Registers a new key binding in the input manager.
        /// </summary>
        /// <param name="function">The function the key binding is bound to.</param>
        /// <param name="bindingType"></param>
        /// <param name="baseKey"></param>
        /// <param name="mod1"></param>
        /// <param name="mod2"></param>
        /// <param name="mod3"></param>
        void RegisterBinding(BoundKeyFunction function, KeyBindingType bindingType,
            Keyboard.Key baseKey, Keyboard.Key? mod1, Keyboard.Key? mod2, Keyboard.Key? mod3);

        /// <summary>
        ///     Gets a key binding according to the function it is bound to.
        /// </summary>
        /// <param name="function">The function the key binding is bound to.</param>
        /// <returns>The key binding.</returns>
        IKeyBinding GetKeyBinding(BoundKeyFunction function);

        bool TryGetKeyBinding(BoundKeyFunction function, out IKeyBinding binding);

        /// <summary>
        ///     Returns the input command bound to a key function.
        /// </summary>
        /// <param name="function">The key function to find the bound input command for.</param>
        /// <returns>An input command, if any. Null if no command is set.</returns>
        InputCmdHandler? GetInputCommand(BoundKeyFunction function);

        void SetInputCommand(BoundKeyFunction function, InputCmdHandler? cmdHandler);

        /// <summary>
        ///     UIKeyBindStateChanged is called when a keybind is found.
        /// </summary>
        event Action<BoundKeyEventArgs> UIKeyBindStateChanged;

        /// <summary>
        ///     If UIKeyBindStateChanged did not handle the BoundKeyEvent, KeyBindStateChanged is called.
        /// </summary>
        event Action<BoundKeyEventArgs> KeyBindStateChanged;

        IEnumerable<BoundKeyFunction> DownKeyFunctions { get; }

        /// <summary>
        ///     Gets the name of the key on the keyboard, based on the current input method and language.
        /// </summary>
        string GetKeyName(Keyboard.Key key);

        /// <summary>
        ///     Gets a user-presentable, localized & keyboard-adjusted string for which combination
        ///     of buttons is bound to the specified key function.
        /// </summary>
        string GetKeyFunctionButtonString(BoundKeyFunction function);
    }
}