@playcanvas/web-components 0.19.0 → 0.20.0

package/dist/custom-elements.json

@@ -7048,7 +7048,7 @@
             {
               "kind": "field",
               "name": "image",
-              "description": "Gets the reference to the `<pc-entity>` whose image element is used for visual transitions.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity whose image element is used for visual transitions, or empty for\nthe button's own entity.",
               "parameters": [
                 {
                   "description": "The image entity reference.",
@@ -7261,7 +7261,7 @@
                 "text": "string"
               },
               "fieldName": "image",
-              "description": "The reference to the `<pc-entity>` whose image element is used for visual transitions."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity whose image element is used for visual transitions, or empty for the button's own entity."
             },
             {
               "name": "inactive-sprite-asset",
@@ -9594,7 +9594,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "The JointComponentElement interface provides properties and methods for manipulating\n[`<pc-joint>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-joint/) elements.\nThe JointComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe entity holding the joint is not itself constrained. Its world transform defines the joint\nframe — the anchor point and axes the constraint operates about — with the local X axis as the\nprimary axis: a hinge rotates about it, a slider translates along it and a ball joint twists\nabout it. The constrained bodies are referenced by `entity-a` and `entity-b`, both of which need\na rigid body component; leaving `entity-b` empty constrains `entity-a` to a fixed point in world\nspace. The underlying engine component is in alpha, so its API may change.\n",
+          "description": "The JointComponentElement interface provides properties and methods for manipulating\n[`<pc-joint>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-joint/) elements.\nThe JointComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe entity holding the joint is not itself constrained. Its world transform defines the joint\nframe — the anchor point and axes the constraint operates about — with the local X axis as the\nprimary axis: a hinge rotates about it, a slider translates along it and a ball joint twists\nabout it. The constrained bodies are referenced by `entity-a` and `entity-b`, both of which need\na rigid body component; leaving `entity-b` empty constrains `entity-a` to a fixed point in world\nspace. A reference can name any entity-fronting element — `<pc-entity>`, `<pc-model>` or\n`<pc-node>`, so a ragdoll can join a model's own skeleton nodes by name — and a name resolves\nagainst the nearest enclosing entity first, then outward through the entity hierarchy, then the\ndocument, while a `#` selector resolves document-wide. A `<template>` prefab with one\nentity-fronting root can therefore wire its joints by name and stay self-contained when cloned.\nThe underlying engine component is in alpha, so its API may change.\n",
           "name": "JointComponentElement",
           "members": [
             {
@@ -9866,7 +9866,7 @@
             {
               "kind": "field",
               "name": "entityA",
-              "description": "Gets the reference to the `<pc-entity>` providing the first constrained body.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the element providing the first constrained body.",
               "parameters": [
                 {
                   "description": "The first body's entity reference.",
@@ -9882,7 +9882,7 @@
             {
               "kind": "field",
               "name": "entityB",
-              "description": "Gets the reference to the `<pc-entity>` providing the second constrained body.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the element providing the second constrained body, or empty for the\nworld-space case.",
               "parameters": [
                 {
                   "description": "The second body's entity reference.",
@@ -10314,7 +10314,7 @@
                 "text": "string"
               },
               "fieldName": "entityA",
-              "description": "The reference to the `<pc-entity>` providing the first constrained body."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the element providing the first constrained body."
             },
             {
               "name": "entity-b",
@@ -10322,7 +10322,7 @@
                 "text": "string"
               },
               "fieldName": "entityB",
-              "description": "The reference to the `<pc-entity>` providing the second constrained body."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the element providing the second constrained body, or empty for the world-space case."
             },
             {
               "name": "limits",
@@ -13048,7 +13048,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "The ScriptInstanceElement interface provides properties and methods for manipulating\n`<pc-script-instance>` elements. The ScriptInstanceElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n\nScript attributes can be supplied through two channels:\n\n- **Per-property attributes**: any non-reserved attribute on the element maps to the script\n  attribute of the same name (kebab-case to camelCase, e.g. `focus-point` → `focusPoint`).\n  Values are parsed according to the type of the attribute's current value — initially the\n  script's declared default (numbers, booleans, strings, Vec2/3/4, Color, Quat as Euler\n  angles) — and the `asset:`/`entity:`/`vec2:`/`vec3:`/`vec4:`/`color:` prefixes may be used\n  to be explicit.\n- **The `attributes` JSON attribute**: an object supporting nested structures and attribute\n  names that collide with reserved HTML attribute names (e.g. `title`).\n\nWhen both specify the same attribute, the per-property attribute wins — at creation and\nwhenever either channel changes at runtime. The element's own `name` and `enabled`\nattributes configure the element itself and are not script attributes.\n\nChanging `name` on a live element destroys the old-name script instance and creates the\nnew-name one, re-applying both attribute channels to it.\n\nThe element becomes ready once its script instance has been created by the parent\n`<pc-script>` element.\n",
+          "description": "The ScriptInstanceElement interface provides properties and methods for manipulating\n`<pc-script-instance>` elements. The ScriptInstanceElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n\nScript attributes can be supplied through two channels:\n\n- **Per-property attributes**: any non-reserved attribute on the element maps to the script\n  attribute of the same name (kebab-case to camelCase, e.g. `focus-point` → `focusPoint`).\n  Values are parsed according to the type of the attribute's current value — initially the\n  script's declared default (numbers, booleans, strings, Vec2/3/4, Color, Quat as Euler\n  angles) — and the `asset:`/`entity:`/`vec2:`/`vec3:`/`vec4:`/`color:` prefixes may be used\n  to be explicit. An `entity:` reference is an entity name — resolved against the nearest\n  enclosing entity first, then outward, then the document — or a document-wide `#` selector\n  (`entity:#id`); a bare value is always a name, never an element id.\n- **The `attributes` JSON attribute**: an object supporting nested structures and attribute\n  names that collide with reserved HTML attribute names (e.g. `title`).\n\nWhen both specify the same attribute, the per-property attribute wins — at creation and\nwhenever either channel changes at runtime. The element's own `name` and `enabled`\nattributes configure the element itself and are not script attributes.\n\nChanging `name` on a live element destroys the old-name script instance and creates the\nnew-name one, re-applying both attribute channels to it.\n\nThe element becomes ready once its script instance has been created by the parent\n`<pc-script>` element.\n",
           "name": "ScriptInstanceElement",
           "members": [
             {
@@ -13150,7 +13150,7 @@
             {
               "kind": "field",
               "name": "scriptAttributes",
-              "description": "Gets the attributes of the script.",
+              "description": "Gets the attributes of the script as an object whose `asset:`, `entity:`, `vec2:`, `vec3:`,\n`vec4:` and `color:` prefixed values are resolved when applied — an `entity:` value being\nan entity name (nearest enclosing entity first, then outward, then the document) or a\ndocument-wide `#` selector (`entity:#id`), never a bare element id.",
               "parameters": [
                 {
                   "description": "The attributes of the script.",
@@ -13208,7 +13208,7 @@
                 "text": "string"
               },
               "fieldName": "scriptAttributes",
-              "description": "The attributes of the script."
+              "description": "The attributes of the script as an object whose `asset:`, `entity:`, `vec2:`, `vec3:`, `vec4:` and `color:` prefixed values are resolved when applied — an `entity:` value being an entity name (nearest enclosing entity first, then outward, then the document) or a document-wide `#` selector (`entity:#id`), never a bare element id."
             },
             {
               "name": "enabled",
@@ -13232,7 +13232,7 @@
             "name": "AsyncElement",
             "module": "/src/async-element"
           },
-          "summary": "The `<pc-script-instance>` element attaches one script class, named by `name`, to\nthe entity of its parent `<pc-script>`. Its other attributes set script attributes of the same\nname, and `attributes` takes a JSON object instead. Must be a direct child of `<pc-script>`.\n",
+          "summary": "The `<pc-script-instance>` element attaches one script class, named by `name`, to\nthe entity of its parent `<pc-script>`. Its other attributes set script attributes of the same\nname, and `attributes` takes a JSON object instead. An `entity:` value is an entity name —\nwrite `entity:#id` for an element id. Must be a direct child of `<pc-script>`.\n",
           "tagName": "pc-script-instance",
           "customElement": true
         }
@@ -13338,7 +13338,7 @@
             {
               "kind": "field",
               "name": "content",
-              "description": "Gets the reference to the `<pc-entity>` used as the content.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity used as the content.",
               "parameters": [
                 {
                   "description": "The content entity reference.",
@@ -13406,7 +13406,7 @@
             {
               "kind": "field",
               "name": "horizontalScrollbar",
-              "description": "Gets the reference to the `<pc-entity>` containing the horizontal scrollbar.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity containing the horizontal scrollbar.",
               "parameters": [
                 {
                   "description": "The horizontal scrollbar entity reference.",
@@ -13516,7 +13516,7 @@
             {
               "kind": "field",
               "name": "verticalScrollbar",
-              "description": "Gets the reference to the `<pc-entity>` containing the vertical scrollbar.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity containing the vertical scrollbar.",
               "parameters": [
                 {
                   "description": "The vertical scrollbar entity reference.",
@@ -13548,7 +13548,7 @@
             {
               "kind": "field",
               "name": "viewport",
-              "description": "Gets the reference to the `<pc-entity>` used as the viewport.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity used as the viewport.",
               "parameters": [
                 {
                   "description": "The viewport entity reference.",
@@ -13578,7 +13578,7 @@
                 "text": "string"
               },
               "fieldName": "content",
-              "description": "The reference to the `<pc-entity>` used as the content."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity used as the content."
             },
             {
               "name": "enabled",
@@ -13617,7 +13617,7 @@
                 "text": "string"
               },
               "fieldName": "horizontalScrollbar",
-              "description": "The reference to the `<pc-entity>` containing the horizontal scrollbar."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity containing the horizontal scrollbar."
             },
             {
               "name": "horizontal-scrollbar-visibility",
@@ -13670,7 +13670,7 @@
                 "text": "string"
               },
               "fieldName": "verticalScrollbar",
-              "description": "The reference to the `<pc-entity>` containing the vertical scrollbar."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity containing the vertical scrollbar."
             },
             {
               "name": "vertical-scrollbar-visibility",
@@ -13687,7 +13687,7 @@
                 "text": "string"
               },
               "fieldName": "viewport",
-              "description": "The reference to the `<pc-entity>` used as the viewport."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity used as the viewport."
             }
           ],
           "superclass": {
@@ -13817,7 +13817,7 @@
             {
               "kind": "field",
               "name": "handle",
-              "description": "Gets the reference to the `<pc-entity>` used as the scrollbar handle.",
+              "description": "Gets the reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#`\nselector) to the entity used as the scrollbar handle.",
               "parameters": [
                 {
                   "description": "The handle entity reference.",
@@ -13913,7 +13913,7 @@
                 "text": "string"
               },
               "fieldName": "handle",
-              "description": "The reference to the `<pc-entity>` used as the scrollbar handle."
+              "description": "The reference (a `pc-entity`, `pc-model` or `pc-node` name, or a document-wide `#` selector) to the entity used as the scrollbar handle."
             },
             {
               "name": "handle-size",

package/dist/parse.d.cts

@@ -12,7 +12,12 @@
  * - `parseBool` and `parseTags` take no attribute name, because every value is valid for them and
  *   so they never warn.
  *
- * `getEntity` is the exception: it resolves a reference to a live entity rather than parsing a
- * literal, and returns `null` instead of falling back to a default.
+ * `findEntityElement` and `getEntity` are the exceptions: they resolve a reference rather than
+ * parsing a literal, and return `null` instead of falling back to a default. A reference
+ * beginning with `#` is a document-wide selector (an element id, or any selector rooted in one);
+ * anything else is an entity name, resolved lexically through the entity hierarchy first and
+ * against the document after — never as a selector or an id. They also do not warn - what an
+ * unresolved reference means depends on the element holding it - so elements report through
+ * `resolveEntity`, which takes that meaning as parameters.
  */
 export {};

package/dist/parse.d.ts

@@ -12,7 +12,12 @@
  * - `parseBool` and `parseTags` take no attribute name, because every value is valid for them and
  *   so they never warn.
  *
- * `getEntity` is the exception: it resolves a reference to a live entity rather than parsing a
- * literal, and returns `null` instead of falling back to a default.
+ * `findEntityElement` and `getEntity` are the exceptions: they resolve a reference rather than
+ * parsing a literal, and return `null` instead of falling back to a default. A reference
+ * beginning with `#` is a document-wide selector (an element id, or any selector rooted in one);
+ * anything else is an entity name, resolved lexically through the entity hierarchy first and
+ * against the document after — never as a selector or an id. They also do not warn - what an
+ * unresolved reference means depends on the element holding it - so elements report through
+ * `resolveEntity`, which takes that meaning as parameters.
  */
 export {};