electrovir / input-device-handler Goto Github PK

View Code? Open in Web Editor NEW

Handles keyboard, mouse, and gamepad inputs with identical APIs so they can be used interchangeably.

License: Creative Commons Zero v1.0 Universal

JavaScript 2.25% TypeScript 96.84% HTML 0.73% CSS 0.18%

input-device-handler's Introduction

input-device-handler

Handles keyboard, mouse, and gamepad inputs with a single API that treats inputs from all those devices identically so they can be used interchangeably. Also optionally converts the Gamepad API's polling paradigm into an event based paradigm.

example: https://electrovir.github.io/input-device-handler/
full docs: https://electrovir.github.io/input-device-handler/docs

Usage

This details the most commonly used parts of teh API. For full API details, use the TypeScript types included in this package and in the GitHub repo.

Install

npm i input-device-handler

Basic usage

Since the gamepad api is poll based (their value must constantly be checked), a new class instance must be constructed so we can listen to events from it.

import {CurrentInputsChangedEvent, InputDeviceHandler, NewDevicesAddedEvent} from 'input-device-handler';

const deviceHandler = new InputDeviceHandler({startLoopImmediately: true});

// listen to new devices connecting (such as gamepads)
deviceHandler.listen(NewDevicesAddedEvent, (event) => {
    console.info('new devices added:', event.detail.inputs);
});

// listen to a change in inputs
deviceHandler.listen(CurrentInputsChangedEvent, (event) => {
    console.info('inputs changed:', event.detail.inputs);
});

Loop control

Under the hood, InputDeviceHandler is hooking into the render loop to constantly poll the gamepads. InputDeviceHandler provides means of controlling this polling loop:

import {InputDeviceHandler} from 'input-device-handler';

const deviceHandler = new InputDeviceHandler();

// start the polling loop, events will get fired now
deviceHandler.startPollingLoop();

// pause the polling loop, events will no longer get fired
deviceHandler.pausePollingLoop();

Usage within a render loop

If you already have a render loop, you can instruct InputDeviceHandler to not start its own poll loop. You can then fire its update method to get all the same functionality but contained within your own render loop.

import {InputDeviceHandler} from 'input-device-handler';

const deviceHandler = new InputDeviceHandler();

function myRenderLoop() {
    const currentDevices = deviceHandler.readAllDevices();
    // do something with the current devices and their inputs...
    requestAnimationFrame(myRenderLoop);
}

myRenderLoop();

Recommend Projects

electrovir / input-device-handler Goto Github PK