@playcanvas/web-components 0.11.1 → 0.13.0

package/dist/components/script-component.d.cts

@@ -0,0 +1,163 @@
+import type { ScriptComponent } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+export type ScriptAttributesChangeEvent = {
+    detail: {
+        attributes: Record<string, any>;
+    };
+} & CustomEvent;
+export type ScriptEnableChangeEvent = {
+    detail: {
+        enabled: boolean;
+    };
+} & CustomEvent;
+export type ScriptNameChangeEvent = {
+    detail: {
+        oldName: string;
+        newName: string;
+    };
+} & CustomEvent;
+/**
+ * The ScriptComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
+ * The ScriptComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScriptComponentElement extends ComponentElement {
+    private observer;
+    /** @ignore */
+    constructor();
+    connectedCallback(): Promise<void>;
+    protected initComponent(): void;
+    /**
+     * Recursively converts raw attribute data into proper PlayCanvas types. Supported conversions:
+     * - "asset:id" → the Asset created by the `pc-asset` element with that id
+     * - "entity:ref" → the Entity backing a `pc-entity` element. The reference can be a CSS
+     *   selector, an element id or an entity name.
+     * - "vec2:1 2" → new Vec2(1, 2)
+     * - "vec3:1 2 3" → new Vec3(1, 2, 3)
+     * - "vec4:1 2 3 4" → new Vec4(1, 2, 3, 4)
+     * - "color:1 0.5 0.5 1" → new Color(1, 0.5, 0.5, 1)
+     *
+     * A prefixed string that fails to resolve or parse logs a warning and is left as the raw
+     * string.
+     * @param item - The item to convert.
+     * @returns The converted item.
+     */
+    private convertAttributes;
+    /**
+     * Recursively merge properties from source into target. When the target value is a Vec2,
+     * Vec3, Vec4 or Color and the source value is a plain numeric array, the array is converted
+     * to the target's type — so script attributes with math-typed defaults can be written as
+     * plain JSON arrays (e.g. `"focusPoint": [0, 1.75, 0]`).
+     * @param target - The target object to merge into.
+     * @param source - The source object to merge from.
+     * @returns The merged object.
+     */
+    private mergeDeep;
+    /**
+     * Checks whether a value is one of the math types that plain numeric arrays convert to.
+     * @param value - The value to check.
+     * @returns Whether the value is a math type.
+     */
+    private isMathType;
+    /**
+     * Converts a plain numeric array to the math type of `current`. A 3-element array targeting
+     * a Quat is interpreted as Euler angles in degrees, mirroring the `parseQuat` attribute
+     * grammar. Returns `null` (and logs a warning) when the array's length or contents don't
+     * match the type.
+     * @param current - The current (typed) value of the property.
+     * @param value - The incoming array.
+     * @param key - The property name, used in the warning message.
+     * @returns The converted value, or `null`.
+     */
+    private arrayToMathType;
+    /**
+     * Update script attributes by merging converted values into the script. `enabled` is always
+     * excluded (it is configured through the element's `enabled` attribute, not the JSON blob),
+     * as are any keys in `exclude` — used to keep per-property attributes authoritative over
+     * the blob without writing a property twice.
+     * @param script - The script to update.
+     * @param attributes - The attributes to merge into the script.
+     * @param exclude - Keys to strip from the merge.
+     */
+    private applyAttributes;
+    /**
+     * Returns the camelCase keys of the per-property attributes present on a `pc-script`
+     * element.
+     * @param scriptElement - The `pc-script` element.
+     * @returns The camelCase keys.
+     */
+    private inlineKeys;
+    /**
+     * Resolves the script instance owned by a `pc-script` element. Returns `null` when the
+     * element has no created script, or when its name resolves to a script created by a
+     * different element (e.g. a duplicate-named sibling).
+     * @param scriptElement - The `pc-script` element.
+     * @returns The owned script, or `null`.
+     */
+    private scriptFor;
+    private handleScriptAttributesChange;
+    private handleScriptEnableChange;
+    /**
+     * Handles a runtime `name` change on a child `pc-script`, swapping the engine script instance
+     * to match. Without this the element would keep pointing at the old-name instance: the old
+     * script would go on running while every subsequent update (attribute changes, enable
+     * changes, destruction on removal) resolved the new name and silently no-opped.
+     *
+     * The new instance is built by the normal creation path, so both attribute channels are
+     * re-applied to it and the declared enabled state is restored.
+     * @param event - The name change event.
+     */
+    private handleScriptNameChange;
+    /**
+     * Creates the script instance for a `pc-script` element. The instance is created disabled,
+     * the element's converted attributes are merged over the instance's defaults (which is what
+     * allows plain numeric arrays to be typed against those defaults), and only then is the
+     * declared enabled state applied — so `initialize()` runs with every attribute in place.
+     * @param scriptElement - The `pc-script` element to create the script instance for.
+     * @returns The created script, or `null`.
+     */
+    private createScript;
+    /**
+     * Applies the per-property attributes present on a `pc-script` element — any attribute that
+     * is not part of the element's own API or a reserved HTML attribute name. These are applied
+     * after the `attributes` JSON, so an individual attribute always takes precedence over the
+     * blob.
+     * @param script - The script to apply the attributes to.
+     * @param scriptElement - The `pc-script` element holding the attributes.
+     */
+    private applyInlineAttributes;
+    /**
+     * Applies a single per-property attribute change to the script of a `pc-script` element.
+     * When the attribute has been removed, the value from the `attributes` JSON (if any) takes
+     * effect again.
+     * @param scriptElement - The `pc-script` element whose attribute changed.
+     * @param attributeName - The name of the changed attribute.
+     */
+    private applyScriptProperty;
+    /**
+     * Applies one attribute string to a script property. A string-typed attribute takes the
+     * value verbatim (so literals like 'color:red' are never hijacked by prefix conversion).
+     * Otherwise, explicit prefixes (`asset:`, `entity:`, `vec2:`, `vec3:`, `vec4:`, `color:`)
+     * carry their own type, and unprefixed values are parsed according to the type of the
+     * attribute's current value. The Script API itself (methods, `entity`, `app`) is never
+     * overwritten, invalid values keep the current value, and exceptions thrown by user
+     * getters/setters are contained so one bad attribute cannot abort the rest of a batch.
+     * @param script - The script to apply the value to.
+     * @param scriptName - The script name, used in warning messages.
+     * @param attributeName - The (kebab-case) element attribute name.
+     * @param value - The attribute value.
+     */
+    private setScriptProperty;
+    private destroyScript;
+    private handleMutations;
+    disconnectedCallback(): void;
+    /**
+     * Gets the underlying PlayCanvas script component.
+     * @returns The script component.
+     */
+    get component(): ScriptComponent;
+}
+export { ScriptComponentElement };

package/dist/components/script-component.d.ts

@@ -1,5 +1,5 @@
 import type { ScriptComponent } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 export type ScriptAttributesChangeEvent = {
     detail: {
         attributes: Record<string, any>;

package/dist/components/script.d.cts

@@ -0,0 +1,94 @@
+import type { Script } from 'playcanvas';
+import { AsyncElement } from '../async-element.cjs';
+/**
+ * The ScriptElement interface provides properties and methods for manipulating
+ * `<pc-script>` elements. The ScriptElement interface also inherits the properties and
+ * methods of the {@link AsyncElement} interface.
+ *
+ * Script attributes can be supplied through two channels:
+ *
+ * - **Per-property attributes**: any non-reserved attribute on the element maps to the script
+ *   attribute of the same name (kebab-case to camelCase, e.g. `focus-point` → `focusPoint`).
+ *   Values are parsed according to the type of the attribute's current value — initially the
+ *   script's declared default (numbers, booleans, strings, Vec2/3/4, Color, Quat as Euler
+ *   angles) — and the `asset:`/`entity:`/`vec2:`/`vec3:`/`vec4:`/`color:` prefixes may be used
+ *   to be explicit.
+ * - **The `attributes` JSON attribute**: an object supporting nested structures and attribute
+ *   names that collide with reserved HTML attribute names (e.g. `title`).
+ *
+ * When both specify the same attribute, the per-property attribute wins — at creation and
+ * whenever either channel changes at runtime. The element's own `name` and `enabled`
+ * attributes configure the element itself and are not script attributes.
+ *
+ * Changing `name` on a live element destroys the old-name script instance and creates the
+ * new-name one, re-applying both attribute channels to it.
+ *
+ * The element becomes ready once its script instance has been created by the parent
+ * `<pc-scripts>` element.
+ *
+ * @fires {CustomEvent} scriptattributeschange - Fired when the script's attributes change. The
+ * `detail` carries the new `attributes` object. Bubbles.
+ * @fires {CustomEvent} scriptenablechange - Fired when the script's enabled state changes. The
+ * `detail` carries the new `enabled` state. Bubbles.
+ * @fires {CustomEvent} scriptnamechange - Fired when the script is renamed on a live element. The
+ * `detail` carries `oldName` and `newName`. Bubbles.
+ */
+declare class ScriptElement extends AsyncElement {
+    private _attributes;
+    private _enabled;
+    /**
+     * Sets the attributes of the script as an object. Values are converted with the same rules
+     * as the `attributes` attribute: `asset:`/`entity:` references and `vec2:`/`vec3:`/`vec4:`/
+     * `color:` prefixed strings are resolved, and a plain numeric array is converted to the
+     * type of the attribute it targets when that attribute currently holds a Vec2, Vec3, Vec4
+     * or Color.
+     * @param value - The attributes of the script.
+     */
+    set scriptAttributes(value: Record<string, any>);
+    /**
+     * Gets the attributes of the script.
+     * @returns The attributes of the script.
+     */
+    get scriptAttributes(): Record<string, any>;
+    /**
+     * Sets the enabled state of the script.
+     * @param value - The enabled state of the script.
+     */
+    set enabled(value: boolean);
+    /**
+     * Gets the enabled state of the script.
+     * @returns The enabled state of the script.
+     */
+    get enabled(): boolean;
+    /**
+     * Sets the name of the script to create. The `name` attribute is the single source of truth
+     * (it is what the parent `<pc-scripts>` element reads when creating the instance), so the
+     * property writes through to it — assigning before insertion works as expected:
+     *
+     * ```js
+     * const script = document.createElement('pc-script');
+     * script.name = 'rotate';
+     * scriptsElement.appendChild(script);
+     * await script.ready();
+     * ```
+     * @param value - The name.
+     */
+    set name(value: string);
+    /**
+     * Gets the name of the script.
+     * @returns The name.
+     */
+    get name(): string;
+    /**
+     * Gets the {@link Script} instance created for this element. Returns `null` until the
+     * instance exists — await {@link whenReady} or the element's `ready()` promise before
+     * accessing it.
+     * @returns The script instance, or `null`.
+     */
+    get script(): Script | null;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+}
+export { ScriptElement };

package/dist/components/script.d.ts

@@ -1,5 +1,5 @@
 import type { Script } from 'playcanvas';
-import { AsyncElement } from '../async-element';
+import { AsyncElement } from '../async-element.js';
 /**
  * The ScriptElement interface provides properties and methods for manipulating
  * `<pc-script>` elements. The ScriptElement interface also inherits the properties and

package/dist/components/scrollbar-component.d.cts

@@ -0,0 +1,69 @@
+import type { ScrollbarComponent } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The ScrollbarComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/ | `<pc-scrollbar>`} elements.
+ * The ScrollbarComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScrollbarComponentElement extends ComponentElement {
+    private _orientation;
+    private _value;
+    private _handleSize;
+    private _handle;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): Record<string, any>;
+    /**
+     * Gets the underlying PlayCanvas scrollbar component.
+     * @returns The scrollbar component.
+     */
+    get component(): ScrollbarComponent;
+    /**
+     * Sets the orientation of the scrollbar. Can be `horizontal` or `vertical`. Defaults to
+     * `horizontal`.
+     * @param value - The orientation.
+     */
+    set orientation(value: 'horizontal' | 'vertical');
+    /**
+     * Gets the orientation of the scrollbar.
+     * @returns The orientation.
+     */
+    get orientation(): "horizontal" | "vertical";
+    /**
+     * Sets the current position value of the scrollbar, in the range 0 to 1.
+     * @param value - The scrollbar value.
+     */
+    set value(value: number);
+    /**
+     * Gets the current position value of the scrollbar.
+     * @returns The scrollbar value.
+     */
+    get value(): number;
+    /**
+     * Sets the size of the handle relative to the size of the track, in the range 0 to 1.
+     * @param value - The handle size.
+     */
+    set handleSize(value: number);
+    /**
+     * Gets the size of the handle relative to the size of the track.
+     * @returns The handle size.
+     */
+    get handleSize(): number;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * scrollbar handle.
+     * @param value - The handle entity reference.
+     */
+    set handle(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the scrollbar handle.
+     * @returns The handle entity reference.
+     */
+    get handle(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { ScrollbarComponentElement };

package/dist/components/scrollbar-component.d.ts

@@ -1,5 +1,5 @@
 import type { ScrollbarComponent } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The ScrollbarComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/ | `<pc-scrollbar>`} elements.

package/dist/components/scrollview-component.d.cts

@@ -0,0 +1,178 @@
+import type { ScrollViewComponent } from 'playcanvas';
+import { Vec2 } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The ScrollViewComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollview/ | `<pc-scrollview>`} elements.
+ * The ScrollViewComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class ScrollViewComponentElement extends ComponentElement {
+    private _horizontal;
+    private _vertical;
+    private _scrollMode;
+    private _bounceAmount;
+    private _friction;
+    private _useMouseWheel;
+    private _mouseWheelSensitivity;
+    private _horizontalScrollbarVisibility;
+    private _verticalScrollbarVisibility;
+    private _viewport;
+    private _content;
+    private _horizontalScrollbar;
+    private _verticalScrollbar;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): Record<string, any>;
+    /**
+     * Gets the underlying PlayCanvas scroll view component.
+     * @returns The scroll view component.
+     */
+    get component(): ScrollViewComponent;
+    /**
+     * Sets whether scrolling along the horizontal axis is enabled. This is a toggle, unlike the
+     * `orientation` of a `<pc-scrollbar>`, for which `horizontal` is one of the accepted values.
+     * @param value - Whether horizontal scrolling is enabled.
+     */
+    set horizontal(value: boolean);
+    /**
+     * Gets whether scrolling along the horizontal axis is enabled.
+     * @returns Whether horizontal scrolling is enabled.
+     */
+    get horizontal(): boolean;
+    /**
+     * Sets whether scrolling along the vertical axis is enabled. This is a toggle, unlike the
+     * `orientation` of a `<pc-scrollbar>`, for which `vertical` is one of the accepted values.
+     * @param value - Whether vertical scrolling is enabled.
+     */
+    set vertical(value: boolean);
+    /**
+     * Gets whether scrolling along the vertical axis is enabled.
+     * @returns Whether vertical scrolling is enabled.
+     */
+    get vertical(): boolean;
+    /**
+     * Sets how the scroll view should behave when the content is scrolled beyond its bounds. Can be
+     * `clamp`, `bounce` or `infinite`. Defaults to `bounce`.
+     * @param value - The scroll mode.
+     */
+    set scrollMode(value: 'clamp' | 'bounce' | 'infinite');
+    /**
+     * Gets how the scroll view behaves when the content is scrolled beyond its bounds.
+     * @returns The scroll mode.
+     */
+    get scrollMode(): "clamp" | "bounce" | "infinite";
+    /**
+     * Sets how far the content is allowed to bounce beyond its bounds when `scroll-mode` is
+     * `bounce`, in the range 0 to 1.
+     * @param value - The bounce amount.
+     */
+    set bounceAmount(value: number);
+    /**
+     * Gets the bounce amount.
+     * @returns The bounce amount.
+     */
+    get bounceAmount(): number;
+    /**
+     * Sets how freely the content moves once thrown, in the range 0 (no friction) to 1.
+     * @param value - The friction.
+     */
+    set friction(value: number);
+    /**
+     * Gets the friction.
+     * @returns The friction.
+     */
+    get friction(): number;
+    /**
+     * Sets whether the scroll view responds to mouse wheel events.
+     * @param value - Whether to use the mouse wheel.
+     */
+    set useMouseWheel(value: boolean);
+    /**
+     * Gets whether the scroll view responds to mouse wheel events.
+     * @returns Whether the mouse wheel is used.
+     */
+    get useMouseWheel(): boolean;
+    /**
+     * Sets the mouse wheel sensitivity as a Vec2 (horizontal, vertical). A value of 0 on an axis
+     * disables mouse wheel scrolling for that axis.
+     * @param value - The mouse wheel sensitivity.
+     */
+    set mouseWheelSensitivity(value: Vec2);
+    /**
+     * Gets the mouse wheel sensitivity.
+     * @returns The mouse wheel sensitivity.
+     */
+    get mouseWheelSensitivity(): Vec2;
+    /**
+     * Sets the visibility of the horizontal scrollbar. Can be `always` or `when-required`.
+     * Defaults to `when-required`.
+     * @param value - The horizontal scrollbar visibility.
+     */
+    set horizontalScrollbarVisibility(value: 'always' | 'when-required');
+    /**
+     * Gets the visibility of the horizontal scrollbar.
+     * @returns The horizontal scrollbar visibility.
+     */
+    get horizontalScrollbarVisibility(): "always" | "when-required";
+    /**
+     * Sets the visibility of the vertical scrollbar. Can be `always` or `when-required`.
+     * Defaults to `when-required`.
+     * @param value - The vertical scrollbar visibility.
+     */
+    set verticalScrollbarVisibility(value: 'always' | 'when-required');
+    /**
+     * Gets the visibility of the vertical scrollbar.
+     * @returns The vertical scrollbar visibility.
+     */
+    get verticalScrollbarVisibility(): "always" | "when-required";
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * viewport, which clips the content to the scroll view's bounds.
+     * @param value - The viewport entity reference.
+     */
+    set viewport(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the viewport.
+     * @returns The viewport entity reference.
+     */
+    get viewport(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` used as the
+     * content, which is moved as the scroll view is scrolled.
+     * @param value - The content entity reference.
+     */
+    set content(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` used as the content.
+     * @returns The content entity reference.
+     */
+    get content(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` containing
+     * the horizontal `<pc-scrollbar>`.
+     * @param value - The horizontal scrollbar entity reference.
+     */
+    set horizontalScrollbar(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` containing the horizontal scrollbar.
+     * @returns The horizontal scrollbar entity reference.
+     */
+    get horizontalScrollbar(): string;
+    /**
+     * Sets the reference (CSS selector, element id or entity name) to the `<pc-entity>` containing
+     * the vertical `<pc-scrollbar>`.
+     * @param value - The vertical scrollbar entity reference.
+     */
+    set verticalScrollbar(value: string);
+    /**
+     * Gets the reference to the `<pc-entity>` containing the vertical scrollbar.
+     * @returns The vertical scrollbar entity reference.
+     */
+    get verticalScrollbar(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { ScrollViewComponentElement };

package/dist/components/scrollview-component.d.ts

@@ -1,6 +1,6 @@
 import type { ScrollViewComponent } from 'playcanvas';
 import { Vec2 } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The ScrollViewComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollview/ | `<pc-scrollview>`} elements.

package/dist/components/sound-component.d.cts

@@ -0,0 +1,108 @@
+import type { SoundComponent } from 'playcanvas';
+import { ComponentElement } from './component.cjs';
+/**
+ * The SoundComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.
+ * The SoundComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class SoundComponentElement extends ComponentElement {
+    private _distanceModel;
+    private _maxDistance;
+    private _pitch;
+    private _positional;
+    private _refDistance;
+    private _rollOffFactor;
+    private _volume;
+    /** @ignore */
+    constructor();
+    protected getInitialComponentData(): {
+        distanceModel: "linear" | "exponential" | "inverse";
+        maxDistance: number;
+        pitch: number;
+        positional: boolean;
+        refDistance: number;
+        rollOffFactor: number;
+        volume: number;
+    };
+    /**
+     * Gets the underlying PlayCanvas sound component.
+     * @returns The sound component.
+     */
+    get component(): SoundComponent;
+    /**
+     * Sets which algorithm to use to reduce the volume of the sound as it moves away from the listener.
+     * @param value - The distance model.
+     */
+    set distanceModel(value: 'exponential' | 'inverse' | 'linear');
+    /**
+     * Gets which algorithm to use to reduce the volume of the sound as it moves away from the listener.
+     * @returns The distance model.
+     */
+    get distanceModel(): 'exponential' | 'inverse' | 'linear';
+    /**
+     * Sets the maximum distance from the listener at which audio falloff stops.
+     * @param value - The max distance.
+     */
+    set maxDistance(value: number);
+    /**
+     * Gets the maximum distance from the listener at which audio falloff stops.
+     * @returns The max distance.
+     */
+    get maxDistance(): number;
+    /**
+     * Sets the pitch of the sound.
+     * @param value - The pitch.
+     */
+    set pitch(value: number);
+    /**
+     * Gets the pitch of the sound.
+     * @returns The pitch.
+     */
+    get pitch(): number;
+    /**
+     * Sets the positional flag of the sound.
+     * @param value - The positional flag.
+     */
+    set positional(value: boolean);
+    /**
+     * Gets the positional flag of the sound.
+     * @returns The positional flag.
+     */
+    get positional(): boolean;
+    /**
+     * Sets the reference distance for reducing volume as the sound source moves further from the listener. Defaults to 1.
+     * @param value - The ref distance.
+     */
+    set refDistance(value: number);
+    /**
+     * Gets the reference distance for reducing volume as the sound source moves further from the listener.
+     * @returns The ref distance.
+     */
+    get refDistance(): number;
+    /**
+     * Sets the factor used in the falloff equation. Defaults to 1.
+     * @param value - The roll-off factor.
+     */
+    set rollOffFactor(value: number);
+    /**
+     * Gets the factor used in the falloff equation.
+     * @returns The roll-off factor.
+     */
+    get rollOffFactor(): number;
+    /**
+     * Sets the volume of the sound.
+     * @param value - The volume.
+     */
+    set volume(value: number);
+    /**
+     * Gets the volume of the sound.
+     * @returns The volume.
+     */
+    get volume(): number;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
+}
+export { SoundComponentElement };

package/dist/components/sound-component.d.ts

@@ -1,5 +1,5 @@
 import type { SoundComponent } from 'playcanvas';
-import { ComponentElement } from './component';
+import { ComponentElement } from './component.js';
 /**
  * The SoundComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.