From b10eb4e1d9339d0eb4e034af3eba4446e5334772 Mon Sep 17 00:00:00 2001 From: ingerjm0 Date: Wed, 20 Mar 2019 10:14:32 -0700 Subject: [PATCH] Add intro page to API docs --- tools/jsdoc/api-mainpage.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 tools/jsdoc/api-mainpage.md diff --git a/tools/jsdoc/api-mainpage.md b/tools/jsdoc/api-mainpage.md new file mode 100644 index 0000000000..504b2c1ed0 --- /dev/null +++ b/tools/jsdoc/api-mainpage.md @@ -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). \ No newline at end of file