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.

---

EntityViewer

• Methods • Method Details •

The EntityViewer API provides a headless viewer for assignment client scripts, so that they can "see" entities in order for them to be available in the Entities API.

Supported Script Types: Assignment Client Scripts

---

Methods

Name	Return Value	Summary
getMaxPacketsPerSecond	number	Gets the maximum number of entity packets to receive from the domain server per second.
getOctreeElementsCount	number	Gets the number of nodes in the octree.
getOrientation	Quat	Gets the orientation of the view frustum.
getPosition	Vec3	Gets the position of the view frustum.
queryOctree	None	Updates the entities currently in view.
setCenterRadius	None	Sets the radius of the center "keyhole" in the view frustum.
setKeyholeRadius	None	Sets the radius of the center "keyhole" in the view frustum. Deprecated: This function is deprecated and will be removed. Use setCenterRadius instead.
setMaxPacketsPerSecond	None	Sets the maximum number of entity packets to receive from the domain server per second.
setOrientation	None	Sets the orientation of the view frustum.
setPosition	None	Sets the position of the view frustum.

---

Method Details

getMaxPacketsPerSecond (static) getMaxPacketsPerSecond( ) → { number } Returns: The maximum number of entity packets to receive per second.
Gets the maximum number of entity packets to receive from the domain server per second.

getOctreeElementsCount (static) getOctreeElementsCount( ) → { number } Returns: The number of nodes in the octree.
Gets the number of nodes in the octree.

getOrientation (static) getOrientation( ) → Quat Returns: The orientation of the view frustum.
Gets the orientation of the view frustum.

getPosition (static) getPosition( ) → Vec3 Returns: The position of the view frustum.
Gets the position of the view frustum.

queryOctree (static) queryOctree( )
Updates the entities currently in view.

setCenterRadius (static) setCenterRadius( radius )
Sets the radius of the center "keyhole" in the view frustum. Parameters Name Type Description radius number The radius of the center "keyhole" in the view frustum.

setKeyholdRadius (static) setKeyholeRadius( radius )
Sets the radius of the center "keyhole" in the view frustum. Deprecated: This function is deprecated and will be removed. Use setCenterRadius instead.

setMaxPacketsPerSecond (static) setMaxPacketsPerSecond( maxPacketsPerSecond )
Sets the maximum number of entity packets to receive from the domain server per second. Parameters Name Type Description maxPacketsPerSecond number The maximum number of entity packets to receive per second.

setOrientation (static) setOrientation( orientation )
Sets the orientation of the view frustum. Parameters Name Type Description orientation Quat The orientation of the view frustum.

setPosition (static) setPosition( position )
Sets the position of the view frustum. Parameters Name Type Description position Vec3 The position of the view frustum.