InputMapRebinder

A utility class for rebinding input mappings at runtime.

InputMapRebinder provides a user-friendly way to change input bindings by listening for input and automatically binding it to the specified action. This is commonly used in game settings menus to let players customize controls.

Features:

• Listen for any input type (keyboard, gamepad button, gamepad axis)
• Support for cancellation (ESC key or SELECT button by default)
• Configurable conditions for filtering valid inputs
• Events for tracking rebind operations
• Option to preserve or replace existing bindings

Example usage:

var rebinder = new InputMapRebinder<Action>();

// Rebind jump action - will listen for next input
rebinder.rebind(inputMap, Action.JUMP);

// Listen for rebind completion
rebinder.onAfterRebindAny(this, (map, action) -> {
    trace('Rebound action: ' + action);
});

// Add conditions to filter inputs
rebinder.keyCondition = (action, key) -> {
    // Don't allow binding F1-F12 keys
    return key.keyCode < KeyCode.F1 || key.keyCode > KeyCode.F12;
};

Instance Members #

The dead zone threshold for converting analog axis movement to button presses. When binding an axis as a button, the axis must exceed this value to register. Default: 0.25 (25% of axis range)

The gamepad button that cancels the rebind operation. Default: GamepadButton.SELECT

The keyboard key that cancels the rebind operation. Default: KeyCode.ESCAPE

Optional condition function to filter keyboard inputs during rebinding. Return false to reject the input, true to accept it. If null, all keyboard inputs are accepted (except cancel key).

Optional condition function to filter gamepad button inputs during rebinding. Return false to reject the input, true to accept it. If null, all gamepad buttons are accepted (except cancel button).

Optional condition function to filter gamepad axis inputs during rebinding. Return false to reject the input, true to accept it. If null, all gamepad axes are accepted.

Optional condition function to filter gamepad axis-to-button conversions during rebinding. Return false to reject the input, true to accept it. If null, all gamepad axis movements exceeding the dead zone are accepted.

Starts listening for input to rebind the specified action. The rebinder will listen for keyboard, gamepad buttons, and gamepad axes simultaneously and bind the first valid input received.

Private Members #

Triggered before any input is rebound, regardless of input type. @event beforeRebindAny

Triggered after any input is successfully rebound, regardless of input type. @event afterRebindAny

Triggered before a keyboard key is bound to an action. @event beforeRebindKey

Triggered after a keyboard key is successfully bound to an action. @event afterRebindKey

Triggered before a gamepad button is bound to an action. @event beforeRebindGamepadButton

Triggered after a gamepad button is successfully bound to an action. @event afterRebindGamepadButton

Triggered before a gamepad axis is bound to an axis action. @event beforeRebindGamepadAxis

Triggered after a gamepad axis is successfully bound to an axis action. @event afterRebindGamepadAxis

Triggered before a gamepad axis is bound to a button action (axis-to-button conversion). @event beforeRebindGamepadAxisToButton

Triggered after a gamepad axis is successfully bound to a button action. @event afterRebindGamepadAxisToButton

Metadata #