## aframe-aabb-collider-component [![Version](http://img.shields.io/npm/v/aframe-aabb-collider-component.svg?style=flat-square)](https://npmjs.org/package/aframe-aabb-collider-component) [![License](http://img.shields.io/npm/l/aframe-aabb-collider-component.svg?style=flat-square)](https://npmjs.org/package/aframe-aabb-collider-component) An axis-aligned bounding box component for A-Frame. Provides collision detection. For [A-Frame](https://aframe.io). ### API | Property | Description | Default Value | | -------- | ----------- | ------------- | | collideNonVisible | Whether to check for collisions against non-visible entities. | false | | debug | Whether to draw bounding box helpers. | false | | enabled | Whether collision checks are running. | true | | objects | Selector of entities to intersection test against. | '' | | interval | Milliseconds in between intersection checks. | 80 | If the target collidable object is moving, set `` on the target. By default, collidable objects are presumed to be static for performance purposes. #### Events | Event | Description | | ----- | ----------- | | hitstart | Intersection between box and another entity. Emitted on both source and target if target does not have AABB. | | hitend | No longer intersecting between box and another entity. Emitted on both source and target if target does not have AABB. | | hitclosest | Intersection between the box and the closest entity from its center. Only one entity is "closest" at a time. | | hitclosestclear | The previously closest intersected entity to the box is no longer the closest entity. | #### Members Accessed via `entity.components['aabb-collider'][]`. | Name | Description | |----------------------|-------------------------------------| | closestIntersectedEl | Closest collided entity. | | intersectedEls | Array of current collided entities. | ### Installation #### Browser Install and use by directly including the [browser files](dist): ```html My A-Frame Scene ``` #### npm Install via npm: ```bash npm install aframe-aabb-collider-component ``` Then require and use. ```js require('aframe'); require('aframe-aabb-collider-component'); ```