@playcanvas/web-components 0.17.0 → 0.18.0

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

@@ -9,14 +9,21 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link LightComponent} (`light`).
  *
+ * @elementSummary The `<pc-light>` element lights the scene from its entity — as a directional,
+ * omni or spot light — with attributes for color, intensity, range and shadows. Must be a child of
+ * a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class LightComponentElement extends ComponentElement {
+    private _cascadeBlend;
+    private _cascadeDistribution;
     private _castShadows;
     private _color;
     private _innerConeAngle;
     private _intensity;
     private _normalOffsetBias;
+    private _numCascades;
     private _outerConeAngle;
     private _range;
     private _shadowBias;
@@ -34,11 +41,14 @@ declare class LightComponentElement extends ComponentElement {
     /** @ignore */
     constructor();
     protected getInitialComponentData(): {
+        cascadeBlend: number;
+        cascadeDistribution: number;
         castShadows: boolean;
         color: Color;
         innerConeAngle: number;
         intensity: number;
         normalOffsetBias: number;
+        numCascades: number;
         outerConeAngle: number;
         penumbraFalloff: number;
         penumbraSize: number;
@@ -49,7 +59,7 @@ declare class LightComponentElement extends ComponentElement {
         shadowIntensity: number;
         shadowResolution: number;
         shadowSamples: number;
-        shadowType: number | undefined;
+        shadowType: number;
         type: "directional" | "omni" | "spot";
         vsmBias: number;
         vsmBlurSize: number;
@@ -59,6 +69,33 @@ declare class LightComponentElement extends ComponentElement {
      * @returns The light component.
      */
     get component(): LightComponent;
+    /**
+     * Sets the fraction of each shadow cascade that is blended into the next one, from 0 (no
+     * blending) to 1, which applies only to `directional` lights with `num-cascades` greater than
+     * 1. Defaults to 0.
+     * @param value - The cascade blend factor.
+     */
+    set cascadeBlend(value: number);
+    /**
+     * Gets the cascade blend factor of the light, from 0 (no blending) to 1, which applies only to
+     * `directional` lights with `num-cascades` greater than 1.
+     * @returns The cascade blend factor.
+     */
+    get cascadeBlend(): number;
+    /**
+     * Sets the distribution of the camera frustum split between shadow cascades, from 0 (linear
+     * split) to 1 (logarithmic split, concentrating shadow resolution near the camera), which
+     * applies only to `directional` lights with `num-cascades` greater than 1. Defaults to 0.5.
+     * @param value - The cascade distribution.
+     */
+    set cascadeDistribution(value: number);
+    /**
+     * Gets the cascade distribution of the light, from 0 (linear split) to 1 (logarithmic split,
+     * concentrating shadow resolution near the camera), which applies only to `directional` lights
+     * with `num-cascades` greater than 1.
+     * @returns The cascade distribution.
+     */
+    get cascadeDistribution(): number;
     /**
      * Sets the cast shadows flag of the light.
      * @param value - The cast shadows flag.
@@ -109,6 +146,18 @@ declare class LightComponentElement extends ComponentElement {
      * @returns The normal offset bias.
      */
     get normalOffsetBias(): number;
+    /**
+     * Sets the number of shadow cascades of the light, an integer from 1 (no cascades) to 4, which
+     * applies only to `directional` lights. Defaults to 1.
+     * @param value - The number of shadow cascades.
+     */
+    set numCascades(value: number);
+    /**
+     * Gets the number of shadow cascades of the light, an integer from 1 (no cascades) to 4, which
+     * applies only to `directional` lights.
+     * @returns The number of shadow cascades.
+     */
+    get numCascades(): number;
     /**
      * Sets the outer cone angle of the light.
      * @param value - The outer cone angle.

package/dist/components/particle-system-component.d.cts

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link ParticleSystemComponent} (`particlesystem`).
  *
+ * @elementSummary The `<pc-particle-system>` element emits particles from its entity, with
+ * attributes for the emitter's shape, rate, lifetime, textures and blending. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ParticleSystemComponentElement extends ComponentElement {

package/dist/components/particle-system-component.d.ts

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link ParticleSystemComponent} (`particlesystem`).
  *
+ * @elementSummary The `<pc-particle-system>` element emits particles from its entity, with
+ * attributes for the emitter's shape, rate, lifetime, textures and blending. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ParticleSystemComponentElement extends ComponentElement {

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

@@ -12,6 +12,11 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link RenderComponent} (`render`).
  *
+ * @elementSummary The `<pc-render>` element renders one of the engine's built-in primitives at its
+ * entity — box, sphere, capsule, cone, cylinder or plane — shaded by the `<pc-material>` its
+ * `material` attribute names. For glTF content, use `<pc-model>` instead. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class RenderComponentElement extends ComponentElement {

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

@@ -12,6 +12,11 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link RenderComponent} (`render`).
  *
+ * @elementSummary The `<pc-render>` element renders one of the engine's built-in primitives at its
+ * entity — box, sphere, capsule, cone, cylinder or plane — shaded by the `<pc-material>` its
+ * `material` attribute names. For glTF content, use `<pc-model>` instead. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class RenderComponentElement extends ComponentElement {

package/dist/components/rigid-body-component.d.cts

@@ -9,6 +9,11 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link RigidBodyComponent} (`rigidbody`).
  *
+ * @elementSummary The `<pc-rigid-body>` element hands its entity to the physics simulation, with
+ * attributes for its type, mass, friction and restitution. It needs a sibling `<pc-collision>` for
+ * its shape, and `Ammo` loaded through `<pc-wasm>`. Must be a child of a `<pc-entity>`,
+ * `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class RigidBodyComponentElement extends ComponentElement {

package/dist/components/rigid-body-component.d.ts

@@ -9,6 +9,11 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link RigidBodyComponent} (`rigidbody`).
  *
+ * @elementSummary The `<pc-rigid-body>` element hands its entity to the physics simulation, with
+ * attributes for its type, mass, friction and restitution. It needs a sibling `<pc-collision>` for
+ * its shape, and `Ammo` loaded through `<pc-wasm>`. Must be a child of a `<pc-entity>`,
+ * `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class RigidBodyComponentElement extends ComponentElement {

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

@@ -9,6 +9,10 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link ScreenComponent} (`screen`).
  *
+ * @elementSummary The `<pc-screen>` element gives its entity a 2D space — in screen space or in the
+ * world — that a hierarchy of `<pc-element>` descendants lays out inside. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScreenComponentElement extends ComponentElement {

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

@@ -9,6 +9,10 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link ScreenComponent} (`screen`).
  *
+ * @elementSummary The `<pc-screen>` element gives its entity a 2D space — in screen space or in the
+ * world — that a hierarchy of `<pc-element>` descendants lays out inside. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScreenComponentElement extends ComponentElement {

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

@@ -24,6 +24,9 @@ export type ScriptNameChangeEvent = {
  *
  * Engine component: {@link ScriptComponent} (`script`).
  *
+ * @elementSummary The `<pc-script>` element holds the `<pc-script-instance>` children that attach
+ * scripts to its entity. Must be a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScriptComponentElement extends ComponentElement {

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

@@ -24,6 +24,9 @@ export type ScriptNameChangeEvent = {
  *
  * Engine component: {@link ScriptComponent} (`script`).
  *
+ * @elementSummary The `<pc-script>` element holds the `<pc-script-instance>` children that attach
+ * scripts to its entity. Must be a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScriptComponentElement extends ComponentElement {

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

@@ -26,6 +26,10 @@ import { AsyncElement } from '../async-element.cjs';
  * The element becomes ready once its script instance has been created by the parent
  * `<pc-script>` element.
  *
+ * @elementSummary The `<pc-script-instance>` element attaches one script class, named by `name`, to
+ * the entity of its parent `<pc-script>`. Its other attributes set script attributes of the same
+ * name, and `attributes` takes a JSON object instead. Must be a direct child of `<pc-script>`.
+ *
  * @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

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

@@ -26,6 +26,10 @@ import { AsyncElement } from '../async-element.js';
  * The element becomes ready once its script instance has been created by the parent
  * `<pc-script>` element.
  *
+ * @elementSummary The `<pc-script-instance>` element attaches one script class, named by `name`, to
+ * the entity of its parent `<pc-script>`. Its other attributes set script attributes of the same
+ * name, and `attributes` takes a JSON object instead. Must be a direct child of `<pc-script>`.
+ *
  * @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

package/dist/components/scroll-view-component.d.cts

@@ -9,6 +9,10 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link ScrollViewComponent} (`scrollview`).
  *
+ * @elementSummary The `<pc-scroll-view>` element scrolls a larger content entity within a clipped
+ * viewport at its entity, optionally driven by the `<pc-scrollbar>` elements it references. Must be
+ * a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScrollViewComponentElement extends ComponentElement {

package/dist/components/scroll-view-component.d.ts

@@ -9,6 +9,10 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link ScrollViewComponent} (`scrollview`).
  *
+ * @elementSummary The `<pc-scroll-view>` element scrolls a larger content entity within a clipped
+ * viewport at its entity, optionally driven by the `<pc-scrollbar>` elements it references. Must be
+ * a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScrollViewComponentElement extends ComponentElement {

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

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link ScrollbarComponent} (`scrollbar`).
  *
+ * @elementSummary The `<pc-scrollbar>` element gives its entity a draggable handle reporting a
+ * position from 0 to 1, which a `<pc-scroll-view>` references to scroll its content. Must be a
+ * child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScrollbarComponentElement extends ComponentElement {

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

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link ScrollbarComponent} (`scrollbar`).
  *
+ * @elementSummary The `<pc-scrollbar>` element gives its entity a draggable handle reporting a
+ * position from 0 to 1, which a `<pc-scroll-view>` references to scroll its content. Must be a
+ * child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class ScrollbarComponentElement extends ComponentElement {

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

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.cjs';
  *
  * Engine component: {@link SoundComponent} (`sound`).
  *
+ * @elementSummary The `<pc-sound>` element holds the `<pc-sound-slot>` children that play sounds at
+ * its entity, along with the positional audio settings they share. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class SoundComponentElement extends ComponentElement {

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

@@ -8,6 +8,10 @@ import { ComponentElement } from './component.js';
  *
  * Engine component: {@link SoundComponent} (`sound`).
  *
+ * @elementSummary The `<pc-sound>` element holds the `<pc-sound-slot>` children that play sounds at
+ * its entity, along with the positional audio settings they share. Must be a child of a
+ * `<pc-entity>`, `<pc-model>` or `<pc-node>`.
+ *
  * @category Components
  */
 declare class SoundComponentElement extends ComponentElement {

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

@@ -5,6 +5,9 @@ import { SoundComponentElement } from './sound-component.cjs';
  * The SoundSlotElement interface provides properties and methods for manipulating
  * `<pc-sound-slot>` elements. The SoundSlotElement interface also inherits the properties and
  * methods of the {@link AsyncElement} interface.
+ *
+ * @elementSummary The `<pc-sound-slot>` element declares one named sound on its parent `<pc-sound>`
+ * — its asset, volume, pitch, looping and autoplay. Must be a direct child of `<pc-sound>`.
  */
 declare class SoundSlotElement extends AsyncElement {
     private _asset;

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

@@ -5,6 +5,9 @@ import { SoundComponentElement } from './sound-component.js';
  * The SoundSlotElement interface provides properties and methods for manipulating
  * `<pc-sound-slot>` elements. The SoundSlotElement interface also inherits the properties and
  * methods of the {@link AsyncElement} interface.
+ *
+ * @elementSummary The `<pc-sound-slot>` element declares one named sound on its parent `<pc-sound>`
+ * — its asset, volume, pitch, looping and autoplay. Must be a direct child of `<pc-sound>`.
  */
 declare class SoundSlotElement extends AsyncElement {
     private _asset;