diff --git a/README.md b/README.md index 81b6610..dc2dc8d 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,15 @@ For [A-Frame](https://aframe.io). ### API -| Property | Description | Default Value | -| --- | --- | --- | -| cameraRig | Selector of the camera rig to teleport | | -| cameraHead | Selector of the scene's active camera || -| collisionEntities | Selector of the meshes used to check the collisions. If no value provided a plane at Y=0 is used. | | -| defaultPlaneSize | Size of the default plane created for collision when `collisionEntities` is not specified | 100 | -| ignoreEntities | Selector of meshes that may obstruct the teleport raycaster, like UI or other clickable elements. -| landingNormal | Normal vector to detect collisions with the `collisionEntities` | (0, 1, 0) | -| landingMaxAngle | Angle threshold (in degrees) used together with `landingNormal` to detect if the mesh is so steep to jump to it. | 45 +| Property | Description | Default Value | +| ----------------- | ---------------------------------------------------------------------------------------------------------------- | ------------- | +| cameraRig | Selector of the camera rig to teleport | | +| cameraHead | Selector of the scene's active camera | | +| collisionEntities | Selector of the meshes used to check the collisions. If no value provided a plane at Y=0 is used. | | +| defaultPlaneSize | Size of the default plane created for collision when `collisionEntities` is not specified | 100 | +| ignoreEntities | Selector of meshes that may obstruct the teleport raycaster, like UI or other clickable elements. | | +| landingNormal | Normal vector to detect collisions with the `collisionEntities` | (0, 1, 0) | +| landingMaxAngle | Angle threshold (in degrees) used together with `landingNormal` to detect if the mesh is so steep to jump to it. | 45 | ### Events @@ -71,10 +71,9 @@ require('aframe-cursor-teleport-component'); ```html - - - - + + + ``` @@ -84,13 +83,17 @@ To add collision objects, simply identify them with a selector: ```html - - - - - - - + + + + + + + ``` @@ -99,17 +102,30 @@ To add collision objects, simply identify them with a selector: If your scene has interactive entities that should not initiate a teleport when clicked, you can add them to the ignoredEntities array using a selector: ```html - - - - - - - - - - - + + + + + + + + + + + ``` @@ -119,18 +135,41 @@ This component works with [aframe-blink-controls](https://github.com/jure/aframe ```html - - - - - - - - - - - - + + + + + + + + + + + + ``` @@ -141,28 +180,32 @@ You can do that like this: ```html ``` Then add `character-controller` component to your cameraRig entity. You also probably want to add `.navmesh-hole` to the `cursor-teleport`'s `ignoreEntities`: ```html - - + + ```