@needle-tools/engine 4.11.5-next.53316bf → 4.11.5-next.6ab130e

package/dist/needle-engine.d.ts

@@ -220,6 +220,15 @@ export declare class Addressables {
 /**[documentation](https://developer.apple.com/documentation/arkit/usdz_schemas_for_ar/preliminary_anchoringapi/preliminary_planeanchoring_alignment) */
 declare type Alignment = "horizontal" | "vertical" | "any";
 
+/**
+ * Aligns this GameObject between two other GameObjects, scaling it to fit the distance.
+ * You can use this to create dynamic beams or connectors between objects.
+ *
+ * @summary Aligns and scales the object between two target GameObjects
+ * @category Utility
+ * @group Components
+
+ **/
 export declare class AlignmentConstraint extends Component {
     private from;
     private to;
@@ -1162,6 +1171,9 @@ export declare class AssetReference {
  * attractor.strength = 5; // positive value to attract
  * attractor.radius = 10; // only attract within 10 units
  * attractor.targets.push(rigidbody); // add the Rigidbody to be attracted
+ * @summary Attract Rigidbodies towards the position of this component
+ * @category Physics
+ * @group Components
  */
 export declare class Attractor extends Component {
     strength: number;
@@ -1197,6 +1209,8 @@ export declare class AudioExtension implements IUSDExporterExtension {
  * AudioListener represents a listener that can hear audio sources in the scene.
  * This component creates and manages a Three.js {@link three#AudioListener}, automatically connecting it
  * to the main camera or a Camera in the parent hierarchy.
+ *
+ * @summary Audio listener for 3D audio capture
  * @category Multimedia
  * @group Components
  */
@@ -1252,6 +1266,7 @@ declare enum AudioRolloffMode {
  * is muted, the volume is set to 0. When unmuted, the volume
  * returns to its previous value.
  *
+ * @summary 3D audio source with spatial positioning and playback controls
  * @category Multimedia
  * @group Components
  */
@@ -1458,6 +1473,11 @@ export declare class AudioTrackHandler extends TrackHandler {
 /* Excluded from this release type: AuralMode */
 
 /**
+ * Avatar component to setup a WebXR avatar with head and hand objects.
+ *
+ * The avatar will automatically synchronize the head and hand objects with the XR rig when entering an XR session.
+ *
+ * @summary WebXR Avatar component for head and hands synchronization
  * @category XR
  * @category Networking
  * @group Components
@@ -1608,6 +1628,8 @@ export declare enum Axes {
 /**
  * Component that visualizes the axes of an object in the scene.
  * Renders colored lines representing the X (red), Y (green) and Z (blue) axes.
+ *
+ * @summary Visualizes object axes in the scene
  * @category Helpers
  * @group Components
  */
@@ -1812,6 +1834,7 @@ export declare namespace BlobStorage {
  * volume.add(bloom);
  * ```
  *
+ * @summary Bloom Post-Processing Effect
  * @category Effects
  * @group Components
  */
@@ -1959,6 +1982,10 @@ export declare const BUILD_TIME: string;
 export declare const builtinComponentKeyName = "builtin_components";
 
 /**
+ * Button is a UI component that can be clicked by the user to perform an action.
+ * It supports different visual states such as normal, highlighted, pressed, and disabled.
+ * You can customize the button's appearance using colors or animations for each state.
+ * @summary Button UI Component
  * @category User Interface
  * @group Components
  */
@@ -2127,6 +2154,7 @@ export declare class CallInfo {
  * Supports both perspective and orthographic cameras with various rendering options.
  * Internally, this component uses {@link PerspectiveCamera} and {@link OrthographicCamera} three.js objects.
  *
+ * @summary Camera rendering scenes from a specific viewpoint
  * @category Camera
  * @group Components
  */
@@ -2340,6 +2368,11 @@ export declare class CameraTargetReachedEvent extends CustomEvent<{
 }
 
 /**
+ * Canvas is the root component for all UI elements in a scene.
+ * It defines the area where UI elements are rendered and manages their layout and rendering settings.
+ * Canvases can be set to render in world space or screen space (overlay or camera).
+ * Multiple canvases can exist in a scene, each with its own settings and hierarchy of UI elements.
+ * @summary Canvas UI Component
  * @category User Interface
  * @group Components
  */
@@ -2405,6 +2438,10 @@ export declare class Canvas extends UIRootComponent implements ICanvas {
 }
 
 /**
+ * CanvasGroup is a UI component that allows you to control the transparency and interactivity of a group of UI elements.
+ * By adjusting the alpha property, you can fade in or out all child UI elements simultaneously.
+ * The interactable and blocksRaycasts properties let you enable or disable user interaction for the entire group.
+ * @summary CanvasGroup UI Component
  * @category User Interface
  * @group Components
  */
@@ -2453,6 +2490,8 @@ export declare class CapsuleCollider extends Collider {
 }
 
 /**
+ * Change the material of objects when clicked.
+ * @summary Changes the material of objects when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -2492,6 +2531,8 @@ export declare class ChangeMaterialOnClick extends Component implements IPointer
 }
 
 /**
+ * Make the object move to the target object's transform when clicked.
+ * @summary Moves an object to a target transform upon click
  * @category Everywhere Actions
  * @group Components
  */
@@ -2514,7 +2555,10 @@ export declare class ChangeTransformOnClick extends Component implements IPointe
 }
 
 /**
- * @category Camera
+ * CharacterController adds a capsule collider and rigidbody to the object, constrains rotation, and provides movement and grounded state.
+ * It is designed for typical character movement in 3D environments.
+ * @summary Character Movement Controller
+ * @category Character
  * @group Components
  */
 export declare class CharacterController extends Component {
@@ -2566,6 +2610,10 @@ export declare class CharacterControllerInput extends Component {
 }
 
 /**
+ * Chromatic Aberration effect simulates the color fringing effect seen in real-world cameras.
+ * It offsets the red, green, and blue color channels to create a distorted, colorful edge around objects.
+ * This effect can enhance the visual appeal of scenes by adding a subtle or pronounced chromatic distortion.
+ * @summary Chromatic Aberration Post-Processing Effect
  * @category Effects
  * @group Components
  */
@@ -2631,7 +2679,7 @@ export { clearMessages as clearOverlayMessages }
  * - Alternatively, add the `clickthrough` attribute to the `<needle-engine>` HTML element (e.g. `<needle-engine clickthrough></needle-engine>`).
  *
  * - Example https://stackblitz.com/~/github.com/needle-engine/sample-3d-over-html
- *
+ * @summary Allows pointer events to "click through" the 3D canvas to HTML elements behind it.
  * @category Web
  * @group Components
  * @component
@@ -2772,6 +2820,9 @@ declare type Color4 = {
 };
 
 /**
+ * Color Adjustments effect allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.
+ * These adjustments can be used to enhance the visual aesthetics of the scene or to achieve specific artistic effects.
+ * @summary Color Adjustments Post-Processing Effect
  * @category Effects
  * @group Components
  */
@@ -4006,6 +4057,7 @@ export declare function createMotion(name: string, id?: InstantiateIdProvider):
  *
  * - Example: [Look At Cursor sample](https://engine.needle.tools/samples/look-at-cursor-interactive-3d-header/). This sample combines the CursorFollow component with a LookAt component to create an interactive 3D header that looks at the cursor.
  *
+ * @summary Makes the object follow the cursor position on screen
  * @category Web
  * @group Components
  * @component
@@ -4159,6 +4211,8 @@ export declare class Deletable extends Component {
 
 /**
  * A box-shaped area that can be used to delete objects that get into it. Useful for sandbox-style builders or physics simulations.
+ *
+ * @summary Box area that deletes objects entering it
  * @category Interactivity
  * @group Components
  */
@@ -4169,6 +4223,10 @@ export declare class DeleteBox extends BoxHelperComponent {
 }
 
 /**
+ * Depth of Field effect simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.
+ * This effect enhances the sense of depth in a scene by mimicking how cameras focus on subjects at varying distances, creating a more immersive visual experience.
+ * It can be adjusted to achieve different artistic effects, from subtle background blurring to pronounced bokeh effects.
+ * @summary Depth of Field Post-Processing Effect
  * @category Effects
  * @group Components
  */
@@ -4201,6 +4259,10 @@ export declare function destroyComponentInstance(componentInstance: IComponent):
 export declare function determineMimeTypeFromExtension(name: string): NeedleMimetype | null;
 
 /**
+ * Enables or disables the GameObject based on the device type (mobile or desktop).
+ * You can use this to show or hide objects depending on whether the user is on a mobile device or a desktop.
+ *
+ * @summary Show or hide GameObject based on device type
  * @category Utilities
  * @group Components
  */
@@ -4283,6 +4345,7 @@ export declare class DocumentExtension implements IUSDExporterExtension {
  * DragControls allows you to drag objects around in the scene. It can be used to move objects in 2D (screen space) or 3D (world space).
  * Debug mode can be enabled with the URL parameter `?debugdrag`, which shows visual helpers and logs drag operations.
  *
+ * @summary Enables dragging of objects in 2D or 3D space
  * @category Interactivity
  * @group Components
  */
@@ -4444,6 +4507,7 @@ export declare enum DragMode {
  * });
  * ```
  *
+ * @summary Component to handle drag and drop of files into the scene
  * @category Asset Management
  * @group Components
  */
@@ -4623,6 +4687,7 @@ export declare type DropListenerOnDropArguments = {
 /**
  * The Duplicatable component is used to duplicate a assigned {@link GameObject} when a pointer event occurs on the object.
  *
+ * @summary Duplicates a GameObject on pointer events
  * @category Interactivity
  * @group Components
  */
@@ -4661,6 +4726,7 @@ export declare const editorGuidKeyName = "needle_editor_guid";
 export declare type EffectProviderResult = Effect | Pass | Array<Effect | Pass>;
 
 /**
+ *
  * @category Effects
  * @group Components
  */
@@ -4688,6 +4754,8 @@ export declare class EmissionModule {
 /* Excluded from this release type: EmphasizeActionMotionType */
 
 /**
+ * Emphasize the target object when clicked.
+ * @summary Emphasizes the target object when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -4807,6 +4875,8 @@ declare class EventListSerializer extends TypeSerializer {
 export declare const eventListSerializer: EventListSerializer;
 
 /**
+ * The EventSystem is responsible for managing and dispatching input events to UI components within the scene.
+ * @summary UI Input Event System
  * @category User Interface
  * @group Components
  */
@@ -4922,6 +4992,8 @@ export declare class EventSystem extends Component {
 /**
  * The EventTrigger component is used to trigger events when certain pointer events occur on the GameObject.
  * It implements the {@link IPointerEventHandler} interface and can be used to expose events to the user in the editor without writing code.
+ *
+ * @summary Triggers events on pointer interactions
  * @category Interactivity
  * @group Components
  */
@@ -6120,6 +6192,8 @@ export declare class Graphics {
 
 /**
  * GridHelper is a component that allows to display a grid in the scene.
+ *
+ * @example Display a grid in the scene
  * @category Helpers
  * @group Components
  */
@@ -6148,6 +6222,7 @@ export declare class GridLayoutGroup extends LayoutGroup {
  *
  * - Example https://engine.needle.tools/samples/ground-projection
  *
+ * @summary Projects the environment map onto the ground
  * @category Rendering
  * @group Components
  */
@@ -6246,6 +6321,8 @@ export declare enum HideFlags {
 }
 
 /**
+ * Hides the object on scene start.
+ * @summary Hides the object on scene start
  * @category Everywhere Actions
  * @group Components
  */
@@ -6309,6 +6386,7 @@ declare enum HorizontalWrapMode {
  *
  * By default, a simple scale-up animation is used. You can customize the hover and idle animations by providing your own animation clips.
  *
+ * @summary Hover Animation on Pointer Enter/Exit
  * @category Web
  * @group Components
  */
@@ -6617,6 +6695,10 @@ declare interface ILightDataRegistry {
 /* Excluded from this release type: ILoadingViewHandler */
 
 /**
+ * Image is a UI component that displays a sprite (2D image) in the user interface.
+ * You can set the image property to assign a texture to be displayed.
+ * The sprite can be customized with various properties such as color tinting and pixel density.
+ * @summary Image UI Component
  * @category User Interface
  * @group Components
  */
@@ -7016,6 +7098,10 @@ export declare const enum InputEvents {
 }
 
 /**
+ * InputField is a UI component that allows users to enter and edit text.
+ * It provides a text input area where users can type, delete, and modify text.
+ * The InputField supports placeholder text, events for value changes, and end edit actions.
+ * @summary Text Input Field UI Component
  * @category User Interface
  * @group Components
  */
@@ -8000,6 +8086,7 @@ declare type LifecycleMethodOptions = {
  * Debug mode can be enabled with the URL parameter `?debuglights`, which shows
  * additional console output and visual helpers for lights.
  *
+ * @summary Light component for various light types and shadow settings
  * @category Rendering
  * @group Components
  */
@@ -8265,6 +8352,8 @@ declare enum LODFadeMode {
 
 /**
  * LODGroup allows to create a group of LOD levels for an object.
+ *
+ * @summary Level of Detail (LOD) Group Component
  * @category Rendering
  * @group Components
  */
@@ -8337,6 +8426,7 @@ export declare enum LogType {
  * LookAt behaviour makes the object look at a target object or the camera.
  * It can also invert the forward direction and keep the up direction.
  *
+ * @summary Makes the object look at a target object or the camera
  * @category Interactivity, Everywhere Actions
  * @group Components
  */
@@ -8366,6 +8456,7 @@ export declare class LookAt extends Component implements UsdzBehaviour {
  * A LookAtConstraint is used by OrbitControls to make the camera look at a target.
  * This component is used by {@link OrbitControls} internally.
  *
+ * @summary Look At Constraint for OrbitControls
  * @category Camera Controls
  * @group Components
  */
@@ -9015,6 +9106,7 @@ declare class NeedleGamepadButton {
  * Controls display options, button visibility, and menu positioning.
  * From code, you can access the menu via {@link Context.menu}.
  *
+ * @summary Configuration component for the Needle Menu
  * @category User Interface
  * @group Components
  **/
@@ -9873,6 +9965,7 @@ export declare type NEPointerEventIntersection = Intersection & {
 /** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)
  * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
  *
+ * @summary Loads and instantiates a nested glTF file
  * @category Asset Management
  * @group Components
  */
@@ -10110,6 +10203,7 @@ export declare class NetworkedStreams extends EventDispatcher<any> {
  * This component supplies websocket URLs for establishing connections.
  * It implements the {@link INetworkingWebsocketUrlProvider} interface.
  *
+ * @summary Networking configuration component
  * @category Networking
  * @group Components
  */
@@ -10354,6 +10448,13 @@ export declare class ObjectUtils {
 
 /* Excluded from this release type: OffscreenCanvasExt */
 
+/**
+ * OffsetConstraint component allows an object to maintain a specified positional and rotational offset
+ * relative to another object, with options for alignment and leveling.
+ * @summary Maintains positional and rotational offset relative to another object
+ * @category Constraints
+ * @group Components
+ */
 export declare class OffsetConstraint extends Component {
     private referenceSpace;
     private from;
@@ -10631,6 +10732,7 @@ declare enum OpenURLMode {
 /** The OrbitControls component is used to control a camera using the [OrbitControls from three.js](https://threejs.org/docs/#examples/en/controls/OrbitControls) library.
  * The three OrbitControls object can be accessed via the `controls` property.
  * The object being controlled by the OrbitControls (usually the camera) can be accessed via the `controllerObject` property.
+ * @summary Camera controller using three.js OrbitControls
  * @category Camera
  * @group Components
  */
@@ -10904,6 +11006,13 @@ export declare class OrbitControls extends Component implements ICameraControlle
          immediate?: boolean;
      };
 
+     /**
+      * Outline is a UI component that adds an outline effect to UI elements.
+      * You can customize the outline color and distance to create a visual border around the UI element.
+      * @summary Outline UI Component
+      * @category User Interface
+      * @group Components
+      */
      export declare class Outline extends Component {
          effectColor?: RGBAColor;
          effectDistance?: Vector2;
@@ -11042,6 +11151,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * Needle Engine uses [three.quarks](https://github.com/Alchemist0823/three.quarks) under the hood to handle particles.
       *
+      * @summary Particle System
       * @category Rendering
       * @group Components
       */
@@ -11412,6 +11522,9 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.
+      * This effect can be used to achieve a retro or stylized visual aesthetic, reminiscent of early video games or low-resolution graphics.
+      * @summary Pixelation Post-Processing Effect
       * @category Effects
       * @group Components
       */
@@ -11441,6 +11554,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * The PlayableDirector component is the main component to control timelines in needle engine.
       * It is used to play, pause, stop and evaluate timelines.
       * Assign a TimelineAsset to the `playableAsset` property to start playing a timeline.
+      * @summary Controls and plays TimelineAssets
       * @category Animation and Sequencing
       * @group Components
       */
@@ -11581,6 +11695,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /* Excluded from this release type: PlayAction */
 
      /**
+      * Plays an animation when clicked.
+      * @summary Plays an animation when clicked
       * @category Everywhere Actions
       * @group Components
       */
@@ -11614,6 +11730,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Plays an audio clip when clicked.
+      * @summary Plays an audio clip when clicked
       * @category Everywhere Actions
       * @group Components
       */
@@ -11633,6 +11751,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * PlayerColor assigns a unique color for each user in the room to the object it is attached to.
       * The color is generated based on the user's ID.
+      *
+      * @summary Assigns a unique color to the player object
       * @category Networking
       * @group Components
       */
@@ -11747,7 +11867,9 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * This component instantiates an asset for each player that joins a networked room. The asset will be destroyed when the player leaves the room.
       * The asset should have a PlayerState component, and can have other components like SyncedTransform, custom components, etc.
+      * @summary Instantiates and manages player assets in a networked room
       * @category Networking
+      * @group Components
       */
      export declare class PlayerSync extends Component {
          /**
@@ -12588,6 +12710,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * - Sample: http://samples.needle.tools/reflection-probes
       *
+      * @summary Provides reflection data to materials
       * @category Rendering
       * @group Components
       */
@@ -12697,6 +12820,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * skybox.setSkybox("https://example.com/skybox.hdr");
       * ```
       *
+      * @summary Sets the skybox or environment texture of a scene
       * @category Rendering
       * @group Components
       */
@@ -13041,6 +13165,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * - Example: https://samples.needle.tools/physics-playground
       * - Example: https://samples.needle.tools/physics-&-animation
       *
+      * @summary Rigidbody for physical interactions
       * @category Physics
       * @group Components
       */
@@ -13340,6 +13465,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * });
       * ```
       *
+      * @summary Dynamically loads and switches between multiple scenes
       * @category Asset Management
       * @group Components
       */
@@ -13549,6 +13675,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * By default the component will start sharing the screen when the user clicks on the object this component is attached to. You can set {@link device} This behaviour can be disabled by setting `allowStartOnClick` to false.
       * It is also possible to start the stream manually from your code by calling the {@link share} method.
       *
+      * @summary Share screen, camera or microphone in a networked room
       * @category Networking
       * @group Components
       */
@@ -13829,6 +13956,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /** Screen Space Ambient Occlusion (SSAO) effect.
+      * Ambient Occlusion is a shading method used to calculate how exposed each point in a scene is to ambient lighting.
+      * The effect enhances the depth and realism of 3D scenes by simulating the soft shadows that occur in crevices, corners, and areas where objects are close to each other.
+      * This implementation uses the N8AO library to provide high-quality SSAO with various quality settings.
+      * @summary Screen Space Ambient Occlusion (SSAO) Post-Processing Effect
       * @category Effects
       * @group Components
       * @link [N8AO documentation](https://github.com/N8python/n8ao)
@@ -13899,6 +14030,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
 
      /**
       * The ScrollFollow component allows you to link the scroll position of the page (or a specific element) to one or more target objects.
+
       * This can be used to create scroll-based animations, audio playback, or other effects. For example you can link the scroll position to a timeline (PlayableDirector) to create scroll-based storytelling effects or to an Animator component to change the animation state based on scroll.
       *
       * Assign {@link target} objects to the component to have them updated based on the current scroll position (check the 'target' property for supported types).
@@ -13925,6 +14057,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *   <div data-timeline-marker="1.0">End of Timeline</div>
       * ```
       *
+      * @summary Links scroll position to target objects
       * @category Web
       * @group Components
       * @component
@@ -14022,6 +14155,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * - Example https://see-through-walls-z23hmxbz1kjfjn.needle.run/
       *
+      * @summary Makes objects fade out when obscuring a reference point from the camera
       * @category Rendering
       * @group Components
       */
@@ -14140,6 +14274,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export declare function setActive(go: Object3D, active: boolean | number): boolean;
 
      /**
+      * Set the active state of an object when clicked.
+      * @summary Sets the active state of an object when clicked
       * @category Everywhere Actions
       * @group Components
       */
@@ -14261,6 +14397,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * If the GameObject is a Mesh, it will apply a shadow-catching material to it - otherwise it will create a quad with the shadow-catching material.
       *
       * Note that ShadowCatcher meshes are not raycastable by default; if you want them to be raycastable, change the layers in `onEnable()`.
+      *
+      * @summary Renders shadows or light on the object
       * @category Rendering
       * @group Components
       */
@@ -14375,6 +14513,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
+      * This effect can make textures and fine details appear clearer and more defined, improving the overall visual quality of the scene.
+      * It is particularly useful in scenes where details may be lost due to blurriness or low resolution.
+      * @summary Sharpening Post-Processing Effect
       * @category Effects
       * @group Components
       */
@@ -14422,6 +14564,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /** SignalReceiver is a component that listens for signals and invokes a reaction when a signal is received.
       * Signals can be added to a signal track on a {@link PlayableDirector}
       *
+      * @summary Receives signals and invokes reactions
       * @category Sequencing and Timelines
       * @group Components
       */
@@ -14522,6 +14665,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * SmoothFollow makes the {@link Object3D} (`GameObject`) smoothly follow another target {@link Object3D}.
       * It can follow the target's position, rotation, or both.
+      * @summary Smoothly follows a target object
       * @category Interactivity
       * @group Components
       */
@@ -14632,6 +14776,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * Component that receives and responds to spatial events, like entering or exiting a trigger zone.
       * Used in conjunction with {@link SpatialTrigger} to create interactive spatial events.
+      * @summary Receives spatial trigger events
       * @category Interactivity
       * @group Components
       */
@@ -14676,6 +14821,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * Debug mode can be enabled with the URL parameter `?debugspectator`, which provides additional console output.
       *
+      * @summary Follow other users in a networked room
       * @category Networking
       * @group Components
       */
@@ -14829,6 +14975,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * You can create a SplineContainer from an array of points using the static method 'createFromPoints'.
       *
+      * @summary Holds spline data and generates a spline curve.
       * @category Splines
       * @group Components
       */
@@ -14902,6 +15049,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * - Example http://samples.needle.tools/splines
       *
+      * @summary Moves an object along a spline
       * @category Splines
       * @group Components
       */
@@ -14977,6 +15125,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
 
      /**
       * A sprite is a mesh that represents a 2D image. Used by the {@link SpriteRenderer} to render 2D images in the scene.
+      * @summary 2D image renderer
       * @category Rendering
       * @group Components
       */
@@ -15204,6 +15353,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * SyncedCamera is a component that syncs the camera position and rotation of all users in the room.
       * A prefab can be set to represent the remote cameras visually in the scene.
+      *
+      * @summary Syncs camera position and rotation of users in a networked room
       * @category Networking
       * @group Components
       */
@@ -15253,6 +15404,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * myObject.addComponent(SyncedRoom, { joinRandomRoom: true, roomPrefix: "myApp_" });
       * ```
       *
+      * @summary Joins a networked room based on URL parameters or a random room
       * @category Networking
       * @group Components
       */
@@ -15334,6 +15486,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * SyncedTransform synchronizes the position and rotation of a game object over the network.
       * It handles ownership transfer, interpolation, and network state updates automatically.
+      *
+      * @summary Synchronizes object transform over the network with ownership management
       * @category Networking
       * @group Components
       */
@@ -15428,6 +15582,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export declare type SyncInstantiateOptions = IInstantiateOptions & Pick<IModel, "deleteOnDisconnect">;
 
      /**
+      * Triggers an action when the object is tapped/clicked.
+      * @summary Triggers an action when the object is tapped/clicked
       * @category Everywhere Actions
       * @group Components
       */
@@ -15475,6 +15631,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /* Excluded from this release type: TestSimulateUserData */
 
      /**
+      * Text is a UI component that displays text in the user interface.
       * @category User Interface
       * @group Components
       */
@@ -15629,6 +15786,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.
+      * This effect creates a shallow depth of field, making real-world scenes appear as if they are small-scale models.
+      * It is often used in photography and cinematography to draw attention to specific areas of the scene while blurring out the rest.
+      * @summary Tilt Shift Post-Processing Effect
       * @category Effects
       * @group Components
       */
@@ -15703,6 +15864,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export declare type TonemappingAttributeOptions = "none" | "linear" | "neutral" | "agx";
 
      /**
+      * Tonemapping effect adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
+      * This effect is essential for achieving realistic lighting and color representation in 3D scenes, as it helps to preserve details in both bright and dark areas.
+      * Various tonemapping algorithms can be applied to achieve different visual styles and effects.
+      * @summary Tonemapping Post-Processing Effect
       * @category Effects
       * @group Components
       */
@@ -15855,6 +16020,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * TransformGizmo displays manipulation controls for translating, rotating, and scaling objects in the scene.
       * It wraps three.js {@link TransformControls} and provides keyboard shortcuts for changing modes and settings.
+      *
+      * @summary Object manipulation gizmo for translating, rotating, and scaling
       * @category Helpers
       * @group Components
       */
@@ -16508,6 +16675,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *    playOnAwake: true,
       * });
       * ```
+      * @summary Plays video clips from URLs or streams
       * @category Multimedia
       * @group Components
       */
@@ -16670,6 +16838,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       scene.add(viewBox);
       * ```
 
+      * @summary Automatically fits a box area into the camera view
       * @category Camera
       * @group Components
       * @component
@@ -16721,6 +16890,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Vignette effect darkens the edges of the rendered scene to draw attention to the center.
+      * This effect simulates the natural vignetting that occurs in photography and cinematography, where the corners of an image are darker than the center.
+      * It can be used to enhance the visual focus on the main subject of the scene and create a more immersive viewing experience.
+      * @summary Vignette Post-Processing Effect
       * @category Effects
       * @group Components
       */
@@ -16735,6 +16908,8 @@ export declare class OrbitControls extends Component implements ICameraControlle
      }
 
      /**
+      * Hides or shows the object when clicked.
+      * @summary Hides or shows the object when clicked
       * @category Everywhere Actions
       * @group Components
       */
@@ -16757,6 +16932,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      /**
       * The Voice over IP component (VoIP) allows you to send and receive audio streams to other users in the same networked room.
       * It requires a networking connection to be working (e.g. by having an active SyncedRoom component in the scene or by connecting to a room manually).
+      * @summary Voice over IP (VoIP) for networked audio communication
       * @category Networking
       * @group Components
       */
@@ -16841,6 +17017,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * volume.addEffect(pixelation);
       * ```
       *
+      * @summary Manage Post-Processing Effects
       * @category Rendering
       * @category Effects
       * @group Components
@@ -16987,6 +17164,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       *
       * - Example: https://samples.needle.tools/ar-camera-background
       *
+      * @summary Displays the camera feed as background in WebAR sessions
       * @category XR
       * @group Components
       */
@@ -17019,6 +17197,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * });
       * ```
       *
+      * @summary Root object for WebAR sessions, managing scene placement and user scaling in AR.
       * @category XR
       * @group Components
       */
@@ -17135,7 +17314,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * });
       * ```
       *
-      *
+      * @summary WebXR Component for VR and AR support
       * @category XR
       * @group Components
       */
@@ -17586,6 +17765,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * });
       * ```
       *
+      * @summary Makes the object follow a specific XR controller or hand
       * @category XR
       * @group Components
       * */
@@ -17631,6 +17811,10 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * It automatically loads the appropriate model for the connected controller or hand.
       *
       * You can configure if controller models or hand models should be created.
+      *
+      * @summary Displays controller or hand models in XR
+      * @category XR
+      * @group Components
       */
      export declare class XRControllerModel extends Component {
          /**
@@ -17675,6 +17859,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
       * It also visualizes controller rays and hit points in the scene.
       *
       *
+      * @summary Move the XR rig using controller input
       * @category XR
       * @group Components
       */