LiquidBounce/net.ccbluex.liquidbounce.utils.input/InputBind

InputBind

data class InputBind(val boundKey: InputConstants.Key, val action: InputBind.BindAction, val modifiers: Set<InputBind.Modifier>) : Record

Data class representing a key binding. It holds the key to be bound and the action that will be triggered by the binding.

Parameters

boundKey

The key that is bound to an action.

action

The action triggered by the bound key (e.g., TOGGLE, HOLD).

Constructors

InputBind

constructor(boundKey: InputConstants.Key, action: InputBind.BindAction, modifiers: Set<InputBind.Modifier>)

constructor(type: InputConstants.Type, code: Int, action: InputBind.BindAction)

Alternative constructor to create a binding from the key type and key code.

constructor(name: String)

Constructor to create a binding using a key name.

Types

BindAction

enum BindAction : Tagged, Enum<InputBind.BindAction>

Action mode used to interpret bind input events.

Companion

object Companion

Modifier

enum Modifier : Tagged, Enum<InputBind.Modifier>

Properties

action

val action: InputBind.BindAction

boundKey

val boundKey: InputConstants.Key

isUnbound

val isUnbound: Boolean

Checks if the key is unbound (i.e., set to UNKNOWN_KEY).

keyName

val keyName: String

Retrieves the name of the key in uppercase format, excluding the category prefixes.

modifiers

val modifiers: Set<InputBind.Modifier>

Functions

getNewState

fun getNewState(event: KeyboardKeyEvent, currentState: Boolean): Boolean

Handles the event. Returns the new state, assumes the original state is false.

matchesKey

fun matchesKey(keyCode: Int, scanCode: Int): Boolean

Determines if the specified key matches the bound key.

matchesKeyPress

fun matchesKeyPress(event: KeyboardKeyEvent): Boolean

Determines if a keyboard press event matches this bind key and required modifiers.

matchesKeyRelease

fun matchesKeyRelease(event: KeyboardKeyEvent): Boolean

Determines if a keyboard release affects this bind key or one of its required modifiers.

matchesModifiers

fun matchesModifiers(mods: Int): Boolean

Determines if the given modifiers match the required modifiers.

matchesMouse

fun matchesMouse(code: Int): Boolean

Determines if the specified mouse button code matches the bound key.

matchesMousePress

fun matchesMousePress(event: MouseButtonEvent): Boolean

Determines if a mouse press event matches this bind button and required modifiers.

matchesMouseRelease

fun matchesMouseRelease(event: MouseButtonEvent): Boolean

Determines if a mouse release affects this bind button or one of its required modifiers.

renderText

fun InputBind.renderText(): Component