Skip to main content

High Fidelity API Reference

Tools Used: JavaScript, JSDoc, GitHub Pages, Markdown, HTML, CSS

warning

High Fidelity is available as an open-source platform, and all content is forked and hosted according to the distribution requirements set out in the Apache License 2.0.

This is a sample of High Fidelity's API documentation, forked and imported into this website. The content matches the original, but the formatting and theme have been adjusted to compile with Docusaurus.


High Fidelity API Reference

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:

NamespaceDescription
EntitiesAdd, remove, and edit entities around you to build an interactive environment. In addition, use this namespace to find entities in range, direction, collision, or raytrace.

MyAvatar

Manipulate your personal avatars and get information on other people's avatars.
ScriptConnect callbacks from your client to script, connect paths relatively to assets, refer to other scripts, or connect functions to events which occur when the script is turned off.