Skip to main content
Version: 0.2.0

Interface IInputApi

Namespace: ReadyM.Sdk.Common.Api
Assembly: ReadyM.Sdk.Common.dll

Provides methods related to input, such as registering key binds.

public interface IInputApi

Methods

CanApplyInput()

Determines whether keyboard input can currently be applied (i.e., not blocked by active text fields or menus).

bool CanApplyInput()

Returns

bool

true if keyboard input is not blocked by active text fields and menus; otherwise, false.

RegisterKeyBind(Key, Action)

Registers a key bind with the specified key and action.

void RegisterKeyBind(Key key, Action action)

Parameters

key Key

The key to bind.

action Action

The action to execute when the key is pressed.

RegisterKeyBind(ModifierKeys, Key, Action)

Registers a key bind with the specified modifier keys, key, and action.

void RegisterKeyBind(ModifierKeys modifiers, Key key, Action action)

Parameters

modifiers ModifierKeys

The modifier keys (e.g., Ctrl, Alt, Shift).

key Key

The key to bind.

action Action

The action to execute when the key combination is pressed.

  • Methods
    • CanApplyInput()
    • RegisterKeyBind(Key, Action)
    • RegisterKeyBind(ModifierKeys, Key, Action)