Overlays API provides facilities to create and interact with overlays. These are 2D and 3D objects visible
+ * The Overlays API provides facilities to create and interact with overlays. These are 2D and 3D objects visible
* only to yourself and that aren't persisted to the domain. They are used for UI.
*
- * Note: 3D overlays are local {@link Entities}, internally, so many of the methods also work with + *
Note: 3D overlays are local {@link Entities}, internally, so many of the methods also work with * entities.
* * @namespace Overlays @@ -83,8 +83,8 @@ class ParabolaToOverlayIntersectionResult { * @hifi-client-entity * @hifi-avatar * - * @property {Uuid} keyboardFocusOverlay - The{@link Overlays.OverlayProperties-Web3D|"web3d"} overlay
- * ({@link Entities.EntityProperties-Web|Web} entity) that has keyboard focus. If no overlay (entity) has keyboard focus,
+ * @property {Uuid} keyboardFocusOverlay - The {@link Overlays.OverlayProperties-Web3D|"web3d"} overlay
+ * ({@link Entities.EntityProperties-Web|Web} entity) that has keyboard focus. If no overlay (entity) has keyboard focus,
* returns null; set to null or {@link Uuid(0)|Uuid.NULL} to clear keyboard focus.
*/
@@ -152,7 +152,7 @@ public slots:
* @function Overlays.editOverlay
* @param {Uuid} id - The ID of the overlay (or entity) to edit.
* @param {Overlays.OverlayProperties} properties - The properties changes to make.
- * @returns {boolean} false if Interface is exiting. Otherwise, if a 2D overlay then true always,
+ * @returns {boolean} false if Interface is exiting. Otherwise, if a 2D overlay then true always,
* and if a 3D overlay then true if the overlay was found and edited, otherwise false.
* @example {@link Overlays.OverlayProperties-Web3D|"web3d"} overlay's EventBridge script object to
+ * Gets an overlay's (or entity's) script object. In particular, this is useful for accessing a
+ * {@link Overlays.OverlayProperties-Web3D|"web3d"} overlay's EventBridge script object to
* exchange messages with the web page script.
* To send a message from an Interface script to a "web3d" overlay over its event bridge:
var overlayObject = Overlays.getOverlayObject(overlayID);
@@ -250,9 +250,9 @@ public slots:
* // Message received from the script.
* console.log("Message received: " + message);
* }
- *
+ *
* EventBridge.scriptEventReceived.connect(onScriptEventReceived);
- *
+ *
* setInterval(function () {
* // Send a message to the script.
* EventBridge.emitWebEvent("hello");
@@ -260,7 +260,7 @@ public slots:
*
*