@needle-tools/engine 4.2.5 → 4.3.0-alpha.1

package/lib/engine-components/Component.js

@@ -15,17 +15,40 @@ import * as threeutils from "../engine/engine_three_utils.js";
 //     onDeserialize?(key: string, value: any): any | void;
 // }
 /**
- * All {@type Object3D} types that are loaded in Needle Engine do automatically receive the GameObject extensions like `addComponent` etc.
- * Many of the GameObject methods can be imported directly via `@needle-tools/engine` as well:
+ * Base class for objects in Needle Engine. Extends {@link Object3D} from three.js.
+ * GameObjects can have components attached to them, which can be used to add functionality to the object.
+ * They manage their components and provide methods to add, remove and get components.
+ *
+ * All {@link Object3D} types loaded in Needle Engine have methods like {@link addComponent}.
+ * These methods are available directly on the GameObject instance:
  * ```typescript
- * import { addComponent } from "@needle-tools/engine";
+ * target.addComponent(MyComponent);
+ * ```
+ *
+ * And can be called statically on the GameObject class as well:
+ * ```typescript
+ * GameObject.setActive(target, true);
  * ```
  */
 export class GameObject extends Object3D {
+    /**
+     * Unique identifier for this GameObject
+     */
     guid;
+    /**
+     * Checks if a GameObject has been destroyed
+     * @param go The GameObject to check
+     * @returns True if the GameObject has been destroyed
+     */
     static isDestroyed(go) {
         return isDestroyed(go);
     }
+    /**
+     * Sets the active state of a GameObject
+     * @param go The GameObject to modify
+     * @param active Whether the GameObject should be active
+     * @param processStart Whether to process the start callbacks if being activated
+     */
     static setActive(go, active, processStart = true) {
         if (!go)
             return;
@@ -35,32 +58,51 @@ export class GameObject extends Object3D {
         if (active && processStart)
             main.processStart(Context.Current, go);
     }
-    /** If the object is active (same as go.visible) */
+    /**
+     * Checks if the GameObject itself is active (same as go.visible)
+     * @param go The GameObject to check
+     * @returns True if the GameObject is active
+     */
     static isActiveSelf(go) {
         return isActiveSelf(go);
     }
-    /** If the object is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
-     * @param go object to check
-    */
+    /**
+     * Checks if the GameObject is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
+     * @param go The GameObject to check
+     * @returns True if the GameObject is active in the hierarchy
+     */
     static isActiveInHierarchy(go) {
         return isActiveInHierarchy(go);
     }
+    /**
+     * Marks a GameObject to be rendered using instancing
+     * @param go The GameObject to mark
+     * @param instanced Whether the GameObject should use instanced rendering
+     */
     static markAsInstancedRendered(go, instanced) {
         markAsInstancedRendered(go, instanced);
     }
+    /**
+     * Checks if a GameObject is using instanced rendering
+     * @param instance The GameObject to check
+     * @returns True if the GameObject is using instanced rendering
+     */
     static isUsingInstancing(instance) { return isUsingInstancing(instance); }
-    /** Run a callback for all components of the provided type on the provided object and its children (if recursive is true)
-     * @param instance object to run the method on
-     * @param cb callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
-     * @param recursive if true, the method will be run on all children as well
-     * @returns the last return value of the callback
+    /**
+     * Executes a callback for all components of the provided type on the provided object and its children
+     * @param instance Object to run the method on
+     * @param cb Callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
+     * @param recursive If true, the method will be run on all children as well
+     * @returns The last return value of the callback
      */
     static foreachComponent(instance, cb, recursive = true) {
         return foreachComponent(instance, cb, recursive);
     }
-    /** Creates a new instance of the provided object. The new instance will be created on all connected clients
-     * @param instance object to instantiate
-     * @param opts options for the instantiation
+    /**
+     * Creates a new instance of the provided object that will be replicated to all connected clients
+     * @param instance Object to instantiate
+     * @param opts Options for the instantiation
+     * @returns The newly created instance or null if creation failed
      */
     static instantiateSynced(instance, opts) {
         if (!instance)
@@ -73,9 +115,12 @@ export class GameObject extends Object3D {
         }
         return instantiate(instance, opts);
     }
-    /** Destroys a object on all connected clients (if you are in a networked session)
-     * @param instance object to destroy
-    */
+    /**
+     * Destroys an object on all connected clients (if in a networked session)
+     * @param instance Object to destroy
+     * @param context Optional context to use
+     * @param recursive If true, all children will be destroyed as well
+     */
     static destroySynced(instance, context, recursive = true) {
         if (!instance)
             return;
@@ -83,15 +128,19 @@ export class GameObject extends Object3D {
         context = context ?? Context.Current;
         syncDestroy(go, context.connection, recursive);
     }
-    /** Destroys a object
-     * @param instance object to destroy
-     * @param recursive if true, all children will be destroyed as well. true by default
+    /**
+     * Destroys an object
+     * @param instance Object to destroy
+     * @param recursive If true, all children will be destroyed as well. Default: true
      */
     static destroy(instance, recursive = true) {
         return destroy(instance, recursive);
     }
     /**
-     * Add an object to parent and also ensure all components are being registered
+     * Adds an object to parent and ensures all components are properly registered
+     * @param instance Object to add
+     * @param parent Parent to add the object to
+     * @param context Optional context to use
      */
     static add(instance, parent, context) {
         if (!instance || !parent)
@@ -122,6 +171,7 @@ export class GameObject extends Object3D {
     }
     /**
      * Removes the object from its parent and deactivates all of its components
+     * @param instance Object to remove
      */
     static remove(instance) {
         if (!instance)
@@ -133,13 +183,21 @@ export class GameObject extends Object3D {
             main.processRemoveFromScene(comp);
         }, true);
     }
-    /** Invokes a method on all components including children (if a method with that name exists) */
+    /**
+     * Invokes a method on all components including children (if a method with that name exists)
+     * @param go GameObject to invoke the method on
+     * @param functionName Name of the method to invoke
+     * @param args Arguments to pass to the method
+     */
     static invokeOnChildren(go, functionName, ...args) {
         this.invoke(go, functionName, true, args);
     }
-    /** Invokes a method on all components that have a method matching the provided name
-     * @param go object to invoke the method on all components
-     * @param functionName name of the method to invoke
+    /**
+     * Invokes a method on all components that have a method matching the provided name
+     * @param go GameObject to invoke the method on
+     * @param functionName Name of the method to invoke
+     * @param children Whether to invoke on children as well
+     * @param args Arguments to pass to the method
      */
     static invoke(go, functionName, children = false, ...args) {
         if (!go)
@@ -157,34 +215,49 @@ export class GameObject extends Object3D {
         return addComponent(go, type, init, { callAwake });
     }
     /**
-     * Add a new component (or move an existing component) to the provided object
-     * @param go object to add the component to
-     * @param instanceOrType if an instance is provided it will be moved to the new object, if a type is provided a new instance will be created and moved to the new object
-     * @param init optional init object to initialize the component with
-     * @param callAwake if true, the component will be added and awake will be called immediately
+     * Adds a new component (or moves an existing component) to the provided object
+     * @param go Object to add the component to
+     * @param instanceOrType If an instance is provided it will be moved to the new object, if a type is provided a new instance will be created
+     * @param init Optional init object to initialize the component with
+     * @param opts Optional options for adding the component
+     * @returns The added or moved component
      */
     static addComponent(go, instanceOrType, init, opts) {
         return addComponent(go, instanceOrType, init, opts);
     }
     /**
      * Moves a component to a new object
-     * @param go component to move the component to
-     * @param instance component to move to the GO
+     * @param go GameObject to move the component to
+     * @param instance Component to move
+     * @returns The moved component
      */
     static moveComponent(go, instance) {
         return addComponent(go, instance);
     }
-    /** Removes a component from its object
-     * @param instance component to remove
+    /**
+     * Removes a component from its object
+     * @param instance Component to remove
+     * @returns The removed component
      */
     static removeComponent(instance) {
         removeComponent(instance.gameObject, instance);
         return instance;
     }
+    /**
+     * Gets or adds a component of the specified type
+     * @param go GameObject to get or add the component to
+     * @param typeName Constructor of the component type
+     * @returns The existing or newly added component
+     */
     static getOrAddComponent(go, typeName) {
         return getOrAddComponent(go, typeName);
     }
-    /** Gets a component on the provided object */
+    /**
+     * Gets a component on the provided object
+     * @param go GameObject to get the component from
+     * @param typeName Constructor of the component type
+     * @returns The component if found, otherwise null
+     */
     static getComponent(go, typeName) {
         if (go === null)
             return null;
@@ -194,35 +267,92 @@ export class GameObject extends Object3D {
         // if(res) typeName = res;
         return getComponent(go, typeName);
     }
+    /**
+     * Gets all components of the specified type on the provided object
+     * @param go GameObject to get the components from
+     * @param typeName Constructor of the component type
+     * @param arr Optional array to populate with the components
+     * @returns Array of components
+     */
     static getComponents(go, typeName, arr = null) {
         if (go === null)
             return arr ?? [];
         return getComponents(go, typeName, arr);
     }
+    /**
+     * Finds an object or component by its unique identifier
+     * @param guid Unique identifier to search for
+     * @param hierarchy Root object to search in
+     * @returns The found GameObject or Component, or null/undefined if not found
+     */
     static findByGuid(guid, hierarchy) {
         const res = findByGuid(guid, hierarchy);
         return res;
     }
+    /**
+     * Finds the first object of the specified component type in the scene
+     * @param typeName Constructor of the component type
+     * @param context Context or root object to search in
+     * @param includeInactive Whether to include inactive objects in the search
+     * @returns The first matching component if found, otherwise null
+     */
     static findObjectOfType(typeName, context, includeInactive = true) {
         return findObjectOfType(typeName, context ?? Context.Current, includeInactive);
     }
+    /**
+     * Finds all objects of the specified component type in the scene
+     * @param typeName Constructor of the component type
+     * @param context Context or root object to search in
+     * @returns Array of matching components
+     */
     static findObjectsOfType(typeName, context) {
         const arr = [];
         findObjectsOfType(typeName, arr, context);
         return arr;
     }
+    /**
+     * Gets a component of the specified type in the gameObject's children hierarchy
+     * @param go GameObject to search in
+     * @param typeName Constructor of the component type
+     * @returns The first matching component if found, otherwise null
+     */
     static getComponentInChildren(go, typeName) {
         return getComponentInChildren(go, typeName);
     }
+    /**
+     * Gets all components of the specified type in the gameObject's children hierarchy
+     * @param go GameObject to search in
+     * @param typeName Constructor of the component type
+     * @param arr Optional array to populate with the components
+     * @returns Array of components
+     */
     static getComponentsInChildren(go, typeName, arr = null) {
         return getComponentsInChildren(go, typeName, arr ?? undefined);
     }
+    /**
+     * Gets a component of the specified type in the gameObject's parent hierarchy
+     * @param go GameObject to search in
+     * @param typeName Constructor of the component type
+     * @returns The first matching component if found, otherwise null
+     */
     static getComponentInParent(go, typeName) {
         return getComponentInParent(go, typeName);
     }
+    /**
+     * Gets all components of the specified type in the gameObject's parent hierarchy
+     * @param go GameObject to search in
+     * @param typeName Constructor of the component type
+     * @param arr Optional array to populate with the components
+     * @returns Array of components
+     */
     static getComponentsInParent(go, typeName, arr = null) {
         return getComponentsInParent(go, typeName, arr);
     }
+    /**
+     * Gets all components on the gameObject
+     * @param go GameObject to get components from
+     * @returns Array of all components
+     */
     static getAllComponents(go) {
         const componentsList = go.userData?.components;
         if (!componentsList)
@@ -230,6 +360,11 @@ export class GameObject extends Object3D {
         const newList = [...componentsList];
         return newList;
     }
+    /**
+     * Iterates through all components on the gameObject
+     * @param go GameObject to iterate components on
+     * @returns Generator yielding each component
+     */
     static *iterateComponents(go) {
         const list = go?.userData?.components;
         if (list && Array.isArray(list)) {
@@ -266,24 +401,38 @@ export class GameObject extends Object3D {
  * @group Components
  */
 export class Component {
-    /** @internal */
+    /**
+     * Indicates whether this object is a component
+     * @internal
+     */
     get isComponent() { return true; }
     __context;
-    /** Use the context to get access to many Needle Engine features and use physics, timing, access the camera or scene */
+    /**
+     * The context this component belongs to, providing access to the runtime environment
+     * including physics, timing utilities, camera, and scene
+     */
     get context() {
         return this.__context ?? Context.Current;
     }
     set context(context) {
         this.__context = context;
     }
-    /** shorthand for `this.context.scene`
-     * @returns the scene of the context  */
+    /**
+     * Shorthand accessor for the current scene from the context
+     * @returns The scene this component belongs to
+     */
     get scene() { return this.context.scene; }
-    /** @returns the layer of the gameObject this component is attached to */
+    /**
+     * The layer value of the GameObject this component is attached to
+     * Used for visibility and physics filtering
+     */
     get layer() {
         return this.gameObject?.userData?.layer;
     }
-    /** @returns the name of the gameObject this component is attached to */
+    /**
+     * The name of the GameObject this component is attached to
+     * Used for debugging and finding objects
+     */
     get name() {
         if (this.gameObject?.name) {
             return this.gameObject.name;
@@ -302,7 +451,10 @@ export class Component {
             this.__name = str;
         }
     }
-    /** @returns the tag of the gameObject this component is attached to */
+    /**
+     * The tag of the GameObject this component is attached to
+     * Used for categorizing objects and efficient lookup
+     */
     get tag() {
         return this.gameObject?.userData.tag;
     }
@@ -313,7 +465,10 @@ export class Component {
             this.gameObject.userData.tag = str;
         }
     }
-    /** Is the gameObject marked as static */
+    /**
+     * Indicates whether the GameObject is marked as static
+     * Static objects typically don't move and can be optimized by the engine
+     */
     get static() {
         return this.gameObject?.userData.static;
     }
@@ -327,7 +482,11 @@ export class Component {
     // get hideFlags(): HideFlags {
     //     return this.gameObject?.hideFlags;
     // }
-    /** @returns true if the object is enabled and active in the hierarchy */
+    /**
+     * Checks if this component is currently active (enabled and part of an active GameObject hierarchy)
+     * Components that are inactive won't receive lifecycle method calls
+     * @returns True if the component is enabled and all parent GameObjects are active
+     */
     get activeAndEnabled() {
         if (this.destroyed)
             return false;
@@ -360,42 +519,72 @@ export class Component {
             return;
         this.gameObject[activeInHierarchyFieldName] = val;
     }
-    /** the object this component is attached to. Note that this is a threejs Object3D with some additional features */
+    /**
+     * Reference to the GameObject this component is attached to
+     * This is a three.js Object3D with additional GameObject functionality
+     */
     gameObject;
-    /** the unique identifier for this component */
+    /**
+     * Unique identifier for this component instance,
+     * used for finding and tracking components
+     */
     guid = "invalid";
-    /** holds the source identifier this object was created with/from (e.g. if it was part of a glTF file the sourceId holds the url to the glTF) */
+    /**
+     * Identifier for the source asset that created this component.
+     * For example, URL to the glTF file this component was loaded from
+     */
     sourceId;
-    /** called once when the component becomes active for the first time (once per component)
-     * This is the first callback to be called */
+    /**
+     * Called once when the component becomes active for the first time.
+     * This is the first lifecycle callback to be invoked
+     */
     awake() { }
-    /** called every time when the component gets enabled (this is invoked after awake and before start)
-     * or when it becomes active in the hierarchy (e.g. if a parent object or this.gameObject gets set to visible)
-    */
+    /**
+     * Called every time the component becomes enabled or active in the hierarchy.
+     * Invoked after {@link awake} and before {@link start}.
+     */
     onEnable() { }
-    /** called every time the component gets disabled or if a parent object (or this.gameObject) gets set to invisible */
+    /**
+     * Called every time the component becomes disabled or inactive in the hierarchy.
+     * Invoked when the component or any parent GameObject becomes invisible
+     */
     onDisable() { }
-    /** Called when the component gets destroyed */
+    /**
+     * Called when the component is destroyed.
+     * Use for cleanup operations like removing event listeners
+     */
     onDestroy() {
         this.__destroyed = true;
     }
-    /** starts a coroutine (javascript generator function)
-     * `yield` will wait for the next frame:
-     * - Use `yield WaitForSeconds(1)` to wait for 1 second.
-     * - Use `yield WaitForFrames(10)` to wait for 10 frames.
-     * - Use `yield new Promise(...)` to wait for a promise to resolve.
-     * @param routine generator function to start
-     * @param evt event to register the coroutine for (default: FrameEvent.Update). Note that all coroutine FrameEvent callbacks are invoked after the matching regular component callbacks. For example `FrameEvent.Update` will be called after regular component `update()` methods)
-     * @returns the generator function (use it to stop the coroutine with `stopCoroutine`)
+    /**
+     * Starts a coroutine that can yield to wait for events.
+     * Coroutines allow for time-based sequencing of operations without blocking.
+     * Coroutines are based on generator functions, a JavaScript language feature.
+     *
+     * @param routine Generator function to start
+     * @param evt Event to register the coroutine for (default: FrameEvent.Update)
+     * @returns The generator function that can be used to stop the coroutine
+     * @example
+     * Time-based sequencing of operations
+     * ```ts
+     * *myCoroutine() {
+     *   yield WaitForSeconds(1); // wait for 1 second
+     *   yield WaitForFrames(10); // wait for 10 frames
+     *   yield new Promise(resolve => setTimeout(resolve, 1000)); // wait for a promise to resolve
+     * }
+     * ```
      * @example
+     * Coroutine that logs a message every 5 frames
      * ```ts
-     * onEnable() { this.startCoroutine(this.myCoroutine()); }
+     * onEnable() {
+     *   this.startCoroutine(this.myCoroutine());
+     * }
      * private *myCoroutine() {
-     *    while(this.activeAndEnabled) {
-     *       console.log("Hello World", this.context.time.frame);
-     *       // wait for 5 frames
-     *       for(let i = 0; i < 5; i++) yield;
-     *    }
+     *   while(this.activeAndEnabled) {
+     *     console.log("Hello World", this.context.time.frame);
+     *     // wait for 5 frames
+     *     for(let i = 0; i < 5; i++) yield;
+     *   }
      * }
      * ```
      */
@@ -403,19 +592,23 @@ export class Component {
         return this.context.registerCoroutineUpdate(this, routine, evt);
     }
     /**
-     * Stop a coroutine that was previously started with `startCoroutine`
-     * @param routine the routine to be stopped
-     * @param evt the frame event to unregister the routine from (default: FrameEvent.Update)
+     * Stops a coroutine that was previously started with startCoroutine
+     * @param routine The routine to be stopped
+     * @param evt The frame event the routine was registered with
      */
     stopCoroutine(routine, evt = FrameEvent.Update) {
         this.context.unregisterCoroutineUpdate(routine, evt);
     }
-    /** @returns true if this component was destroyed (`this.destroy()`) or the whole object this component was part of */
+    /**
+     * Checks if this component has been destroyed
+     * @returns True if the component or its GameObject has been destroyed
+     */
     get destroyed() {
         return this.__destroyed;
     }
     /**
-     * Destroys this component (and removes it from the object)
+     * Destroys this component and removes it from its GameObject
+     * After destruction, the component will no longer receive lifecycle callbacks
      */
     destroy() {
         if (this.__destroyed)
@@ -453,6 +646,11 @@ export class Component {
         this._internalInit(init);
         return this;
     }
+    /**
+     * Initializes component properties from an initialization object
+     * @param init Object with properties to copy to this component
+     * @internal
+     */
     _internalInit(init) {
         if (typeof init === "object") {
             for (const key of Object.keys(init)) {
@@ -531,6 +729,10 @@ export class Component {
         }
         destroyComponentInstance(this);
     }
+    /**
+     * Controls whether this component is enabled
+     * Disabled components don't receive lifecycle callbacks
+     */
     get enabled() {
         return typeof this.__isEnabled === "boolean" ? this.__isEnabled : true; // if it has no enabled field it is always enabled
     }
@@ -561,64 +763,128 @@ export class Component {
             this.__internalDisable();
         }
     }
+    /**
+     * Gets the position of this component's GameObject in world space
+     */
     get worldPosition() {
         return threeutils.getWorldPosition(this.gameObject);
     }
+    /**
+     * Sets the position of this component's GameObject in world space
+     * @param val The world position vector to set
+     */
     set worldPosition(val) {
         threeutils.setWorldPosition(this.gameObject, val);
     }
+    /**
+     * Sets the position of this component's GameObject in world space using individual coordinates
+     * @param x X-coordinate in world space
+     * @param y Y-coordinate in world space
+     * @param z Z-coordinate in world space
+     */
     setWorldPosition(x, y, z) {
         threeutils.setWorldPositionXYZ(this.gameObject, x, y, z);
     }
+    /**
+     * Gets the rotation of this component's GameObject in world space as a quaternion
+     */
     get worldQuaternion() {
         return threeutils.getWorldQuaternion(this.gameObject);
     }
+    /**
+     * Sets the rotation of this component's GameObject in world space using a quaternion
+     * @param val The world rotation quaternion to set
+     */
     set worldQuaternion(val) {
         threeutils.setWorldQuaternion(this.gameObject, val);
     }
+    /**
+     * Sets the rotation of this component's GameObject in world space using quaternion components
+     * @param x X component of the quaternion
+     * @param y Y component of the quaternion
+     * @param z Z component of the quaternion
+     * @param w W component of the quaternion
+     */
     setWorldQuaternion(x, y, z, w) {
         threeutils.setWorldQuaternionXYZW(this.gameObject, x, y, z, w);
     }
-    // world euler (in radians)
+    /**
+     * Gets the rotation of this component's GameObject in world space as Euler angles (in radians)
+     */
     get worldEuler() {
         return threeutils.getWorldEuler(this.gameObject);
     }
-    // world euler (in radians)
+    /**
+     * Sets the rotation of this component's GameObject in world space using Euler angles (in radians)
+     * @param val The world rotation Euler angles to set
+     */
     set worldEuler(val) {
         threeutils.setWorldEuler(this.gameObject, val);
     }
-    // returns rotation in degrees
+    /**
+     * Gets the rotation of this component's GameObject in world space as Euler angles (in degrees)
+     */
     get worldRotation() {
         return this.gameObject.worldRotation;
-        ;
     }
+    /**
+     * Sets the rotation of this component's GameObject in world space using Euler angles (in degrees)
+     * @param val The world rotation vector to set (in degrees)
+     */
     set worldRotation(val) {
         this.setWorldRotation(val.x, val.y, val.z, true);
     }
+    /**
+     * Sets the rotation of this component's GameObject in world space using individual Euler angles
+     * @param x X-axis rotation
+     * @param y Y-axis rotation
+     * @param z Z-axis rotation
+     * @param degrees Whether the values are in degrees (true) or radians (false)
+     */
     setWorldRotation(x, y, z, degrees = true) {
         threeutils.setWorldRotationXYZ(this.gameObject, x, y, z, degrees);
     }
     static _forward = new Vector3();
-    /** Forward (0,0,-1) vector in world space */
+    /**
+     * Gets the forward direction vector (0,0,-1) of this component's GameObject in world space
+     */
     get forward() {
         return Component._forward.set(0, 0, -1).applyQuaternion(this.worldQuaternion);
     }
     static _right = new Vector3();
-    /** Right (1,0,0) vector in world space */
+    /**
+     * Gets the right direction vector (1,0,0) of this component's GameObject in world space
+     */
     get right() {
         return Component._right.set(1, 0, 0).applyQuaternion(this.worldQuaternion);
     }
     static _up = new Vector3();
-    /** Up (0,1,0) vector in world space */
+    /**
+     * Gets the up direction vector (0,1,0) of this component's GameObject in world space
+     */
     get up() {
         return Component._up.set(0, 1, 0).applyQuaternion(this.worldQuaternion);
     }
     // EventTarget implementation:
+    /**
+     * Storage for event listeners registered to this component
+     * @private
+     */
     _eventListeners = new Map();
+    /**
+     * Registers an event listener for the specified event type
+     * @param type The event type to listen for
+     * @param listener The callback function to execute when the event occurs
+     */
     addEventListener(type, listener) {
         this._eventListeners[type] = this._eventListeners[type] || [];
         this._eventListeners[type].push(listener);
     }
+    /**
+     * Removes a previously registered event listener
+     * @param type The event type the listener was registered for
+     * @param listener The callback function to remove
+     */
     removeEventListener(type, listener) {
         if (!this._eventListeners[type])
             return;
@@ -626,6 +892,11 @@ export class Component {
         if (index >= 0)
             this._eventListeners[type].splice(index, 1);
     }
+    /**
+     * Dispatches an event to all registered listeners
+     * @param evt The event object to dispatch
+     * @returns Always returns false (standard implementation of EventTarget)
+     */
     dispatchEvent(evt) {
         if (!evt || !this._eventListeners[evt.type])
             return false;