Mirrors/overte-AleziaKurdis
3
0
Fork 0
mirror of https://github.com/AleziaKurdis/overte.git synced 2025-04-07 13:12:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add intro page to API docs

Browse source
This commit is contained in:
ingerjm0 2019-03-20 10:14:32 -07:00
parent 5271d2b7c8
commit b10eb4e1d9
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
tools/jsdoc/api-mainpage.md Normal file
View file

@ -0,0 +1,9 @@
The High Fidelity JavaScript API lets content creators and developers create new experiences and transform virtual worlds within the High Fidelity metaverse. With it, you can build great content, customize avatars, play audio and so much more.
You are most likely to interact with these APIs:
* The **[Entities](Entities.html)** namespace lets creators add, remove, and edit entities around you to build an interactive environment. In addition, everyone has access to the `get` properties of an entity, which can be used to find entities in range, direction, collision, or raytrace.
* The **[AvatarList](AvatarList.html)**, **[MyAvatar](MyAvatar.html)**, and **[Avatar](Avatar.html)** namespaces affect your personal avatars, and lets you get information on other people's avatars.
* The **[Script](Script.html)** namespace lets you to connect callbacks from your client to script, such as functionality that is dependent on time (`Script.update`, `Script.setTimeout`, `Script.setInterval`, etc), connect paths relatively to Assets (`Script.relativePath`), refer to other scripts (`Script.require`, `Script.include`), or create events which occur when the script is turned off (`Script.scriptEnding`).
To learn more about using High Fidelity and exploring the metaverse, visit the [High Fidelity Documentation](https://docs.highfidelity.com).