Class RemapHelper

Helper for input remapping in settings menus. Listens for the next key press or gamepad button and returns it.

Index

Constructors

Methods

listenForGamepadButton listenForKey

Constructors

constructor

new RemapHelper(scene: Scene): RemapHelper
Parameters
- scene: Scene
Returns RemapHelper
- Defined in packages/clik-engine/src/input/RemapHelper.ts:10

Methods

listenForGamepadButton

listenForGamepadButton(
callback: (buttonIndex: string) => void,
): { cancel: () => void }
Wait for the next gamepad button press. Returns the button index as a string (e.g. '0', '1', '2').
Parameters
- callback: (buttonIndex: string) => void
Returns { cancel: () => void }
- Defined in packages/clik-engine/src/input/RemapHelper.ts:43

listenForKey

listenForKey(callback: (keyName: string) => void): { cancel: () => void }
Wait for the next keyboard key press. Returns the key name (e.g. 'UP', 'SPACE', 'A'). Call cancel() on the returned handle to abort.
Parameters
- callback: (keyName: string) => void
Returns { cancel: () => void }
- Defined in packages/clik-engine/src/input/RemapHelper.ts:19