Skip to content

Commit

Permalink
Remove jump-ability toggle-velocity kinematic-body from misc README
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentfretin committed Nov 18, 2023
1 parent 62f5f46 commit d564aad
Showing 1 changed file with 0 additions and 9 deletions.
9 changes: 0 additions & 9 deletions src/misc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@ Various other components.

- **checkpoint**: Target for [checkpoint-controls](/src/controls/checkpoint-controls.js).
- **grab**: When used on one or both hands, lets the player pick up objects with `hand-controls`. Requires `sphere-collider` and using CANNON physics.
- **jump-ability**: Allows player to jump using keyboard or gamepad, when physics is enabled. *Not VR-friendly*.
- **normal-material**: Applies a MeshNormalMaterial to the entity, such that face colors are determined by their orientation. Helpful for debugging geometry.
- **sphere-collider**: Detects collisions with specified objects. Required for `grab`.
- **toggle-velocity**: Animates an object back and forth between two points, at a constant velocity.
- **cube-env-map**: Applies a CubeTexture as the envMap of an entity, without otherwise modifying the preset materials.
- **kinematic-body**: Constraints player movement using physics. *Deprecated — see below.*

## `cube-env-map`

Expand All @@ -30,9 +27,3 @@ Usage:
| extension | File extension for each cubemap image. |
| reflectivity | Amount [0,1] of the cubemap that should be reflected. |
| materials | Names of materials to be modified. Defaults to all materials. |

## `kinematic-body` (Deprecated)

> **WARNING** *Using physics for movement is unstable and performs poorly. When preventing players from passing through obstacles, use a navigation mesh instead whenever possible.*
The `kinematic-body` component constraints player movement using physics, and depends on [aframe-physics-system](http://github.com/donmccurdy/aframe-physics-system/). Using physics for locomotion is not VR-friendly, and often glitchy even for traditional 3D experiences. [Use a navigation mesh](https://github.com/donmccurdy/aframe-extras/tree/master/src/controls#usage) instead, whenever possible.

0 comments on commit d564aad

Please sign in to comment.