aframe-gamepad-controls
Advanced tools
gamepad-controls ComponentGamepad controls for A-Frame VR.
Supports one or more gamepads, attached to an A-Frame scene.
This component uses the HTML5 Gamepad API. The underlying API supports Firefox, Chrome, Edge, and Opera (as of 01/2016). Safari and Internet Explorer do not currently support gamepads.
<html>
<head>
<!-- A-Frame VR Library -->
<script src="https://aframe.io/releases/latest/aframe.js"></script>
<!-- Component -->
<script src="dist/aframe-gamepad-controls.js"></script>
</head>
<body>
<a-scene>
<!-- ... -->
<a-entity camera gamepad-controls></a-entity>
</a-scene>
</body>
</html>
Install NPM module.
$ npm install aframe-gamepad-controls
Register gamepad-controls component.
var AFRAME = require('aframe-core');
var GamepadControls = require('aframe-gamepad-controls');
AFRAME.registerComponent('gamepad-controls', GamepadControls);
Add markup.
<!-- First-person controls -->
<a-entity camera gamepad-controls></a-entity>
<!-- Third-person controls -->
<a-cube gamepad-controls="lookEnabled: false"></a-cube>
<!-- Two players -->
<a-model src="player1.obj" gamepad-controls="controller: 0; lookEnabled: false"></a-model>
<a-model src="player2.obj" gamepad-controls="controller: 1; lookEnabled: false"></a-model>
When buttons are pressed on the gamepad, a GamepadButtonEvent is emitted on the element. Components and entities may listen for these events and modify behavior as needed. Example:
el.addEventListener('gamepadbuttondown', function (e) {
console.log('Button "%d" has been pressed.', e.index);
});
GamepadButtonEvent:
| Property | Type | Description |
|---|---|---|
| type | string | Either gamepadbuttondown or gamepadbuttonup. |
| index | int | Index of the button affected, 0..N. |
| pressed | boolean | Whether |
| value | float | Distance the button was pressed, if applicable. value will be 0 or 1 in most cases, but may return a float for trigger-like buttons. |
For convenience, additional events are fired including the button index, providing a way to bind events to specific buttons using only markup. For example, to play "pew-pew" sound when Button 7 is pressed (right trigger on an Xbox controller), you might do the following:
<a-entity gamepad-controls
sound="src: pew-pew.wav;
on: gamepadbuttondown:7">
</a-entity>
Finally, your code may call the gamepad-controls component directly to request the state of a button, as a GamepadButton instance:
el.components['gamepad-controls'].getButton(index);
// Returns a GamepadButton instance.
| Property | Default | Description |
|---|---|---|
| controller | 0 | Which controller (0..3) the object should be attached to. |
| enabled | true | Enables all events on this controller. |
| movementEnabled | true | Enables movement via the left thumbstick. |
| lookEnabled | true | Enables view rotation via the right thumbstick. |
| flyEnabled | false | Whether or not movement is restricted to the entity’s initial plane. |
| debug | false | When true, shows debugging info in the console. |
FAQs
Gamepad controls for A-Frame.
The npm package aframe-gamepad-controls receives a total of 8 weekly downloads. As such, aframe-gamepad-controls popularity was classified as not popular.
We found that aframe-gamepad-controls demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.