@playcanvas/web-components 0.1.10 → 0.1.12

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

@@ -2,8 +2,9 @@ import { ScreenComponent, Vec2 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ScreenComponentElement interface provides properties and methods for manipulating
- * `<pc-screen>` elements. The ScreenComponentElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-screen/ | `<pc-screen>`} elements.
+ * The ScreenComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  *
  * @category Components
  */
@@ -25,7 +26,7 @@ declare class ScreenComponentElement extends ComponentElement {
         screenSpace: boolean;
     };
     /**
-     * Gets the screen component.
+     * Gets the underlying PlayCanvas screen component.
      * @returns The screen component.
      */
     get component(): ScreenComponent | null;

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

@@ -18,8 +18,9 @@ declare global {
 }
 /**
  * The ScriptComponentElement interface provides properties and methods for manipulating
- * `<pc-scripts>` elements. The ScriptComponentElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
+ * The ScriptComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  *
  * @category Components
  */
@@ -36,7 +37,7 @@ declare class ScriptComponentElement extends ComponentElement {
     private handleMutations;
     disconnectedCallback(): void;
     /**
-     * Gets the script component.
+     * Gets the underlying PlayCanvas script component.
      * @returns The script component.
      */
     get component(): ScriptComponent | null;

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

@@ -2,8 +2,9 @@ import { SoundComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The SoundComponentElement interface provides properties and methods for manipulating
- * `<pc-sounds>` elements. The SoundComponentElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.
+ * The SoundComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  *
  * @category Components
  */
@@ -27,7 +28,7 @@ declare class SoundComponentElement extends ComponentElement {
         volume: number;
     };
     /**
-     * Gets the sound component.
+     * Gets the underlying PlayCanvas sound component.
      * @returns The sound component.
      */
     get component(): SoundComponent | null;

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

@@ -24,12 +24,12 @@ declare class SoundSlotElement extends AsyncElement {
     disconnectedCallback(): void;
     protected get soundElement(): SoundComponentElement | null;
     /**
-     * Sets the asset of the sound slot.
+     * Sets the id of the `pc-asset` to use for the sound slot.
      * @param value - The asset.
      */
     set asset(value: string);
     /**
-     * Gets the asset of the sound slot.
+     * Gets the id of the `pc-asset` to use for the sound slot.
      * @returns The asset.
      */
     get asset(): string;

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

@@ -0,0 +1,36 @@
+import { GSplatComponent } from 'playcanvas';
+import { ComponentElement } from './component';
+/**
+ * The SplatComponentElement interface provides properties and methods for manipulating
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-splat/ | `<pc-splat>`} elements.
+ * The SplatComponentElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
+ *
+ * @category Components
+ */
+declare class SplatComponentElement extends ComponentElement {
+    private _asset;
+    /** @ignore */
+    constructor();
+    getInitialComponentData(): {
+        asset: import("playcanvas").Asset | null | undefined;
+    };
+    /**
+     * Gets the underlying PlayCanvas splat component.
+     * @returns The splat component.
+     */
+    get component(): GSplatComponent | null;
+    /**
+     * Sets id of the `pc-asset` to use for the splat.
+     * @param value - The asset ID.
+     */
+    set asset(value: string);
+    /**
+     * Gets the id of the `pc-asset` to use for the splat.
+     * @returns The asset ID.
+     */
+    get asset(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
+}
+export { SplatComponentElement };

package/dist/entity.d.ts

@@ -2,8 +2,9 @@ import { Application, Entity, Vec3 } from 'playcanvas';
 import { AsyncElement } from './async-element';
 /**
  * The EntityElement interface provides properties and methods for manipulating
- * `<pc-entity>` elements. The EntityElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-entity/ | `<pc-entity>`} elements.
+ * The EntityElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  */
 declare class EntityElement extends AsyncElement {
     /**

package/dist/index.d.ts

@@ -16,7 +16,7 @@ import { CameraComponentElement } from './components/camera-component';
 import { CollisionComponentElement } from './components/collision-component';
 import { ComponentElement } from './components/component';
 import { ElementComponentElement } from './components/element-component';
-import { GSplatComponentElement } from './components/gsplat-component';
+import { SplatComponentElement } from './components/splat-component';
 import { LightComponentElement } from './components/light-component';
 import { RenderComponentElement } from './components/render-component';
 import { RigidBodyComponentElement } from './components/rigidbody-component';
@@ -29,4 +29,4 @@ import { MaterialElement } from './material';
 import { ModelElement } from './model';
 import { SceneElement } from './scene';
 import { SkyElement } from './sky';
-export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, GSplatComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, MaterialElement, ModelElement, SceneElement, SkyElement };
+export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, SplatComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, MaterialElement, ModelElement, SceneElement, SkyElement };

package/dist/material.d.ts

@@ -1,8 +1,9 @@
 import { Color, StandardMaterial } from 'playcanvas';
 /**
  * The MaterialElement interface provides properties and methods for manipulating
- * `<pc-material>` elements. The MaterialElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-material/ | `<pc-material>`} elements.
+ * The MaterialElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  */
 declare class MaterialElement extends HTMLElement {
     private _diffuse;

package/dist/model.d.ts

@@ -1,8 +1,9 @@
 import { AsyncElement } from './async-element';
 /**
  * The ModelElement interface provides properties and methods for manipulating
- * `<pc-model>` elements. The ModelElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-model/ | `<pc-model>`} elements.
+ * The ModelElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  */
 declare class ModelElement extends AsyncElement {
     private _asset;
@@ -13,13 +14,13 @@ declare class ModelElement extends AsyncElement {
     private _loadModel;
     private _unloadModel;
     /**
-     * Sets the asset ID of the model.
+     * Sets the id of the `pc-asset` to use for the model.
      * @param value - The asset ID.
      */
     set asset(value: string);
     /**
-     * Gets the source URL of the model.
-     * @returns The source URL of the model.
+     * Gets the id of the `pc-asset` to use for the model.
+     * @returns The asset ID.
      */
     get asset(): string;
     static get observedAttributes(): string[];

package/dist/module.d.ts

@@ -1,7 +1,8 @@
 /**
  * The ModuleElement interface provides properties and methods for manipulating
- * `<pc-module>` elements. The ModuleElement interface also inherits the properties and
- * methods of the {@link HTMLElement} interface.
+ * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-module/ | `<pc-module>`} elements.
+ * The ModuleElement interface also inherits the properties and methods of the
+ * {@link HTMLElement} interface.
  */
 declare class ModuleElement extends HTMLElement {
     private loadPromise;