Nullifying Precipitation Machine
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

aframe-haptics-component

1.6.1 • Public • Published

aframe-haptics-component

Version License

A controller haptics (vibrations) component for A-Frame. Supported by experimental Gamepad Extensions. Read about browser support.

Demo

API

Property Description Default Value
actuatorIndex Index of the actuator from the gamepad's array of actuators. 0
dur Duration of vibration pulse (milliseconds). 100
enabled Whether the component should pulse on the event. true
events Array of events to listen for to trigger a pulse (e.g., triggerdown, triggerup) []
eventsFrom Target entity to listen for events if other than the controller entity. this.el
force Intensity of pulse (from 0 to 1) 1

Methods

Name Description
pulse Manually trigger pulse (can pass in force and duration as arguments, defaults data-defined duration and force).
this.el.components.haptics.pulse();
 
// function pulse (force, duration)
this.el.components.haptics.pulse(0.5, 200);

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.9.0/aframe.min.js"></script> 
  <script src="https://unpkg.com/aframe-haptics-component/dist/aframe-haptics-component.min.js"></script> 
</head>
 
<body>
  <a-scene>
    <a-entity hand-controls="left"  haptics="events: triggerdown; dur: 1000; force: 0.5"></a-entity>
    <a-entity hand-controls="right" haptics="events: triggerdown; dur: 500; force: 1.0"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-haptics-component

Then require and use.

require('aframe');
require('aframe-haptics-component');

Install

npm i aframe-haptics-component

DownloadsWeekly Downloads

324

Version

1.6.1

License

MIT

Unpacked Size

24.6 kB

Total Files

13

Last publish

Collaborators

  • avatar