@playcanvas/web-components 0.10.0 → 0.11.0

package/dist/scene.d.ts

@@ -33,13 +33,21 @@ declare class SceneElement extends AsyncElement {
     private _gravity;
     private _scene;
     /**
-     * The PlayCanvas scene instance. Available once the element is ready — await
+     * The PlayCanvas scene instance. `null` until the element is ready — await
      * {@link whenReady} or the element's `ready()` promise before accessing it.
-     * @returns The scene instance.
+     * @returns The scene instance, or `null`.
      */
-    get scene(): Scene;
+    get scene(): Scene | null;
     connectedCallback(): Promise<void>;
     updateSceneSettings(): void;
+    /**
+     * Applies gravity to the rigid body system. Resolved through `closestApp` rather than
+     * `parentElement` so that a `<pc-scene>` nested inside a wrapper element behaves the same as
+     * a direct child, matching how `connectedCallback` resolves the application.
+     *
+     * @param value - The gravity to apply.
+     */
+    private _applyGravity;
     /**
      * Sets the fog type of the scene. Can be `none`, `linear`, `exp` or `exp2`. Defaults to
      * `none`.

package/dist/sky.d.ts

@@ -10,7 +10,7 @@ declare class SkyElement extends AsyncElement {
     private _center;
     private _intensity;
     private _rotation;
-    private _level;
+    private _mipLevel;
     private _lighting;
     private _scale;
     private _type;
@@ -51,16 +51,6 @@ declare class SkyElement extends AsyncElement {
      * @returns The intensity.
      */
     get intensity(): number;
-    /**
-     * Sets the mip level of the skybox.
-     * @param value - The mip level.
-     */
-    set level(value: number);
-    /**
-     * Gets the mip level of the skybox.
-     * @returns The mip level.
-     */
-    get level(): number;
     /**
      * Sets whether the skybox is used as a light source.
      * @param value - Whether to use lighting.
@@ -71,6 +61,17 @@ declare class SkyElement extends AsyncElement {
      * @returns Whether to use lighting.
      */
     get lighting(): boolean;
+    /**
+     * Sets the mip level of the skybox, where 0 is the sharpest. Raising it selects a blurrier mip,
+     * which is how a skybox is softened without blurring the texture itself.
+     * @param value - The mip level.
+     */
+    set mipLevel(value: number);
+    /**
+     * Gets the mip level of the skybox.
+     * @returns The mip level.
+     */
+    get mipLevel(): number;
     /**
      * Sets the Euler rotation of the skybox.
      * @param value - The rotation.

package/dist/vscode.html-custom-data.json

@@ -4,12 +4,16 @@
   "tags": [
     {
       "name": "pc-app",
-      "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
+      "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n - **elementFromEntity(entity: _Entity_): __** - Returns the `<pc-entity>` element whose backing entity is `entity`, or `null` if the\nentity was not created by an element of this application - for example, a node inside a\nmodel's instantiated hierarchy, or an entity created through the engine API.\n\n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
       "attributes": [
-        { "name": "alpha", "description": "The alpha flag.", "values": [] },
+        {
+          "name": "alpha",
+          "description": "Whether the frame buffer has an alpha channel.",
+          "values": []
+        },
         {
           "name": "antialias",
-          "description": "The antialias flag.",
+          "description": "Whether the frame buffer is anti-aliased.",
           "values": []
         },
         {
@@ -21,19 +25,32 @@
             { "name": "null" }
           ]
         },
-        { "name": "depth", "description": "The depth flag.", "values": [] },
         {
-          "name": "high-resolution",
-          "description": "The high resolution flag.",
+          "name": "depth-buffer",
+          "description": "Whether the frame buffer has a depth buffer.",
+          "values": []
+        },
+        {
+          "name": "loading-bar",
+          "description": "Whether the application shows its built-in loading bar while it boots and preloads its assets.",
+          "values": []
+        },
+        {
+          "name": "max-pixel-ratio",
+          "description": "The cap on the pixel ratio the application renders at.",
           "values": []
         },
-        { "name": "stencil", "description": "The stencil flag.", "values": [] }
+        {
+          "name": "stencil-buffer",
+          "description": "Whether the frame buffer has a stencil buffer.",
+          "values": []
+        }
       ],
       "references": []
     },
     {
       "name": "pc-asset",
-      "description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nApart from `lazy`, these attributes are read once when the asset is created, so changing them\nlater has no effect.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
+      "description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nApart from `lazy`, these attributes are read once when the asset is created, so changing them\nlater has no effect.\n\n---\n\n\n### **Events:**\n - **error** - Fired when the asset fails to load, with the engine's error in `message`. Does not bubble. The element still becomes ready — readiness means the load settled, not that it succeeded.\n- **load** - Fired each time the asset finishes loading, including a `lazy` asset loaded later and any subsequent reloads. Does not bubble — listen on this element, or use a capture-phase listener on an ancestor to observe every asset.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
       "attributes": [
         {
           "name": "atlas",
@@ -151,7 +168,7 @@
     },
     {
       "name": "pc-material",
-      "description": "The MaterialElement interface provides properties and methods for manipulating\n[`<pc-material>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-material/) elements.\nThe MaterialElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA `pc-material` must be a direct child of `pc-app` — elements placed elsewhere log a warning\nand never create a material. Elements inserted while the application is already running are\ncreated on insertion.\n\nThe element is metal/rough by default: unlike a bare `StandardMaterial` it enables the metalness\nworkflow, which is what the `metalness-*` attributes assume and what glTF means by PBR. The\n`roughness` and `roughness-map` attributes are aliases for `gloss` and `gloss-map` that\nadditionally invert the gloss channel; do not mix the two families on one element.\n\nThe two aliases are documented here rather than on an accessor, because they resolve to the\n`gloss` properties and would otherwise inherit gloss's description - which reads inverted.\n\n---\n\n\n### **Methods:**\n - **setMap(id: _string_, slot: _TextureSlot_)** - Points a texture slot at the resource of a `pc-asset`, waiting for the asset to load when it\nhas not already. An empty id clears the slot.",
+      "description": "The MaterialElement interface provides properties and methods for manipulating\n[`<pc-material>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-material/) elements.\nThe MaterialElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA `pc-material` must be a direct child of `pc-app` — elements placed elsewhere log a warning\nand never create a material. Elements inserted while the application is already running are\ncreated on insertion.\n\nThe element is metal/rough by default: unlike a bare `StandardMaterial` it enables the metalness\nworkflow, which is what the `metalness-*` attributes assume and what glTF means by PBR. It also\ndefaults `metalness` to 0 rather than the engine's 1, because those two defaults have to be\nchosen together - the engine's 1 is unreachable under its own `useMetalness` of false, and with\nthe workflow on it would make every material fully metallic, so `<pc-material diffuse=\"crimson\">`\nwould render as dark tinted reflections of an environment that may not exist rather than as a\ncrimson surface. `metalness=\"1\"` remains one attribute away.\n\nThe `roughness` and `roughness-map` attributes are aliases for `gloss` and `gloss-map` that\nadditionally invert the gloss channel; do not mix the two families on one element.\n\nThe two aliases are documented here rather than on an accessor, because they resolve to the\n`gloss` properties and would otherwise inherit gloss's description - which reads inverted.\n\n---\n\n\n### **Methods:**\n - **setMap(id: _string_, slot: _TextureSlot_)** - Points a texture slot at the resource of a `pc-asset`, waiting for the asset to load when it\nhas not already. An empty id clears the slot.",
       "attributes": [
         {
           "name": "alpha-test",
@@ -725,13 +742,13 @@
           "values": []
         },
         {
-          "name": "level",
-          "description": "The mip level of the skybox.",
+          "name": "lighting",
+          "description": "Whether the skybox is used as a light source.",
           "values": []
         },
         {
-          "name": "lighting",
-          "description": "Whether the skybox is used as a light source.",
+          "name": "mip-level",
+          "description": "The mip level of the skybox.",
           "values": []
         },
         {
@@ -913,16 +930,16 @@
           "description": "The orthographic height of the camera.",
           "values": []
         },
-        {
-          "name": "orthographic",
-          "description": "The orthographic projection of the camera.",
-          "values": []
-        },
         {
           "name": "priority",
           "description": "The priority of the camera.",
           "values": []
         },
+        {
+          "name": "projection",
+          "description": "The projection of the camera.",
+          "values": [{ "name": "perspective" }, { "name": "orthographic" }]
+        },
         {
           "name": "rect",
           "description": "The rect of the camera. Accepts 4 space-separated numbers.",
@@ -1523,7 +1540,6 @@
       "name": "pc-screen",
       "description": "The ScreenComponentElement interface provides properties and methods for manipulating\n[`<pc-screen>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/) elements.\nThe ScreenComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
       "attributes": [
-        { "name": "blend", "values": [] },
         {
           "name": "enabled",
           "description": "The enabled state of the component.",
@@ -1540,7 +1556,16 @@
           "description": "Accepts 2 space-separated numbers.",
           "values": []
         },
-        { "name": "scale-blend", "values": [] },
+        {
+          "name": "scale-blend",
+          "description": "How the screen's resolutions are weighted against each other.",
+          "values": []
+        },
+        {
+          "name": "scale-mode",
+          "description": "How the screen scales its contents.",
+          "values": [{ "name": "none" }, { "name": "blend" }]
+        },
         { "name": "screen-space", "values": [] }
       ],
       "references": []
@@ -1633,7 +1658,7 @@
         { "name": "friction", "description": "The friction.", "values": [] },
         {
           "name": "horizontal",
-          "description": "Whether horizontal scrolling is enabled.",
+          "description": "Whether scrolling along the horizontal axis is enabled.",
           "values": []
         },
         {
@@ -1667,7 +1692,7 @@
         },
         {
           "name": "vertical",
-          "description": "Whether vertical scrolling is enabled.",
+          "description": "Whether scrolling along the vertical axis is enabled.",
           "values": []
         },
         {