@needle-tools/engine 4.14.0-beta → 4.14.0-next.52fdb13

package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.d.ts

@@ -9,21 +9,32 @@ import { AnimationExtension, RegisteredAnimationInfo, type UsdzAnimation } from
 import type { BehaviorExtension, UsdzBehaviour } from "./Behaviour.js";
 import { EmphasizeActionMotionType, GroupActionModel, Target } from "./BehavioursBuilder.js";
 /**
- * Make the object move to the target object's transform when clicked.
+ * Moves an object to the target object's transform when clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * @see {@link SetActiveOnClick}to toggle visibility of objects when clicked
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Moves an object to a target transform upon click
  * @category Everywhere Actions
  * @group Components
  */
 export declare class ChangeTransformOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
+    /** The object to move. */
     object?: Object3D;
+    /** The target object whose transform to move to. */
     target?: Object3D;
+    /** The duration of the movement animation in seconds. */
     duration: number;
+    /** If true, the motion is relative to the object's current transform instead of moving to the target's absolute position. */
     relativeMotion: boolean;
     private coroutine;
     private targetPos;
     private targetRot;
     private targetScale;
-    start(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
     onPointerEnter(): void;
     onPointerExit(): void;
     onPointerClick(args: PointerEventData): void;
@@ -32,7 +43,15 @@ export declare class ChangeTransformOnClick extends Behaviour implements IPointe
     beforeCreateDocument(ext: any): void;
 }
 /**
- * Change the material of objects when clicked.
+ * Switches the material of objects in the scene when clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Finds all objects in the scene that use `materialToSwitch` and replaces it with `variantMaterial`.
+ * Multiple `ChangeMaterialOnClick` components using the same `materialToSwitch` can be combined to create a material selection UI.
+ *
+ * @see {@link SetActiveOnClick} to toggle visibility of objects when clicked
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Changes the material of objects when clicked
  * @category Everywhere Actions
  * @group Components
@@ -52,6 +71,9 @@ export declare class ChangeMaterialOnClick extends Behaviour implements IPointer
      */
     fadeDuration: number;
     start(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
     onPointerEnter(_args: PointerEventData): void;
     onPointerExit(_: PointerEventData): void;
     onPointerClick(args: PointerEventData): void;
@@ -72,17 +94,28 @@ export declare class ChangeMaterialOnClick extends Behaviour implements IPointer
     private createVariants;
 }
 /**
- * Set the active state of an object when clicked.
+ * Shows or hides a target object when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Optionally hides itself after being clicked (`hideSelf`), or toggles the target's visibility on each click (`toggleOnClick`).
+ *
+ * @see {@link HideOnStart}to hide an object when the scene starts
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link ChangeMaterialOnClick} to change material when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Sets the active state of an object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export declare class SetActiveOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
+    /** The target object to show or hide. */
     target?: Object3D;
+    /** If true, the target's visibility will be toggled on each click. When enabled, `hideSelf` and `targetState` are ignored. */
     toggleOnClick: boolean;
+    /** The visibility state to apply to the target when clicked. Only used when `toggleOnClick` is false. */
     targetState: boolean;
+    /** If true, this object will hide itself after being clicked. Only used when `toggleOnClick` is false. */
     hideSelf: boolean;
-    start(): void;
     onPointerEnter(): void;
     onPointerExit(): void;
     onPointerClick(args: PointerEventData): void;
@@ -102,7 +135,13 @@ export declare class SetActiveOnClick extends Behaviour implements IPointerClick
     afterSerialize(_ext: BehaviorExtension, _context: USDZExporterContext): void;
 }
 /**
- * Hides the object on scene start.
+ * Hides the object when the scene starts.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Useful for setting up objects that should initially be hidden and shown later via a {@link SetActiveOnClick} component.
+ *
+ * @see {@link SetActiveOnClick} to show or hide objects on click
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Hides the object on scene start
  * @category Everywhere Actions
  * @group Components
@@ -117,50 +156,93 @@ export declare class HideOnStart extends Behaviour implements UsdzBehaviour {
     beforeCreateDocument(): void;
 }
 /**
- * Emphasize the target object when clicked.
+ * Applies an emphasis animation to a target object when this object is clicked.
+ * Works in USDZ/QuickLook (Everywhere Actions).
+ *
+ * The emphasis effect can be a bounce, jiggle, or other motion type defined by `motionType`.
+ *
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Emphasizes the target object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export declare class EmphasizeOnClick extends Behaviour implements UsdzBehaviour {
+    /** The target object to emphasize. */
     target?: Object3D;
+    /** The duration of the emphasis animation in seconds. */
     duration: number;
+    /** The type of motion to use for the emphasis effect (e.g. `"bounce"`, `"jiggle"`). */
     motionType: EmphasizeActionMotionType;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
     beforeCreateDocument(): void;
     createBehaviours(ext: any, model: any, _context: any): void;
     afterCreateDocument(_ext: any, _context: any): void;
 }
 /**
- * Plays an audio clip when clicked.
+ * Plays an audio clip when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Assign a `target` {@link AudioSource} to use its spatial audio settings, or assign a `clip` URL directly.
+ * If no `target` is assigned, an {@link AudioSource} will be created automatically on this object.
+ *
+ * @see {@link AudioSource}for spatial audio settings
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Plays an audio clip when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export declare class PlayAudioOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour {
+    /** The {@link AudioSource} to use for playback. If not set, one will be created automatically on this object. */
     target?: AudioSource;
+    /** URL of the audio clip to play. If not set, the clip assigned to `target` is used. */
     clip: string;
+    /** If true, clicking again while the audio is playing will stop it. */
     toggleOnClick: boolean;
     trigger: "tap" | "start";
-    start(): void;
     ensureAudioSource(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
     onPointerEnter(): void;
     onPointerExit(): void;
     onPointerClick(args: PointerEventData): void;
     createBehaviours(ext: BehaviorExtension, model: USDObject, _context: USDZExporterContext): void;
 }
 /**
- * Plays an animation when clicked.
+ * Plays an animation state when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Assign an {@link Animator} and a `stateName` to play a specific animation state,
+ * or assign an {@link Animation} component to play a legacy animation clip.
+ *
+ * For USDZ export, the component follows animator state transitions automatically, including looping states.
+ *
+ * @see {@link Animator}for playing animator state machine animations
+ * @see {@link Animation} for playing legacy animation clips
+ * @see {@link PlayAudioOnClick} to play audio when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Plays an animation when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export declare class PlayAnimationOnClick extends Behaviour implements IPointerClickHandler, UsdzBehaviour, UsdzAnimation {
+    /** The {@link Animator} component whose state to play when clicked. */
     animator?: Animator;
+    /** The name of the animation state to play. Required when using an {@link Animator}. */
     stateName?: string;
     trigger: "tap" | "start";
     animation?: Animation;
     private get target();
-    start(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
     onPointerEnter(): void;
     onPointerExit(): void;
     onPointerClick(args: PointerEventData): void;
@@ -191,19 +273,31 @@ export declare class PreliminaryTrigger extends Behaviour {
     target?: PreliminaryAction;
 }
 /**
- * Hides or shows the object when clicked.
+ * Action to show or hide an object.
+ * Use together with a {@link TapGestureTrigger} to show or hide objects when tapped or clicked.
+ *
+ * @see {@link TapGestureTrigger} to trigger actions on tap/click
+ * @see {@link SetActiveOnClick} for a combined trigger and action component
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Hides or shows the object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export declare class VisibilityAction extends PreliminaryAction {
+    /** The type of visibility action to apply. */
     type: VisibilityActionType;
+    /** The duration of the fade animation in seconds. */
     duration: number;
     getType(): "show" | "hide";
     getDuration(): number;
 }
 /**
- * Triggers an action when the object is tapped/clicked.
+ * Triggers a {@link PreliminaryAction} (such as {@link VisibilityAction}) when the object is tapped or clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * @see {@link VisibilityAction} for controlling object visibility on tap
+ * @see {@link SetActiveOnClick} for a combined trigger and action component
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Triggers an action when the object is tapped/clicked
  * @category Everywhere Actions
  * @group Components

package/lib/engine-components/export/usdz/extensions/behavior/BehaviourComponents.js

@@ -16,38 +16,49 @@ import { Animator } from "../../../../Animator.js";
 import { AudioSource } from "../../../../AudioSource.js";
 import { Behaviour, GameObject } from "../../../../Component.js";
 import { Rigidbody } from "../../../../RigidBody.js";
-import { ObjectRaycaster, Raycaster } from "../../../../ui/Raycaster.js";
 import { makeNameSafeForUSD, USDDocument, USDObject } from "../../ThreeUSDZExporter.js";
 import { AnimationExtension } from "../Animation.js";
 import { AudioExtension } from "./AudioExtension.js";
 import { ActionBuilder, BehaviorModel, TriggerBuilder } from "./BehavioursBuilder.js";
 const debug = getParam("debugusdzbehaviours");
-function ensureRaycaster(obj) {
-    if (!obj)
-        return;
-    if (!obj.getComponentInParent(Raycaster)) {
-        if (isDevEnvironment())
-            console.debug("Raycaster on \"" + obj.name + "\" was automatically added, because no raycaster was found in the parent hierarchy.");
-        obj.addComponent(ObjectRaycaster);
-    }
-}
 /**
- * Make the object move to the target object's transform when clicked.
+ * Moves an object to the target object's transform when clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * @see {@link SetActiveOnClick}to toggle visibility of objects when clicked
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Moves an object to a target transform upon click
  * @category Everywhere Actions
  * @group Components
  */
 export class ChangeTransformOnClick extends Behaviour {
+    /** The object to move. */
     object;
+    /** The target object whose transform to move to. */
     target;
+    /** The duration of the movement animation in seconds. */
     duration = 1;
+    /** If true, the motion is relative to the object's current transform instead of moving to the target's absolute position. */
     relativeMotion = false;
     coroutine = null;
     targetPos = new Vector3();
     targetRot = new Quaternion();
     targetScale = new Vector3();
-    start() {
-        ensureRaycaster(this.gameObject);
+    onEnable() {
+        this.context.accessibility.updateElement(this, {
+            role: "button",
+            label: "Move " + (this.object?.name || "object") + " to " + (this.target?.name || "target") + " on click",
+            hidden: false,
+        });
+    }
+    onDisable() {
+        this.context.accessibility.updateElement(this, {
+            hidden: true,
+        });
+    }
+    onDestroy() {
+        this.context.accessibility.removeElement(this);
     }
     onPointerEnter() {
         this.context.input.setCursor("pointer");
@@ -159,7 +170,15 @@ __decorate([
     serializable()
 ], ChangeTransformOnClick.prototype, "relativeMotion", void 0);
 /**
- * Change the material of objects when clicked.
+ * Switches the material of objects in the scene when clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Finds all objects in the scene that use `materialToSwitch` and replaces it with `variantMaterial`.
+ * Multiple `ChangeMaterialOnClick` components using the same `materialToSwitch` can be combined to create a material selection UI.
+ *
+ * @see {@link SetActiveOnClick} to toggle visibility of objects when clicked
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Changes the material of objects when clicked
  * @category Everywhere Actions
  * @group Components
@@ -181,11 +200,25 @@ export class ChangeMaterialOnClick extends Behaviour {
     start() {
         // initialize the object list
         this._objectsWithThisMaterial = this.objectsWithThisMaterial;
-        ensureRaycaster(this.gameObject);
         if (isDevEnvironment() && this._objectsWithThisMaterial.length <= 0) {
             console.warn("ChangeMaterialOnClick: No objects found with material \"" + this.materialToSwitch?.name + "\"");
         }
     }
+    onEnable() {
+        this.context.accessibility.updateElement(this, {
+            role: "button",
+            label: "Change material to " + (this.variantMaterial?.name || "unknown material"),
+            hidden: false,
+        });
+    }
+    onDisable() {
+        this.context.accessibility.updateElement(this, {
+            hidden: true,
+        });
+    }
+    onDestroy() {
+        this.context.accessibility.removeElement(this);
+    }
     onPointerEnter(_args) {
         this.context.input.setCursor("pointer");
     }
@@ -333,19 +366,28 @@ __decorate([
     serializable()
 ], ChangeMaterialOnClick.prototype, "fadeDuration", void 0);
 /**
- * Set the active state of an object when clicked.
+ * Shows or hides a target object when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Optionally hides itself after being clicked (`hideSelf`), or toggles the target's visibility on each click (`toggleOnClick`).
+ *
+ * @see {@link HideOnStart}to hide an object when the scene starts
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link ChangeMaterialOnClick} to change material when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Sets the active state of an object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export class SetActiveOnClick extends Behaviour {
+    /** The target object to show or hide. */
     target;
+    /** If true, the target's visibility will be toggled on each click. When enabled, `hideSelf` and `targetState` are ignored. */
     toggleOnClick = false;
+    /** The visibility state to apply to the target when clicked. Only used when `toggleOnClick` is false. */
     targetState = true;
+    /** If true, this object will hide itself after being clicked. Only used when `toggleOnClick` is false. */
     hideSelf = true;
-    start() {
-        ensureRaycaster(this.gameObject);
-    }
     onPointerEnter() {
         this.context.input.setCursor("pointer");
     }
@@ -533,7 +575,13 @@ __decorate([
     serializable()
 ], SetActiveOnClick.prototype, "hideSelf", void 0);
 /**
- * Hides the object on scene start.
+ * Hides the object when the scene starts.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Useful for setting up objects that should initially be hidden and shown later via a {@link SetActiveOnClick} component.
+ *
+ * @see {@link SetActiveOnClick} to show or hide objects on click
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Hides the object on scene start
  * @category Everywhere Actions
  * @group Components
@@ -573,15 +621,40 @@ export class HideOnStart extends Behaviour {
     }
 }
 /**
- * Emphasize the target object when clicked.
+ * Applies an emphasis animation to a target object when this object is clicked.
+ * Works in USDZ/QuickLook (Everywhere Actions).
+ *
+ * The emphasis effect can be a bounce, jiggle, or other motion type defined by `motionType`.
+ *
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Emphasizes the target object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export class EmphasizeOnClick extends Behaviour {
+    /** The target object to emphasize. */
     target;
+    /** The duration of the emphasis animation in seconds. */
     duration = 0.5;
+    /** The type of motion to use for the emphasis effect (e.g. `"bounce"`, `"jiggle"`). */
     motionType = "bounce";
+    onEnable() {
+        this.context.accessibility.updateElement(this, {
+            role: "button",
+            label: "Emphasize " + this.target?.name + " on click",
+            hidden: false,
+        });
+    }
+    onDisable() {
+        this.context.accessibility.updateElement(this, {
+            hidden: true,
+        });
+    }
+    onDestroy() {
+        this.context.accessibility.removeElement(this);
+    }
     beforeCreateDocument() { }
     createBehaviours(ext, model, _context) {
         if (!this.target)
@@ -603,20 +676,29 @@ __decorate([
     serializable()
 ], EmphasizeOnClick.prototype, "motionType", void 0);
 /**
- * Plays an audio clip when clicked.
+ * Plays an audio clip when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Assign a `target` {@link AudioSource} to use its spatial audio settings, or assign a `clip` URL directly.
+ * If no `target` is assigned, an {@link AudioSource} will be created automatically on this object.
+ *
+ * @see {@link AudioSource}for spatial audio settings
+ * @see {@link PlayAnimationOnClick} to play animations when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Plays an audio clip when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export class PlayAudioOnClick extends Behaviour {
+    /** The {@link AudioSource} to use for playback. If not set, one will be created automatically on this object. */
     target;
+    /** URL of the audio clip to play. If not set, the clip assigned to `target` is used. */
     clip = "";
+    /** If true, clicking again while the audio is playing will stop it. */
     toggleOnClick = false;
     // Not exposed, but used for implicit playback of PlayOnAwake audio sources
     trigger = "tap";
-    start() {
-        ensureRaycaster(this.gameObject);
-    }
     ensureAudioSource() {
         if (!this.target) {
             const newAudioSource = this.gameObject.addComponent(AudioSource);
@@ -629,6 +711,21 @@ export class PlayAudioOnClick extends Behaviour {
             }
         }
     }
+    onEnable() {
+        this.context.accessibility.updateElement(this, {
+            role: "button",
+            label: "Play audio: " + (this.clip || this.target?.clip || "unknown clip"),
+            hidden: false,
+        });
+    }
+    onDisable() {
+        this.context.accessibility.updateElement(this, {
+            hidden: true,
+        });
+    }
+    onDestroy() {
+        this.context.accessibility.removeElement(this);
+    }
     onPointerEnter() {
         this.context.input.setCursor("pointer");
     }
@@ -716,13 +813,27 @@ __decorate([
     serializable()
 ], PlayAudioOnClick.prototype, "toggleOnClick", void 0);
 /**
- * Plays an animation when clicked.
+ * Plays an animation state when this object is clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * Assign an {@link Animator} and a `stateName` to play a specific animation state,
+ * or assign an {@link Animation} component to play a legacy animation clip.
+ *
+ * For USDZ export, the component follows animator state transitions automatically, including looping states.
+ *
+ * @see {@link Animator}for playing animator state machine animations
+ * @see {@link Animation} for playing legacy animation clips
+ * @see {@link PlayAudioOnClick} to play audio when clicked
+ * @see {@link SetActiveOnClick} to toggle visibility when clicked
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Plays an animation when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export class PlayAnimationOnClick extends Behaviour {
+    /** The {@link Animator} component whose state to play when clicked. */
     animator;
+    /** The name of the animation state to play. Required when using an {@link Animator}. */
     stateName;
     // Not editable from the outside yet, but from code
     // we want to expose this once we have a nice drawer for "Triggers" (e.g. shows proximity distance)
@@ -730,11 +841,24 @@ export class PlayAnimationOnClick extends Behaviour {
     trigger = "tap"; // "proximity"
     animation;
     get target() { return this.animator?.gameObject || this.animation?.gameObject; }
-    start() {
-        ensureRaycaster(this.gameObject);
+    onEnable() {
+        this.context.accessibility.updateElement(this, {
+            role: "button",
+            label: "Plays animation " + (this.stateName || "") + " on " + (this.target ? this.target.name : ""),
+            hidden: false
+        });
+    }
+    onDisable() {
+        this.context.accessibility.updateElement(this, {
+            hidden: true,
+        });
+    }
+    onDestroy() {
+        this.context.accessibility.removeElement(this);
     }
     onPointerEnter() {
         this.context.input.setCursor("pointer");
+        this.context.accessibility.hover(this, "Click to play animation " + (this.stateName || "") + " on " + (this.target ? this.target.name : ""));
     }
     onPointerExit() {
         this.context.input.unsetCursor("pointer");
@@ -744,6 +868,7 @@ export class PlayAnimationOnClick extends Behaviour {
         if (!this.target)
             return;
         if (this.stateName) {
+            this.context.accessibility.focus(this);
             // TODO this is currently quite annoying to use,
             // as for the web we use the Animator component and its states directly,
             // while in QuickLook we use explicit animations / states.
@@ -1070,14 +1195,21 @@ __decorate([
     serializable(PreliminaryAction)
 ], PreliminaryTrigger.prototype, "target", void 0);
 /**
- * Hides or shows the object when clicked.
+ * Action to show or hide an object.
+ * Use together with a {@link TapGestureTrigger} to show or hide objects when tapped or clicked.
+ *
+ * @see {@link TapGestureTrigger} to trigger actions on tap/click
+ * @see {@link SetActiveOnClick} for a combined trigger and action component
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Hides or shows the object when clicked
  * @category Everywhere Actions
  * @group Components
  */
 export class VisibilityAction extends PreliminaryAction {
+    /** The type of visibility action to apply. */
     //@type int
     type = VisibilityActionType.Hide;
+    /** The duration of the fade animation in seconds. */
     duration = 1;
     getType() {
         switch (this.type) {
@@ -1096,7 +1228,12 @@ __decorate([
     serializable()
 ], VisibilityAction.prototype, "duration", void 0);
 /**
- * Triggers an action when the object is tapped/clicked.
+ * Triggers a {@link PreliminaryAction} (such as {@link VisibilityAction}) when the object is tapped or clicked.
+ * Works in the browser and in USDZ/QuickLook (Everywhere Actions).
+ *
+ * @see {@link VisibilityAction} for controlling object visibility on tap
+ * @see {@link SetActiveOnClick} for a combined trigger and action component
+ * @see [Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions)
  * @summary Triggers an action when the object is tapped/clicked
  * @category Everywhere Actions
  * @group Components