Class InputManager

Central manager for handling all input sources and routing inputs to commands.

InputManager automatically listens to keyboard and gamepad inputs, maps them to commands defined in your input maps, and calls the appropriate command lifecycle methods (trigger, update, release).

Quick Start

import { InputManager, Command, Inputs } from '@happy-pixels/input-forge';

// 1. Create your commands
class JumpCommand extends Command {
    trigger() { console.log('Jump!'); }
}

// 2. Define an input map
const inputMap = {
    id: 'gameplay',
    singleInput: {
        jump: {
            keyboardInput: Inputs.KEYBOARD_SPACE,
            controllerInput: Inputs.CONTROLLER_FACE_BOTTOM,
            command: new JumpCommand()
        }
    }
};

// 3. Create the manager and set the input map
const manager = new InputManager();
manager.setInputMap(inputMap);

// 4. Start the tick loop (required for update events and TickCommands)
manager.startTick();

// 5. Clean up when done
manager.destroy();

Input Map Stacking

InputManager supports stacking input maps for context switching (e.g., gameplay vs menu):

manager.setInputMap(gameplayMap);  // Base map
manager.pushInputMap(pauseMenuMap); // Overlay - now active
manager.popInputMap();              // Back to gameplay

Custom Inputs

Trigger inputs programmatically (e.g., from touch controls):

manager.triggerCustomInput('my_action');
manager.triggerCustomAxesInput('virtual_stick', { x: 0.5, y: -0.5 });

Index

Constructors

constructor

new InputManager(
    gamepadFps?: number,
    gamepadDeadZone?: number,
    axesThrottleMs?: number,
): InputManager
Creates a new InputManager instance.
Parameters
- gamepadFps: number = 60
  Polling rate for gamepad inputs (default: 60, range: 1-120)
- gamepadDeadZone: number = 0.1
  Dead zone threshold for gamepad sticks (default: 0.1, range: 0-1)
- OptionalaxesThrottleMs: number
  Optional throttle for axis update events in milliseconds. When set, axis 'update' events will be throttled to reduce processing overhead. Trigger and release events are never throttled. (default: undefined/no throttle)
Returns InputManager
- Defined in core/input-manager.ts:118

Properties

activeInputDevice$

activeInputDevice$: Observable<InputDeviceType | null> = ...

Observable that emits when the active input device changes. Useful for switching button prompts between keyboard and controller styles.

Emits:

'keyboard' - When keyboard input is detected
'xbox' - When an Xbox controller is used
'playstation' - When a PlayStation controller is used
'other_controller' - When another gamepad is used
null - Initial state before any input

Example

manager.activeInputDevice$.subscribe((device) => {
    if (device === 'keyboard') {
        showKeyboardPrompts();
    } else if (device === 'xbox') {
        showXboxPrompts();
    } else if (device === 'playstation') {
        showPlayStationPrompts();
    }
});

Methods

currentInputMap

currentInputMap(): string | null
Gets the ID of the currently active input map.

Returns string | null
The active map's ID, or null if no map is set
- Defined in core/input-manager.ts:363

destroy

destroy(): void
Destroys the InputManager and releases all resources. Call this when you're done with the manager (e.g., when leaving a scene). After calling destroy, the manager should not be used again.

Returns void
- Defined in core/input-manager.ts:464

getActiveCommands

getActiveCommands(): Command<void>[]
Gets all currently active commands (triggered but not yet released). Useful for debugging or displaying active input state.

Returns Command<void>[]
Array of currently active Command instances
Example
```
const active = manager.getActiveCommands();
console.log(`Active commands: ${active.length}`);
```
- Defined in core/input-manager.ts:445

getActiveInputDevice

getActiveInputDevice(): InputDeviceType | null
Gets the current active input device type.

Returns InputDeviceType | null
The current input device type, or null if no input has been detected yet
- Defined in core/input-manager.ts:453

hasInputMap

hasInputMap(id: string): boolean
Checks if an input map with the given ID exists anywhere in the stack.
Parameters
- id: string
  The input map ID to search for
Returns boolean
True if the map exists in the stack
- Defined in core/input-manager.ts:347

isInputActive

isInputActive(key: string): boolean
Checks if a specific input key is currently active (pressed/held). Checks across all input sources (keyboard, gamepad).
Parameters
- key: string
  The input key to check (e.g., Inputs.KEYBOARD_SPACE, Inputs.CONTROLLER_FACE_BOTTOM)
Returns boolean
True if the input is currently active
Example
```
if (manager.isInputActive(Inputs.KEYBOARD_SHIFT)) {
    // Shift is being held
}
```
- Defined in core/input-manager.ts:420

popInputMap

popInputMap(): void
Removes the top input map from the stack. The next map in the stack becomes active. Does nothing if the stack is empty.

Returns void
- Defined in core/input-manager.ts:338

pushInputMap

pushInputMap(inputMap: InputMap): void
Pushes an input map onto the stack, making it the active map. The previous map remains in the stack and will become active again when this map is popped. Use this for temporary contexts like pause menus or dialog boxes.
Parameters
- inputMap: InputMap
  The input map to push
Returns void
- Defined in core/input-manager.ts:321

releaseCustomAxesInput

releaseCustomAxesInput(name: string): void
Releases a custom axes input (sets axes to neutral/center).
Parameters
- name: string
  The custom axes input name to release
Returns void
- Defined in core/input-manager.ts:401

removeInputMap

removeInputMap(id: string): void
Removes a specific input map from anywhere in the stack by ID.
Parameters
- id: string
  The input map ID to remove
Returns void
- Defined in core/input-manager.ts:355

setInputMap

setInputMap(inputMap: InputMap): void
Replaces all input maps with a single new map. Use this to set the primary input map or switch between major game states.
Parameters
- inputMap: InputMap
  The input map to set
Returns void
- Defined in core/input-manager.ts:330

startTick

startTick(): void
Starts the tick loop for continuous updates. Required for:
- update() events on held inputs
- TickCommand.tick() calls
Call stopTick() or destroy() to stop the loop.
Returns void
- Defined in core/input-manager.ts:275

stopTick

stopTick(): void
Stops the tick loop. Commands will no longer receive update or tick events.

Returns void
- Defined in core/input-manager.ts:288

triggerCustomAxesInput

triggerCustomAxesInput(name: string, axes: AxesInput | [number, number]): void
Triggers a custom axes input. Use this for virtual joysticks, touch controls, etc. The name must match a customAxesInput field in your input map.
Parameters
- name: string
  The custom axes input name
- axes: AxesInput | [number, number]
  The axis values as {x, y} or [x, y]
Returns void
- Defined in core/input-manager.ts:384

triggerCustomInput

triggerCustomInput(input: string): void
Triggers a custom single input. Use this for virtual buttons, touch controls, etc. The input key must match a customInput field in your input map.
Parameters
- input: string
  The custom input key to trigger
Returns void
- Defined in core/input-manager.ts:374

updateCustomAxesInput

updateCustomAxesInput(name: string, axes: AxesInput | [number, number]): void
Updates a custom axes input with new values.
Parameters
- name: string
  The custom axes input name
- axes: AxesInput | [number, number]
  The new axis values as {x, y} or [x, y]
Returns void
- Defined in core/input-manager.ts:393

Class InputManager

Quick Start

Input Map Stacking

Custom Inputs

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InputManager

Properties

activeInputDevice$

Example

Methods

currentInputMap

Returns string | null

destroy

Returns void

getActiveCommands

Returns Command<void>[]

Example

getActiveInputDevice

Returns InputDeviceType | null

hasInputMap

Parameters

Returns boolean

isInputActive

Parameters

Returns boolean

Example

popInputMap

Returns void

pushInputMap

Parameters

Returns void

releaseCustomAxesInput

Parameters

Returns void

removeInputMap

Parameters

Returns void

setInputMap

Parameters

Returns void

startTick

Returns void

stopTick

Returns void

triggerCustomAxesInput

Parameters

Returns void

triggerCustomInput

Parameters

Returns void

updateCustomAxesInput

Parameters

Returns void

Settings

On This Page