Class Input

Handles user input (keyboard and mouse). Implements a static singleton pattern for global access, but can be instantiated or mocked for testing.

Implements

InputInterface

Index

Constructors

Properties

debug isPointerLocked mouse preventPointerLock

Accessors

gamepadController

Methods

getAxis init isPressed requestJoyConConnection requestPointerLock setKeyState update

Constructors

constructor

new Input(): Input

Returns Input

Properties

debug

debug: boolean = false

Whether debug mode is enabled for input.

isPointerLocked

isPointerLocked: boolean = false

Whether the pointer is currently locked.

mouse

mouse: MouseState = ...

Mouse state including position and button status.

preventPointerLock

preventPointerLock: boolean = false

Accessors

gamepadController

get gamepadController(): UniversalGamepadController
Returns UniversalGamepadController
- Defined in core/Input.ts:57

Methods

getAxis

getAxis(neg: string, pos: string): number
Parameters
- neg: string
- pos: string
Returns number

Inherit Doc
Implementation of InputInterface.getAxis
- Defined in core/Input.ts:254

init

init(): void
Initializes the input listeners.

Returns void
- Defined in core/Input.ts:67

isPressed

isPressed(code: string): boolean
Parameters
- code: string
Returns boolean

Inherit Doc
Implementation of InputInterface.isPressed
- Defined in core/Input.ts:207

requestJoyConConnection

requestJoyConConnection(): Promise<void>
Returns Promise<void>
- Defined in core/Input.ts:60

requestPointerLock

requestPointerLock(element: HTMLElement): void
Parameters
- element: HTMLElement
Returns void
- Defined in core/Input.ts:195

setKeyState

setKeyState(code: string, pressed: boolean): void
Helper for testing to manually set key state.
Parameters
- code: string
- pressed: boolean
Returns void
- Defined in core/Input.ts:330

update

update(): void
Polls gamepad look axes and accumulates them into mouse deltas. Should be called once per frame.

Returns void
- Defined in core/Input.ts:285