@playcanvas/web-components 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app.d.cts +14 -13
- package/dist/app.d.ts +14 -13
- package/dist/async-element.d.cts +13 -13
- package/dist/async-element.d.ts +13 -13
- package/dist/components/anim-component.d.cts +33 -5
- package/dist/components/anim-component.d.ts +33 -5
- package/dist/components/{listener-component.d.cts → audio-listener-component.d.cts} +7 -5
- package/dist/components/{listener-component.d.ts → audio-listener-component.d.ts} +7 -5
- package/dist/components/button-component.d.cts +5 -1
- package/dist/components/button-component.d.ts +5 -1
- package/dist/components/camera-component.d.cts +2 -0
- package/dist/components/camera-component.d.ts +2 -0
- package/dist/components/collision-component.d.cts +5 -1
- package/dist/components/collision-component.d.ts +5 -1
- package/dist/components/component.d.cts +3 -2
- package/dist/components/component.d.ts +3 -2
- package/dist/components/element-component.d.cts +7 -0
- package/dist/components/element-component.d.ts +7 -0
- package/dist/components/gsplat-component.d.cts +2 -0
- package/dist/components/gsplat-component.d.ts +2 -0
- package/dist/components/joint-component.d.cts +2 -0
- package/dist/components/joint-component.d.ts +2 -0
- package/dist/components/{layoutchild-component.d.cts → layout-child-component.d.cts} +3 -1
- package/dist/components/{layoutchild-component.d.ts → layout-child-component.d.ts} +3 -1
- package/dist/components/{layoutgroup-component.d.cts → layout-group-component.d.cts} +3 -1
- package/dist/components/{layoutgroup-component.d.ts → layout-group-component.d.ts} +3 -1
- package/dist/components/light-component.d.cts +2 -0
- package/dist/components/light-component.d.ts +2 -0
- package/dist/components/{particlesystem-component.d.cts → particle-system-component.d.cts} +3 -1
- package/dist/components/{particlesystem-component.d.ts → particle-system-component.d.ts} +3 -1
- package/dist/components/render-component.d.cts +2 -0
- package/dist/components/render-component.d.ts +2 -0
- package/dist/components/{rigidbody-component.d.cts → rigid-body-component.d.cts} +3 -1
- package/dist/components/{rigidbody-component.d.ts → rigid-body-component.d.ts} +3 -1
- package/dist/components/screen-component.d.cts +2 -0
- package/dist/components/screen-component.d.ts +2 -0
- package/dist/components/script-component.d.cts +23 -12
- package/dist/components/script-component.d.ts +23 -12
- package/dist/components/{script.d.cts → script-instance.d.cts} +7 -7
- package/dist/components/{script.d.ts → script-instance.d.ts} +7 -7
- package/dist/components/{scrollview-component.d.cts → scroll-view-component.d.cts} +3 -1
- package/dist/components/{scrollview-component.d.ts → scroll-view-component.d.ts} +3 -1
- package/dist/components/scrollbar-component.d.cts +2 -0
- package/dist/components/scrollbar-component.d.ts +2 -0
- package/dist/components/sound-component.d.cts +3 -1
- package/dist/components/sound-component.d.ts +3 -1
- package/dist/components/sound-slot.d.cts +2 -2
- package/dist/components/sound-slot.d.ts +2 -2
- package/dist/custom-elements.json +1603 -986
- package/dist/entity-base.d.cts +6 -5
- package/dist/entity-base.d.ts +6 -5
- package/dist/entity-owner.d.cts +118 -0
- package/dist/entity-owner.d.ts +118 -0
- package/dist/entity.d.cts +8 -101
- package/dist/entity.d.ts +8 -101
- package/dist/index.d.cts +22 -21
- package/dist/index.d.ts +22 -21
- package/dist/model.d.cts +67 -24
- package/dist/model.d.ts +67 -24
- package/dist/pwc.cjs +526 -268
- package/dist/pwc.cjs.map +1 -1
- package/dist/pwc.js +526 -268
- package/dist/pwc.js.map +1 -1
- package/dist/pwc.min.js +1 -1
- package/dist/pwc.min.js.map +1 -1
- package/dist/pwc.min.mjs +1 -1
- package/dist/pwc.min.mjs.map +1 -1
- package/dist/pwc.mjs +523 -266
- package/dist/pwc.mjs.map +1 -1
- package/dist/vscode.html-custom-data.json +145 -90
- package/dist/{module.d.cts → wasm.d.cts} +6 -6
- package/dist/{module.d.ts → wasm.d.ts} +6 -6
- package/dist/web-types.json +378 -250
- package/package.json +7 -7
- package/src/app.ts +45 -35
- package/src/async-element.ts +14 -14
- package/src/components/anim-component.ts +84 -14
- package/src/components/{listener-component.ts → audio-listener-component.ts} +8 -6
- package/src/components/button-component.ts +5 -1
- package/src/components/camera-component.ts +2 -0
- package/src/components/collision-component.ts +5 -1
- package/src/components/component.ts +4 -3
- package/src/components/element-component.ts +7 -0
- package/src/components/gsplat-component.ts +2 -0
- package/src/components/joint-component.ts +2 -0
- package/src/components/{layoutchild-component.ts → layout-child-component.ts} +4 -2
- package/src/components/{layoutgroup-component.ts → layout-group-component.ts} +4 -2
- package/src/components/light-component.ts +2 -0
- package/src/components/{particlesystem-component.ts → particle-system-component.ts} +4 -2
- package/src/components/render-component.ts +2 -0
- package/src/components/{rigidbody-component.ts → rigid-body-component.ts} +4 -2
- package/src/components/screen-component.ts +2 -0
- package/src/components/script-component.ts +63 -42
- package/src/components/{script.ts → script-instance.ts} +14 -14
- package/src/components/{scrollview-component.ts → scroll-view-component.ts} +4 -2
- package/src/components/scrollbar-component.ts +2 -0
- package/src/components/sound-component.ts +4 -2
- package/src/components/sound-slot.ts +4 -4
- package/src/entity-base.ts +6 -5
- package/src/entity-owner.ts +298 -0
- package/src/entity.ts +15 -270
- package/src/index.ts +26 -24
- package/src/model.ts +159 -72
- package/src/node.ts +9 -5
- package/src/{module.ts → wasm.ts} +8 -8
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
"type": {
|
|
98
98
|
"text": "EntityBaseElement | null"
|
|
99
99
|
},
|
|
100
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
100
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
101
101
|
"return": {
|
|
102
102
|
"type": {
|
|
103
103
|
"text": ""
|
|
@@ -142,7 +142,7 @@
|
|
|
142
142
|
"description": "The entity to look up."
|
|
143
143
|
}
|
|
144
144
|
],
|
|
145
|
-
"description": "Returns the `<pc-entity>` or `<pc-node>` element whose backing entity is
|
|
145
|
+
"description": "Returns the `<pc-entity>`, `<pc-model>` or `<pc-node>` element whose backing entity is\n`entity`, or `null` if the entity is not fronted by an element of this application - for\nexample, an unbound node inside a model's instantiated hierarchy, or an entity created\nthrough the engine API."
|
|
146
146
|
},
|
|
147
147
|
{
|
|
148
148
|
"kind": "field",
|
|
@@ -439,7 +439,7 @@
|
|
|
439
439
|
"type": {
|
|
440
440
|
"text": "EntityBaseElement | null"
|
|
441
441
|
},
|
|
442
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
442
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
443
443
|
"return": {
|
|
444
444
|
"type": {
|
|
445
445
|
"text": ""
|
|
@@ -819,7 +819,7 @@
|
|
|
819
819
|
"type": {
|
|
820
820
|
"text": "EntityBaseElement | null"
|
|
821
821
|
},
|
|
822
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
822
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
823
823
|
"return": {
|
|
824
824
|
"type": {
|
|
825
825
|
"text": ""
|
|
@@ -869,7 +869,7 @@
|
|
|
869
869
|
"description": "The tag name of the element to wait for (e.g. `'pc-app'`)."
|
|
870
870
|
}
|
|
871
871
|
],
|
|
872
|
-
"description": "Waits for the first element matching the given tag name to be fully initialized. Note that the\npromise never settles if the element cannot finish initializing (for example, a `<pc-script>`\nthat is not a direct child of `<pc-
|
|
872
|
+
"description": "Waits for the first element matching the given tag name to be fully initialized. Note that the\npromise never settles if the element cannot finish initializing (for example, a `<pc-script-instance>`\nthat is not a direct child of `<pc-script>`, or a `<pc-app>` that could not create a graphics\ndevice — listen for its `error` event instead). A component element outside an entity-fronting\nelement is the exception: it still becomes ready, but its `component` is `null`. Either way, a\nmisplaced element logs a warning naming the parent it requires."
|
|
873
873
|
},
|
|
874
874
|
{
|
|
875
875
|
"kind": "function",
|
|
@@ -907,7 +907,7 @@
|
|
|
907
907
|
"description": "A CSS selector matching the element to wait for (e.g. `'#my-app'`)."
|
|
908
908
|
}
|
|
909
909
|
],
|
|
910
|
-
"description": "Waits for the first element matching the given CSS selector to be fully initialized. Note that\nthe promise never settles if the element cannot finish initializing (for example, a `<pc-script>`\nthat is not a direct child of `<pc-
|
|
910
|
+
"description": "Waits for the first element matching the given CSS selector to be fully initialized. Note that\nthe promise never settles if the element cannot finish initializing (for example, a `<pc-script-instance>`\nthat is not a direct child of `<pc-script>`, or a `<pc-app>` that could not create a graphics\ndevice — listen for its `error` event instead). A component element outside an entity-fronting\nelement is the exception: it still becomes ready, but its `component` is `null`. Either way, a\nmisplaced element logs a warning naming the parent it requires."
|
|
911
911
|
},
|
|
912
912
|
{
|
|
913
913
|
"kind": "function",
|
|
@@ -960,7 +960,7 @@
|
|
|
960
960
|
"declarations": [
|
|
961
961
|
{
|
|
962
962
|
"kind": "class",
|
|
963
|
-
"description": "The base class for elements that front an engine Entity: `<pc-entity>`, which
|
|
963
|
+
"description": "The base class for elements that front an engine Entity: `<pc-entity>` and\n`<pc-model>`, which create one, and `<pc-node>`, which binds to one inside a model's\ninstantiated hierarchy. It carries what all of them need — the `entity` contract, registration\nwith the owning application (which joins picked scene nodes back to elements by identity,\nnever by name), and the pointer listener bookkeeping that lets the application lazily attach\nits canvas handlers.",
|
|
964
964
|
"name": "EntityBaseElement",
|
|
965
965
|
"members": [
|
|
966
966
|
{
|
|
@@ -1012,7 +1012,7 @@
|
|
|
1012
1012
|
"type": {
|
|
1013
1013
|
"text": "EntityBaseElement | null"
|
|
1014
1014
|
},
|
|
1015
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
1015
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
1016
1016
|
"return": {
|
|
1017
1017
|
"type": {
|
|
1018
1018
|
"text": ""
|
|
@@ -1110,12 +1110,12 @@
|
|
|
1110
1110
|
},
|
|
1111
1111
|
{
|
|
1112
1112
|
"kind": "javascript-module",
|
|
1113
|
-
"path": "src/entity.ts",
|
|
1113
|
+
"path": "src/entity-owner.ts",
|
|
1114
1114
|
"declarations": [
|
|
1115
1115
|
{
|
|
1116
1116
|
"kind": "class",
|
|
1117
|
-
"description": "The
|
|
1118
|
-
"name": "
|
|
1117
|
+
"description": "The base class for elements that create and own their backing entity: `<pc-entity>` and\n`<pc-model>`, whose host entity carries the same authored properties. It carries the cached\nproperty state, entity creation and parenting, and the reset that follows the entity's\ndestruction. `<pc-node>` sits outside this class: it borrows an entity a model instantiated,\nand its properties are nullable overrides rather than owned values.",
|
|
1118
|
+
"name": "EntityOwnerElement",
|
|
1119
1119
|
"members": [
|
|
1120
1120
|
{
|
|
1121
1121
|
"kind": "method",
|
|
@@ -1170,7 +1170,7 @@
|
|
|
1170
1170
|
"type": {
|
|
1171
1171
|
"text": "EntityBaseElement | null"
|
|
1172
1172
|
},
|
|
1173
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
1173
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
1174
1174
|
"return": {
|
|
1175
1175
|
"type": {
|
|
1176
1176
|
"text": ""
|
|
@@ -1340,6 +1340,44 @@
|
|
|
1340
1340
|
}
|
|
1341
1341
|
}
|
|
1342
1342
|
],
|
|
1343
|
+
"superclass": {
|
|
1344
|
+
"name": "EntityBaseElement",
|
|
1345
|
+
"module": "/src/entity-base"
|
|
1346
|
+
},
|
|
1347
|
+
"events": [
|
|
1348
|
+
{
|
|
1349
|
+
"name": "ready",
|
|
1350
|
+
"type": {
|
|
1351
|
+
"text": "CustomEvent"
|
|
1352
|
+
},
|
|
1353
|
+
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
1354
|
+
"inheritedFrom": {
|
|
1355
|
+
"name": "AsyncElement",
|
|
1356
|
+
"module": "src/async-element.ts"
|
|
1357
|
+
}
|
|
1358
|
+
}
|
|
1359
|
+
]
|
|
1360
|
+
}
|
|
1361
|
+
],
|
|
1362
|
+
"exports": [
|
|
1363
|
+
{
|
|
1364
|
+
"kind": "js",
|
|
1365
|
+
"name": "EntityOwnerElement",
|
|
1366
|
+
"declaration": {
|
|
1367
|
+
"name": "EntityOwnerElement",
|
|
1368
|
+
"module": "src/entity-owner.ts"
|
|
1369
|
+
}
|
|
1370
|
+
}
|
|
1371
|
+
]
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"kind": "javascript-module",
|
|
1375
|
+
"path": "src/entity.ts",
|
|
1376
|
+
"declarations": [
|
|
1377
|
+
{
|
|
1378
|
+
"kind": "class",
|
|
1379
|
+
"description": "The EntityElement interface provides properties and methods for manipulating\n[`<pc-entity>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-entity/) elements.\nThe EntityElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe pointer events below are dispatched by the containing `<pc-app>` element when the pointer\nintersects this entity's geometry. They are only generated while the entity has a listener for\nthem, registered either with addEventListener or with the matching inline `onpointer*`\nattribute.\n",
|
|
1380
|
+
"name": "EntityElement",
|
|
1343
1381
|
"events": [
|
|
1344
1382
|
{
|
|
1345
1383
|
"type": {
|
|
@@ -1394,17 +1432,17 @@
|
|
|
1394
1432
|
"type": {
|
|
1395
1433
|
"text": "boolean"
|
|
1396
1434
|
},
|
|
1435
|
+
"description": "The enabled state of the entity.",
|
|
1397
1436
|
"fieldName": "enabled",
|
|
1398
|
-
"default": "true"
|
|
1399
|
-
"description": "The enabled state of the entity."
|
|
1437
|
+
"default": "true"
|
|
1400
1438
|
},
|
|
1401
1439
|
{
|
|
1402
1440
|
"name": "name",
|
|
1403
1441
|
"type": {
|
|
1404
1442
|
"text": "string"
|
|
1405
1443
|
},
|
|
1406
|
-
"
|
|
1407
|
-
"
|
|
1444
|
+
"description": "The name of the entity.",
|
|
1445
|
+
"fieldName": "name"
|
|
1408
1446
|
},
|
|
1409
1447
|
{
|
|
1410
1448
|
"type": {
|
|
@@ -1451,255 +1489,503 @@
|
|
|
1451
1489
|
"type": {
|
|
1452
1490
|
"text": "string"
|
|
1453
1491
|
},
|
|
1492
|
+
"description": "The position of the entity. Accepts 3 space-separated numbers.",
|
|
1454
1493
|
"fieldName": "position",
|
|
1455
|
-
"default": "0 0 0"
|
|
1456
|
-
"description": "The position of the entity. Accepts 3 space-separated numbers."
|
|
1494
|
+
"default": "0 0 0"
|
|
1457
1495
|
},
|
|
1458
1496
|
{
|
|
1459
1497
|
"name": "rotation",
|
|
1460
1498
|
"type": {
|
|
1461
1499
|
"text": "string"
|
|
1462
1500
|
},
|
|
1501
|
+
"description": "The rotation of the entity. Accepts 3 space-separated numbers.",
|
|
1463
1502
|
"fieldName": "rotation",
|
|
1464
|
-
"default": "0 0 0"
|
|
1465
|
-
"description": "The rotation of the entity. Accepts 3 space-separated numbers."
|
|
1503
|
+
"default": "0 0 0"
|
|
1466
1504
|
},
|
|
1467
1505
|
{
|
|
1468
1506
|
"name": "scale",
|
|
1469
1507
|
"type": {
|
|
1470
1508
|
"text": "string"
|
|
1471
1509
|
},
|
|
1510
|
+
"description": "The scale of the entity. Accepts 3 space-separated numbers.",
|
|
1472
1511
|
"fieldName": "scale",
|
|
1473
|
-
"default": "1 1 1"
|
|
1474
|
-
"description": "The scale of the entity. Accepts 3 space-separated numbers."
|
|
1512
|
+
"default": "1 1 1"
|
|
1475
1513
|
},
|
|
1476
1514
|
{
|
|
1477
1515
|
"name": "tags",
|
|
1478
1516
|
"type": {
|
|
1479
1517
|
"text": "string"
|
|
1480
1518
|
},
|
|
1481
|
-
"
|
|
1482
|
-
"
|
|
1519
|
+
"description": "The tags of the entity.",
|
|
1520
|
+
"fieldName": "tags"
|
|
1483
1521
|
}
|
|
1484
1522
|
],
|
|
1485
1523
|
"superclass": {
|
|
1486
|
-
"name": "
|
|
1487
|
-
"module": "/src/entity-
|
|
1524
|
+
"name": "EntityOwnerElement",
|
|
1525
|
+
"module": "/src/entity-owner"
|
|
1488
1526
|
},
|
|
1489
1527
|
"tagName": "pc-entity",
|
|
1490
|
-
"customElement": true
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1528
|
+
"customElement": true,
|
|
1529
|
+
"members": [
|
|
1530
|
+
{
|
|
1531
|
+
"kind": "method",
|
|
1532
|
+
"name": "addEventListener",
|
|
1533
|
+
"parameters": [
|
|
1534
|
+
{
|
|
1535
|
+
"name": "type",
|
|
1536
|
+
"type": {
|
|
1537
|
+
"text": "string"
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
{
|
|
1541
|
+
"name": "listener",
|
|
1542
|
+
"type": {
|
|
1543
|
+
"text": "EventListener"
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"name": "options",
|
|
1548
|
+
"optional": true,
|
|
1549
|
+
"type": {
|
|
1550
|
+
"text": "boolean | AddEventListenerOptions"
|
|
1551
|
+
}
|
|
1552
|
+
}
|
|
1553
|
+
],
|
|
1554
|
+
"inheritedFrom": {
|
|
1555
|
+
"name": "EntityBaseElement",
|
|
1556
|
+
"module": "src/entity-base.ts"
|
|
1557
|
+
}
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"kind": "field",
|
|
1561
|
+
"name": "closestApp",
|
|
1562
|
+
"type": {
|
|
1563
|
+
"text": "AppElement | null"
|
|
1564
|
+
},
|
|
1565
|
+
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1566
|
+
"return": {
|
|
1567
|
+
"type": {
|
|
1568
|
+
"text": ""
|
|
1569
|
+
}
|
|
1570
|
+
},
|
|
1571
|
+
"readonly": true,
|
|
1572
|
+
"inheritedFrom": {
|
|
1573
|
+
"name": "AsyncElement",
|
|
1574
|
+
"module": "src/async-element.ts"
|
|
1575
|
+
}
|
|
1576
|
+
},
|
|
1577
|
+
{
|
|
1578
|
+
"kind": "field",
|
|
1579
|
+
"name": "closestEntity",
|
|
1580
|
+
"type": {
|
|
1581
|
+
"text": "EntityBaseElement | null"
|
|
1582
|
+
},
|
|
1583
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
1584
|
+
"return": {
|
|
1585
|
+
"type": {
|
|
1586
|
+
"text": ""
|
|
1587
|
+
}
|
|
1588
|
+
},
|
|
1589
|
+
"readonly": true,
|
|
1590
|
+
"inheritedFrom": {
|
|
1591
|
+
"name": "AsyncElement",
|
|
1592
|
+
"module": "src/async-element.ts"
|
|
1593
|
+
}
|
|
1594
|
+
},
|
|
1595
|
+
{
|
|
1596
|
+
"kind": "field",
|
|
1597
|
+
"name": "enabled",
|
|
1598
|
+
"description": "Gets the enabled state of the entity.",
|
|
1599
|
+
"parameters": [
|
|
1600
|
+
{
|
|
1601
|
+
"description": "Whether the entity is enabled.",
|
|
1602
|
+
"name": "value"
|
|
1603
|
+
}
|
|
1604
|
+
],
|
|
1605
|
+
"return": {
|
|
1606
|
+
"type": {
|
|
1607
|
+
"text": ""
|
|
1608
|
+
}
|
|
1609
|
+
},
|
|
1610
|
+
"inheritedFrom": {
|
|
1611
|
+
"name": "EntityOwnerElement",
|
|
1612
|
+
"module": "src/entity-owner.ts"
|
|
1613
|
+
}
|
|
1614
|
+
},
|
|
1615
|
+
{
|
|
1616
|
+
"kind": "field",
|
|
1617
|
+
"name": "entity",
|
|
1618
|
+
"type": {
|
|
1619
|
+
"text": "Entity | null"
|
|
1620
|
+
},
|
|
1621
|
+
"description": "The PlayCanvas entity instance. `null` until the element is ready, and again once the\nentity is gone — await whenReady or the element's `ready()` promise before\naccessing it.",
|
|
1622
|
+
"return": {
|
|
1623
|
+
"type": {
|
|
1624
|
+
"text": ""
|
|
1625
|
+
}
|
|
1626
|
+
},
|
|
1627
|
+
"readonly": true,
|
|
1628
|
+
"inheritedFrom": {
|
|
1629
|
+
"name": "EntityBaseElement",
|
|
1630
|
+
"module": "src/entity-base.ts"
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"kind": "field",
|
|
1635
|
+
"name": "name",
|
|
1636
|
+
"description": "Gets the name of the entity.",
|
|
1637
|
+
"parameters": [
|
|
1638
|
+
{
|
|
1639
|
+
"description": "The name of the entity.",
|
|
1640
|
+
"name": "value"
|
|
1641
|
+
}
|
|
1642
|
+
],
|
|
1643
|
+
"return": {
|
|
1644
|
+
"type": {
|
|
1645
|
+
"text": ""
|
|
1646
|
+
}
|
|
1647
|
+
},
|
|
1648
|
+
"inheritedFrom": {
|
|
1649
|
+
"name": "EntityOwnerElement",
|
|
1650
|
+
"module": "src/entity-owner.ts"
|
|
1651
|
+
}
|
|
1652
|
+
},
|
|
1653
|
+
{
|
|
1654
|
+
"kind": "field",
|
|
1655
|
+
"name": "position",
|
|
1656
|
+
"description": "Gets the position of the entity.",
|
|
1657
|
+
"parameters": [
|
|
1658
|
+
{
|
|
1659
|
+
"description": "The position of the entity.",
|
|
1660
|
+
"name": "value"
|
|
1661
|
+
}
|
|
1662
|
+
],
|
|
1663
|
+
"return": {
|
|
1664
|
+
"type": {
|
|
1665
|
+
"text": ""
|
|
1666
|
+
}
|
|
1667
|
+
},
|
|
1668
|
+
"inheritedFrom": {
|
|
1669
|
+
"name": "EntityOwnerElement",
|
|
1670
|
+
"module": "src/entity-owner.ts"
|
|
1671
|
+
}
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"kind": "method",
|
|
1675
|
+
"name": "ready",
|
|
1676
|
+
"return": {
|
|
1677
|
+
"type": {
|
|
1678
|
+
"text": ""
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
1682
|
+
"inheritedFrom": {
|
|
1683
|
+
"name": "AsyncElement",
|
|
1684
|
+
"module": "src/async-element.ts"
|
|
1685
|
+
}
|
|
1686
|
+
},
|
|
1687
|
+
{
|
|
1688
|
+
"kind": "method",
|
|
1689
|
+
"name": "removeEventListener",
|
|
1690
|
+
"parameters": [
|
|
1691
|
+
{
|
|
1692
|
+
"name": "type",
|
|
1693
|
+
"type": {
|
|
1694
|
+
"text": "string"
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"name": "listener",
|
|
1699
|
+
"type": {
|
|
1700
|
+
"text": "EventListener"
|
|
1701
|
+
}
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "options",
|
|
1705
|
+
"optional": true,
|
|
1706
|
+
"type": {
|
|
1707
|
+
"text": "boolean | EventListenerOptions"
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
],
|
|
1711
|
+
"inheritedFrom": {
|
|
1712
|
+
"name": "EntityBaseElement",
|
|
1713
|
+
"module": "src/entity-base.ts"
|
|
1714
|
+
}
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"kind": "field",
|
|
1718
|
+
"name": "rotation",
|
|
1719
|
+
"description": "Gets the rotation of the entity.",
|
|
1720
|
+
"parameters": [
|
|
1721
|
+
{
|
|
1722
|
+
"description": "The rotation of the entity.",
|
|
1723
|
+
"name": "value"
|
|
1724
|
+
}
|
|
1725
|
+
],
|
|
1726
|
+
"return": {
|
|
1727
|
+
"type": {
|
|
1728
|
+
"text": ""
|
|
1729
|
+
}
|
|
1730
|
+
},
|
|
1731
|
+
"inheritedFrom": {
|
|
1732
|
+
"name": "EntityOwnerElement",
|
|
1733
|
+
"module": "src/entity-owner.ts"
|
|
1734
|
+
}
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"kind": "field",
|
|
1738
|
+
"name": "scale",
|
|
1739
|
+
"description": "Gets the scale of the entity.",
|
|
1740
|
+
"parameters": [
|
|
1741
|
+
{
|
|
1742
|
+
"description": "The scale of the entity.",
|
|
1743
|
+
"name": "value"
|
|
1744
|
+
}
|
|
1745
|
+
],
|
|
1746
|
+
"return": {
|
|
1747
|
+
"type": {
|
|
1748
|
+
"text": ""
|
|
1749
|
+
}
|
|
1750
|
+
},
|
|
1751
|
+
"inheritedFrom": {
|
|
1752
|
+
"name": "EntityOwnerElement",
|
|
1753
|
+
"module": "src/entity-owner.ts"
|
|
1754
|
+
}
|
|
1755
|
+
},
|
|
1756
|
+
{
|
|
1757
|
+
"kind": "field",
|
|
1758
|
+
"name": "tags",
|
|
1759
|
+
"description": "Gets the tags of the entity.",
|
|
1760
|
+
"parameters": [
|
|
1761
|
+
{
|
|
1762
|
+
"description": "The tags of the entity.",
|
|
1763
|
+
"name": "value"
|
|
1764
|
+
}
|
|
1765
|
+
],
|
|
1766
|
+
"return": {
|
|
1767
|
+
"type": {
|
|
1768
|
+
"text": ""
|
|
1769
|
+
}
|
|
1770
|
+
},
|
|
1771
|
+
"inheritedFrom": {
|
|
1772
|
+
"name": "EntityOwnerElement",
|
|
1773
|
+
"module": "src/entity-owner.ts"
|
|
1774
|
+
}
|
|
1775
|
+
}
|
|
1776
|
+
]
|
|
1777
|
+
}
|
|
1778
|
+
],
|
|
1779
|
+
"exports": [
|
|
1780
|
+
{
|
|
1781
|
+
"kind": "custom-element-definition",
|
|
1782
|
+
"name": "pc-entity",
|
|
1783
|
+
"declaration": {
|
|
1784
|
+
"name": "EntityElement",
|
|
1785
|
+
"module": "src/entity.ts"
|
|
1786
|
+
}
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"kind": "js",
|
|
1790
|
+
"name": "EntityElement",
|
|
1791
|
+
"declaration": {
|
|
1792
|
+
"name": "EntityElement",
|
|
1793
|
+
"module": "src/entity.ts"
|
|
1794
|
+
}
|
|
1795
|
+
}
|
|
1796
|
+
]
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"kind": "javascript-module",
|
|
1800
|
+
"path": "src/index.ts",
|
|
1801
|
+
"declarations": [],
|
|
1802
|
+
"exports": [
|
|
1803
|
+
{
|
|
1804
|
+
"kind": "js",
|
|
1805
|
+
"name": "AsyncElement",
|
|
1806
|
+
"declaration": {
|
|
1807
|
+
"name": "AsyncElement",
|
|
1808
|
+
"module": "src/index.ts"
|
|
1809
|
+
}
|
|
1810
|
+
},
|
|
1811
|
+
{
|
|
1812
|
+
"kind": "js",
|
|
1813
|
+
"name": "WasmElement",
|
|
1814
|
+
"declaration": {
|
|
1815
|
+
"name": "WasmElement",
|
|
1816
|
+
"module": "src/index.ts"
|
|
1817
|
+
}
|
|
1818
|
+
},
|
|
1819
|
+
{
|
|
1820
|
+
"kind": "js",
|
|
1821
|
+
"name": "AppElement",
|
|
1822
|
+
"declaration": {
|
|
1823
|
+
"name": "AppElement",
|
|
1824
|
+
"module": "src/index.ts"
|
|
1825
|
+
}
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"kind": "js",
|
|
1829
|
+
"name": "EntityElement",
|
|
1830
|
+
"declaration": {
|
|
1831
|
+
"name": "EntityElement",
|
|
1832
|
+
"module": "src/index.ts"
|
|
1833
|
+
}
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"kind": "js",
|
|
1837
|
+
"name": "AssetElement",
|
|
1838
|
+
"declaration": {
|
|
1839
|
+
"name": "AssetElement",
|
|
1840
|
+
"module": "src/index.ts"
|
|
1841
|
+
}
|
|
1842
|
+
},
|
|
1843
|
+
{
|
|
1844
|
+
"kind": "js",
|
|
1845
|
+
"name": "AnimComponentElement",
|
|
1846
|
+
"declaration": {
|
|
1847
|
+
"name": "AnimComponentElement",
|
|
1848
|
+
"module": "src/index.ts"
|
|
1849
|
+
}
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"kind": "js",
|
|
1853
|
+
"name": "AnimClipElement",
|
|
1854
|
+
"declaration": {
|
|
1855
|
+
"name": "AnimClipElement",
|
|
1856
|
+
"module": "src/index.ts"
|
|
1857
|
+
}
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"kind": "js",
|
|
1861
|
+
"name": "ButtonComponentElement",
|
|
1862
|
+
"declaration": {
|
|
1863
|
+
"name": "ButtonComponentElement",
|
|
1864
|
+
"module": "src/index.ts"
|
|
1865
|
+
}
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"kind": "js",
|
|
1869
|
+
"name": "CameraComponentElement",
|
|
1870
|
+
"declaration": {
|
|
1871
|
+
"name": "CameraComponentElement",
|
|
1872
|
+
"module": "src/index.ts"
|
|
1873
|
+
}
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"kind": "js",
|
|
1877
|
+
"name": "CollisionComponentElement",
|
|
1878
|
+
"declaration": {
|
|
1879
|
+
"name": "CollisionComponentElement",
|
|
1880
|
+
"module": "src/index.ts"
|
|
1881
|
+
}
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"kind": "js",
|
|
1885
|
+
"name": "ComponentElement",
|
|
1886
|
+
"declaration": {
|
|
1887
|
+
"name": "ComponentElement",
|
|
1888
|
+
"module": "src/index.ts"
|
|
1889
|
+
}
|
|
1890
|
+
},
|
|
1891
|
+
{
|
|
1892
|
+
"kind": "js",
|
|
1893
|
+
"name": "ElementComponentElement",
|
|
1894
|
+
"declaration": {
|
|
1895
|
+
"name": "ElementComponentElement",
|
|
1896
|
+
"module": "src/index.ts"
|
|
1897
|
+
}
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
"kind": "js",
|
|
1901
|
+
"name": "JointComponentElement",
|
|
1902
|
+
"declaration": {
|
|
1903
|
+
"name": "JointComponentElement",
|
|
1904
|
+
"module": "src/index.ts"
|
|
1905
|
+
}
|
|
1906
|
+
},
|
|
1907
|
+
{
|
|
1908
|
+
"kind": "js",
|
|
1909
|
+
"name": "LayoutChildComponentElement",
|
|
1910
|
+
"declaration": {
|
|
1911
|
+
"name": "LayoutChildComponentElement",
|
|
1912
|
+
"module": "src/index.ts"
|
|
1913
|
+
}
|
|
1914
|
+
},
|
|
1915
|
+
{
|
|
1916
|
+
"kind": "js",
|
|
1917
|
+
"name": "LayoutGroupComponentElement",
|
|
1918
|
+
"declaration": {
|
|
1919
|
+
"name": "LayoutGroupComponentElement",
|
|
1920
|
+
"module": "src/index.ts"
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
"kind": "js",
|
|
1925
|
+
"name": "ParticleSystemComponentElement",
|
|
1926
|
+
"declaration": {
|
|
1927
|
+
"name": "ParticleSystemComponentElement",
|
|
1928
|
+
"module": "src/index.ts"
|
|
1929
|
+
}
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"kind": "js",
|
|
1933
|
+
"name": "LightComponentElement",
|
|
1934
|
+
"declaration": {
|
|
1935
|
+
"name": "LightComponentElement",
|
|
1936
|
+
"module": "src/index.ts"
|
|
1937
|
+
}
|
|
1938
|
+
},
|
|
1939
|
+
{
|
|
1940
|
+
"kind": "js",
|
|
1941
|
+
"name": "AudioListenerComponentElement",
|
|
1942
|
+
"declaration": {
|
|
1943
|
+
"name": "AudioListenerComponentElement",
|
|
1944
|
+
"module": "src/index.ts"
|
|
1945
|
+
}
|
|
1946
|
+
},
|
|
1947
|
+
{
|
|
1948
|
+
"kind": "js",
|
|
1949
|
+
"name": "RenderComponentElement",
|
|
1950
|
+
"declaration": {
|
|
1951
|
+
"name": "RenderComponentElement",
|
|
1952
|
+
"module": "src/index.ts"
|
|
1953
|
+
}
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"kind": "js",
|
|
1957
|
+
"name": "RigidBodyComponentElement",
|
|
1958
|
+
"declaration": {
|
|
1959
|
+
"name": "RigidBodyComponentElement",
|
|
1960
|
+
"module": "src/index.ts"
|
|
1961
|
+
}
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"kind": "js",
|
|
1965
|
+
"name": "ScreenComponentElement",
|
|
1966
|
+
"declaration": {
|
|
1967
|
+
"name": "ScreenComponentElement",
|
|
1968
|
+
"module": "src/index.ts"
|
|
1969
|
+
}
|
|
1970
|
+
},
|
|
1971
|
+
{
|
|
1972
|
+
"kind": "js",
|
|
1973
|
+
"name": "ScrollbarComponentElement",
|
|
1974
|
+
"declaration": {
|
|
1975
|
+
"name": "ScrollbarComponentElement",
|
|
1976
|
+
"module": "src/index.ts"
|
|
1977
|
+
}
|
|
1978
|
+
},
|
|
1979
|
+
{
|
|
1980
|
+
"kind": "js",
|
|
1981
|
+
"name": "ScrollViewComponentElement",
|
|
1982
|
+
"declaration": {
|
|
1983
|
+
"name": "ScrollViewComponentElement",
|
|
1984
|
+
"module": "src/index.ts"
|
|
1985
|
+
}
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"kind": "js",
|
|
1703
1989
|
"name": "ScriptComponentElement",
|
|
1704
1990
|
"declaration": {
|
|
1705
1991
|
"name": "ScriptComponentElement",
|
|
@@ -1708,9 +1994,9 @@
|
|
|
1708
1994
|
},
|
|
1709
1995
|
{
|
|
1710
1996
|
"kind": "js",
|
|
1711
|
-
"name": "
|
|
1997
|
+
"name": "ScriptInstanceElement",
|
|
1712
1998
|
"declaration": {
|
|
1713
|
-
"name": "
|
|
1999
|
+
"name": "ScriptInstanceElement",
|
|
1714
2000
|
"module": "src/index.ts"
|
|
1715
2001
|
}
|
|
1716
2002
|
},
|
|
@@ -1746,6 +2032,14 @@
|
|
|
1746
2032
|
"module": "src/index.ts"
|
|
1747
2033
|
}
|
|
1748
2034
|
},
|
|
2035
|
+
{
|
|
2036
|
+
"kind": "js",
|
|
2037
|
+
"name": "EntityOwnerElement",
|
|
2038
|
+
"declaration": {
|
|
2039
|
+
"name": "EntityOwnerElement",
|
|
2040
|
+
"module": "src/index.ts"
|
|
2041
|
+
}
|
|
2042
|
+
},
|
|
1749
2043
|
{
|
|
1750
2044
|
"kind": "js",
|
|
1751
2045
|
"name": "MaterialElement",
|
|
@@ -4015,9 +4309,38 @@
|
|
|
4015
4309
|
},
|
|
4016
4310
|
{
|
|
4017
4311
|
"kind": "class",
|
|
4018
|
-
"description": "The ModelElement interface provides properties and methods for manipulating\n[`<pc-model>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-model/) elements.\nThe ModelElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element
|
|
4312
|
+
"description": "The ModelElement interface provides properties and methods for manipulating\n[`<pc-model>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-model/) elements.\nThe ModelElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element creates and fronts a stable host entity: `entity` is that host, created when the\napplication builds its hierarchy and kept across `asset` changes, so the element's transform\nand tags are instance placement that composes with whatever transform the asset authored on\nits root. The instantiated content is parented beneath the host and exposed as\ncontentEntity.\n\nThe element becomes ready once its current asset selection has settled: the container asset\nhas loaded and its content root has been parented beneath the host, the load has failed\n(`contentEntity` stays `null` — listen for `error`, or check `contentEntity`, to tell the\noutcomes apart), or no asset is assigned at all. Changing `asset` re-arms readiness and\ninstantiates anew, so a `ready()` obtained after the change resolves against the new content.\nA `pc-model` outside a `pc-app`, or referencing an unknown asset id, warns and never becomes\nready.\n\nThe pointer events below are dispatched by the containing `<pc-app>` element when the pointer\nintersects the model's geometry, exactly as for `<pc-entity>` — a hit on a content node that no\n`pc-node` fronts resolves to this element.\n",
|
|
4019
4313
|
"name": "ModelElement",
|
|
4020
4314
|
"members": [
|
|
4315
|
+
{
|
|
4316
|
+
"kind": "method",
|
|
4317
|
+
"name": "addEventListener",
|
|
4318
|
+
"parameters": [
|
|
4319
|
+
{
|
|
4320
|
+
"name": "type",
|
|
4321
|
+
"type": {
|
|
4322
|
+
"text": "string"
|
|
4323
|
+
}
|
|
4324
|
+
},
|
|
4325
|
+
{
|
|
4326
|
+
"name": "listener",
|
|
4327
|
+
"type": {
|
|
4328
|
+
"text": "EventListener"
|
|
4329
|
+
}
|
|
4330
|
+
},
|
|
4331
|
+
{
|
|
4332
|
+
"name": "options",
|
|
4333
|
+
"optional": true,
|
|
4334
|
+
"type": {
|
|
4335
|
+
"text": "boolean | AddEventListenerOptions"
|
|
4336
|
+
}
|
|
4337
|
+
}
|
|
4338
|
+
],
|
|
4339
|
+
"inheritedFrom": {
|
|
4340
|
+
"name": "EntityBaseElement",
|
|
4341
|
+
"module": "src/entity-base.ts"
|
|
4342
|
+
}
|
|
4343
|
+
},
|
|
4021
4344
|
{
|
|
4022
4345
|
"kind": "field",
|
|
4023
4346
|
"name": "asset",
|
|
@@ -4061,7 +4384,7 @@
|
|
|
4061
4384
|
"type": {
|
|
4062
4385
|
"text": "EntityBaseElement | null"
|
|
4063
4386
|
},
|
|
4064
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
4387
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
4065
4388
|
"return": {
|
|
4066
4389
|
"type": {
|
|
4067
4390
|
"text": ""
|
|
@@ -4075,11 +4398,11 @@
|
|
|
4075
4398
|
},
|
|
4076
4399
|
{
|
|
4077
4400
|
"kind": "field",
|
|
4078
|
-
"name": "
|
|
4401
|
+
"name": "contentEntity",
|
|
4079
4402
|
"type": {
|
|
4080
4403
|
"text": "Entity | null"
|
|
4081
4404
|
},
|
|
4082
|
-
"description": "The root entity of the instantiated model
|
|
4405
|
+
"description": "The root entity of the instantiated model content, parented beneath the host entity.\n`null` until the container asset has loaded and been instantiated, after a failed load,\nand again once the element has been removed from the document.",
|
|
4083
4406
|
"return": {
|
|
4084
4407
|
"type": {
|
|
4085
4408
|
"text": ""
|
|
@@ -4087,6 +4410,44 @@
|
|
|
4087
4410
|
},
|
|
4088
4411
|
"readonly": true
|
|
4089
4412
|
},
|
|
4413
|
+
{
|
|
4414
|
+
"kind": "field",
|
|
4415
|
+
"name": "enabled",
|
|
4416
|
+
"description": "Gets the enabled state of the entity.",
|
|
4417
|
+
"parameters": [
|
|
4418
|
+
{
|
|
4419
|
+
"description": "Whether the entity is enabled.",
|
|
4420
|
+
"name": "value"
|
|
4421
|
+
}
|
|
4422
|
+
],
|
|
4423
|
+
"return": {
|
|
4424
|
+
"type": {
|
|
4425
|
+
"text": ""
|
|
4426
|
+
}
|
|
4427
|
+
},
|
|
4428
|
+
"inheritedFrom": {
|
|
4429
|
+
"name": "EntityOwnerElement",
|
|
4430
|
+
"module": "src/entity-owner.ts"
|
|
4431
|
+
}
|
|
4432
|
+
},
|
|
4433
|
+
{
|
|
4434
|
+
"kind": "field",
|
|
4435
|
+
"name": "entity",
|
|
4436
|
+
"type": {
|
|
4437
|
+
"text": "Entity | null"
|
|
4438
|
+
},
|
|
4439
|
+
"description": "The PlayCanvas entity instance. `null` until the element is ready, and again once the\nentity is gone — await whenReady or the element's `ready()` promise before\naccessing it.",
|
|
4440
|
+
"return": {
|
|
4441
|
+
"type": {
|
|
4442
|
+
"text": ""
|
|
4443
|
+
}
|
|
4444
|
+
},
|
|
4445
|
+
"readonly": true,
|
|
4446
|
+
"inheritedFrom": {
|
|
4447
|
+
"name": "EntityBaseElement",
|
|
4448
|
+
"module": "src/entity-base.ts"
|
|
4449
|
+
}
|
|
4450
|
+
},
|
|
4090
4451
|
{
|
|
4091
4452
|
"kind": "method",
|
|
4092
4453
|
"name": "hierarchy",
|
|
@@ -4095,7 +4456,47 @@
|
|
|
4095
4456
|
"text": ""
|
|
4096
4457
|
}
|
|
4097
4458
|
},
|
|
4098
|
-
"description": "Returns a snapshot of the instantiated node tree, or `null` while there is none (the\ncontainer asset has not loaded, or the element has left the document). One call grounds a\nsession — a browser console, a test, an agent — in the vocabulary `pc-node` binding\nresolves against: the instantiated names (HierarchyNode.name), paths, match\nindices, attached component types and the material assignments of render components\n(HierarchyNode.materials). `String(...)` of the result, or of any node in it,\nis the printable form.\n\nThe snapshot is plain data, computed afresh each call: it does not follow later changes\nto the hierarchy, and mutating it changes nothing."
|
|
4459
|
+
"description": "Returns a snapshot of the instantiated node tree, or `null` while there is none (the\ncontainer asset has not loaded, or the element has left the document). One call grounds a\nsession — a browser console, a test, an agent — in the vocabulary `pc-node` binding\nresolves against: the instantiated names (HierarchyNode.name), paths, match\nindices, attached component types and the material assignments of render components\n(HierarchyNode.materials). `String(...)` of the result, or of any node in it,\nis the printable form.\n\nThe snapshot is plain data, computed afresh each call: it does not follow later changes\nto the hierarchy, and mutating it changes nothing. It covers the instantiated content\nonly — the host entity the element fronts is not part of the asset's node tree."
|
|
4460
|
+
},
|
|
4461
|
+
{
|
|
4462
|
+
"kind": "field",
|
|
4463
|
+
"name": "name",
|
|
4464
|
+
"description": "Gets the name of the entity.",
|
|
4465
|
+
"parameters": [
|
|
4466
|
+
{
|
|
4467
|
+
"description": "The name of the entity.",
|
|
4468
|
+
"name": "value"
|
|
4469
|
+
}
|
|
4470
|
+
],
|
|
4471
|
+
"return": {
|
|
4472
|
+
"type": {
|
|
4473
|
+
"text": ""
|
|
4474
|
+
}
|
|
4475
|
+
},
|
|
4476
|
+
"inheritedFrom": {
|
|
4477
|
+
"name": "EntityOwnerElement",
|
|
4478
|
+
"module": "src/entity-owner.ts"
|
|
4479
|
+
}
|
|
4480
|
+
},
|
|
4481
|
+
{
|
|
4482
|
+
"kind": "field",
|
|
4483
|
+
"name": "position",
|
|
4484
|
+
"description": "Gets the position of the entity.",
|
|
4485
|
+
"parameters": [
|
|
4486
|
+
{
|
|
4487
|
+
"description": "The position of the entity.",
|
|
4488
|
+
"name": "value"
|
|
4489
|
+
}
|
|
4490
|
+
],
|
|
4491
|
+
"return": {
|
|
4492
|
+
"type": {
|
|
4493
|
+
"text": ""
|
|
4494
|
+
}
|
|
4495
|
+
},
|
|
4496
|
+
"inheritedFrom": {
|
|
4497
|
+
"name": "EntityOwnerElement",
|
|
4498
|
+
"module": "src/entity-owner.ts"
|
|
4499
|
+
}
|
|
4099
4500
|
},
|
|
4100
4501
|
{
|
|
4101
4502
|
"kind": "method",
|
|
@@ -4110,6 +4511,95 @@
|
|
|
4110
4511
|
"name": "AsyncElement",
|
|
4111
4512
|
"module": "src/async-element.ts"
|
|
4112
4513
|
}
|
|
4514
|
+
},
|
|
4515
|
+
{
|
|
4516
|
+
"kind": "method",
|
|
4517
|
+
"name": "removeEventListener",
|
|
4518
|
+
"parameters": [
|
|
4519
|
+
{
|
|
4520
|
+
"name": "type",
|
|
4521
|
+
"type": {
|
|
4522
|
+
"text": "string"
|
|
4523
|
+
}
|
|
4524
|
+
},
|
|
4525
|
+
{
|
|
4526
|
+
"name": "listener",
|
|
4527
|
+
"type": {
|
|
4528
|
+
"text": "EventListener"
|
|
4529
|
+
}
|
|
4530
|
+
},
|
|
4531
|
+
{
|
|
4532
|
+
"name": "options",
|
|
4533
|
+
"optional": true,
|
|
4534
|
+
"type": {
|
|
4535
|
+
"text": "boolean | EventListenerOptions"
|
|
4536
|
+
}
|
|
4537
|
+
}
|
|
4538
|
+
],
|
|
4539
|
+
"inheritedFrom": {
|
|
4540
|
+
"name": "EntityBaseElement",
|
|
4541
|
+
"module": "src/entity-base.ts"
|
|
4542
|
+
}
|
|
4543
|
+
},
|
|
4544
|
+
{
|
|
4545
|
+
"kind": "field",
|
|
4546
|
+
"name": "rotation",
|
|
4547
|
+
"description": "Gets the rotation of the entity.",
|
|
4548
|
+
"parameters": [
|
|
4549
|
+
{
|
|
4550
|
+
"description": "The rotation of the entity.",
|
|
4551
|
+
"name": "value"
|
|
4552
|
+
}
|
|
4553
|
+
],
|
|
4554
|
+
"return": {
|
|
4555
|
+
"type": {
|
|
4556
|
+
"text": ""
|
|
4557
|
+
}
|
|
4558
|
+
},
|
|
4559
|
+
"inheritedFrom": {
|
|
4560
|
+
"name": "EntityOwnerElement",
|
|
4561
|
+
"module": "src/entity-owner.ts"
|
|
4562
|
+
}
|
|
4563
|
+
},
|
|
4564
|
+
{
|
|
4565
|
+
"kind": "field",
|
|
4566
|
+
"name": "scale",
|
|
4567
|
+
"description": "Gets the scale of the entity.",
|
|
4568
|
+
"parameters": [
|
|
4569
|
+
{
|
|
4570
|
+
"description": "The scale of the entity.",
|
|
4571
|
+
"name": "value"
|
|
4572
|
+
}
|
|
4573
|
+
],
|
|
4574
|
+
"return": {
|
|
4575
|
+
"type": {
|
|
4576
|
+
"text": ""
|
|
4577
|
+
}
|
|
4578
|
+
},
|
|
4579
|
+
"inheritedFrom": {
|
|
4580
|
+
"name": "EntityOwnerElement",
|
|
4581
|
+
"module": "src/entity-owner.ts"
|
|
4582
|
+
}
|
|
4583
|
+
},
|
|
4584
|
+
{
|
|
4585
|
+
"kind": "field",
|
|
4586
|
+
"name": "tags",
|
|
4587
|
+
"description": "Gets the tags of the entity.",
|
|
4588
|
+
"parameters": [
|
|
4589
|
+
{
|
|
4590
|
+
"description": "The tags of the entity.",
|
|
4591
|
+
"name": "value"
|
|
4592
|
+
}
|
|
4593
|
+
],
|
|
4594
|
+
"return": {
|
|
4595
|
+
"type": {
|
|
4596
|
+
"text": ""
|
|
4597
|
+
}
|
|
4598
|
+
},
|
|
4599
|
+
"inheritedFrom": {
|
|
4600
|
+
"name": "EntityOwnerElement",
|
|
4601
|
+
"module": "src/entity-owner.ts"
|
|
4602
|
+
}
|
|
4113
4603
|
}
|
|
4114
4604
|
],
|
|
4115
4605
|
"events": [
|
|
@@ -4128,124 +4618,46 @@
|
|
|
4128
4618
|
"description": "Fired each time a container asset finishes instantiating, including re-instantiation after `asset` changes. Does not bubble — listen on this element, or use a capture-phase listener on an ancestor."
|
|
4129
4619
|
},
|
|
4130
4620
|
{
|
|
4131
|
-
"name": "ready",
|
|
4132
4621
|
"type": {
|
|
4133
|
-
"text": "
|
|
4622
|
+
"text": "PointerEvent"
|
|
4134
4623
|
},
|
|
4135
|
-
"description": "Fired when
|
|
4136
|
-
"
|
|
4137
|
-
|
|
4138
|
-
"module": "src/async-element.ts"
|
|
4139
|
-
}
|
|
4140
|
-
}
|
|
4141
|
-
],
|
|
4142
|
-
"attributes": [
|
|
4624
|
+
"description": "Fired when a pointer button is pressed over the model.",
|
|
4625
|
+
"name": "pointerdown"
|
|
4626
|
+
},
|
|
4143
4627
|
{
|
|
4144
|
-
"name": "asset",
|
|
4145
4628
|
"type": {
|
|
4146
|
-
"text": "
|
|
4629
|
+
"text": "PointerEvent"
|
|
4147
4630
|
},
|
|
4148
|
-
"
|
|
4149
|
-
"
|
|
4150
|
-
}
|
|
4151
|
-
],
|
|
4152
|
-
"superclass": {
|
|
4153
|
-
"name": "AsyncElement",
|
|
4154
|
-
"module": "/src/async-element"
|
|
4155
|
-
},
|
|
4156
|
-
"tagName": "pc-model",
|
|
4157
|
-
"customElement": true
|
|
4158
|
-
}
|
|
4159
|
-
],
|
|
4160
|
-
"exports": [
|
|
4161
|
-
{
|
|
4162
|
-
"kind": "custom-element-definition",
|
|
4163
|
-
"name": "pc-model",
|
|
4164
|
-
"declaration": {
|
|
4165
|
-
"name": "ModelElement",
|
|
4166
|
-
"module": "src/model.ts"
|
|
4167
|
-
}
|
|
4168
|
-
},
|
|
4169
|
-
{
|
|
4170
|
-
"kind": "js",
|
|
4171
|
-
"name": "ModelElement",
|
|
4172
|
-
"declaration": {
|
|
4173
|
-
"name": "ModelElement",
|
|
4174
|
-
"module": "src/model.ts"
|
|
4175
|
-
}
|
|
4176
|
-
},
|
|
4177
|
-
{
|
|
4178
|
-
"kind": "js",
|
|
4179
|
-
"name": "HierarchyMaterial",
|
|
4180
|
-
"declaration": {
|
|
4181
|
-
"name": "HierarchyMaterial",
|
|
4182
|
-
"module": "src/model.ts"
|
|
4183
|
-
}
|
|
4184
|
-
},
|
|
4185
|
-
{
|
|
4186
|
-
"kind": "js",
|
|
4187
|
-
"name": "HierarchyNode",
|
|
4188
|
-
"declaration": {
|
|
4189
|
-
"name": "HierarchyNode",
|
|
4190
|
-
"module": "src/model.ts"
|
|
4191
|
-
}
|
|
4192
|
-
}
|
|
4193
|
-
]
|
|
4194
|
-
},
|
|
4195
|
-
{
|
|
4196
|
-
"kind": "javascript-module",
|
|
4197
|
-
"path": "src/module.ts",
|
|
4198
|
-
"declarations": [
|
|
4199
|
-
{
|
|
4200
|
-
"kind": "class",
|
|
4201
|
-
"description": "The ModuleElement interface provides properties and methods for manipulating\n[`<pc-module>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-module/)\nelements. The ModuleElement interface also inherits the properties and methods of the\nAsyncElement interface.\n\nThe attributes are read once, when the module starts loading - on the element's first\nconnection, or earlier if a containing `<pc-app>` boots first and collects it - so changing\nthem later has no effect. The element becomes ready once the module has loaded. WebAssembly\nmodules configure engine-global state that never unloads, so readiness is not re-armed by\nremoving the element, and a re-inserted element does not load again.\n\nA `<pc-module>` without a `name` warns and never becomes ready; a containing `<pc-app>` still\nboots.\n",
|
|
4202
|
-
"name": "ModuleElement",
|
|
4203
|
-
"members": [
|
|
4631
|
+
"description": "Fired when the pointer moves onto the model.",
|
|
4632
|
+
"name": "pointerenter"
|
|
4633
|
+
},
|
|
4204
4634
|
{
|
|
4205
|
-
"kind": "field",
|
|
4206
|
-
"name": "closestApp",
|
|
4207
4635
|
"type": {
|
|
4208
|
-
"text": "
|
|
4209
|
-
},
|
|
4210
|
-
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
4211
|
-
"return": {
|
|
4212
|
-
"type": {
|
|
4213
|
-
"text": ""
|
|
4214
|
-
}
|
|
4636
|
+
"text": "PointerEvent"
|
|
4215
4637
|
},
|
|
4216
|
-
"
|
|
4217
|
-
"
|
|
4218
|
-
"name": "AsyncElement",
|
|
4219
|
-
"module": "src/async-element.ts"
|
|
4220
|
-
}
|
|
4638
|
+
"description": "Fired when the pointer moves off the model.",
|
|
4639
|
+
"name": "pointerleave"
|
|
4221
4640
|
},
|
|
4222
4641
|
{
|
|
4223
|
-
"kind": "field",
|
|
4224
|
-
"name": "closestEntity",
|
|
4225
4642
|
"type": {
|
|
4226
|
-
"text": "
|
|
4643
|
+
"text": "PointerEvent"
|
|
4227
4644
|
},
|
|
4228
|
-
"description": "
|
|
4229
|
-
"
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
|
|
4645
|
+
"description": "Fired when the pointer moves over the model.",
|
|
4646
|
+
"name": "pointermove"
|
|
4647
|
+
},
|
|
4648
|
+
{
|
|
4649
|
+
"type": {
|
|
4650
|
+
"text": "PointerEvent"
|
|
4233
4651
|
},
|
|
4234
|
-
"
|
|
4235
|
-
"
|
|
4236
|
-
"name": "AsyncElement",
|
|
4237
|
-
"module": "src/async-element.ts"
|
|
4238
|
-
}
|
|
4652
|
+
"description": "Fired when a pointer button is released over the model.",
|
|
4653
|
+
"name": "pointerup"
|
|
4239
4654
|
},
|
|
4240
4655
|
{
|
|
4241
|
-
"kind": "method",
|
|
4242
4656
|
"name": "ready",
|
|
4243
|
-
"
|
|
4244
|
-
"
|
|
4245
|
-
"text": ""
|
|
4246
|
-
}
|
|
4657
|
+
"type": {
|
|
4658
|
+
"text": "CustomEvent"
|
|
4247
4659
|
},
|
|
4248
|
-
"description": "
|
|
4660
|
+
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
4249
4661
|
"inheritedFrom": {
|
|
4250
4662
|
"name": "AsyncElement",
|
|
4251
4663
|
"module": "src/async-element.ts"
|
|
@@ -4254,70 +4666,145 @@
|
|
|
4254
4666
|
],
|
|
4255
4667
|
"attributes": [
|
|
4256
4668
|
{
|
|
4669
|
+
"name": "asset",
|
|
4257
4670
|
"type": {
|
|
4258
4671
|
"text": "string"
|
|
4259
4672
|
},
|
|
4260
|
-
"
|
|
4261
|
-
"
|
|
4673
|
+
"fieldName": "asset",
|
|
4674
|
+
"description": "The id of the `pc-asset` to use for the model."
|
|
4675
|
+
},
|
|
4676
|
+
{
|
|
4677
|
+
"name": "enabled",
|
|
4678
|
+
"type": {
|
|
4679
|
+
"text": "boolean"
|
|
4680
|
+
},
|
|
4681
|
+
"description": "The enabled state of the model.",
|
|
4682
|
+
"fieldName": "enabled",
|
|
4683
|
+
"default": "true"
|
|
4262
4684
|
},
|
|
4263
4685
|
{
|
|
4686
|
+
"name": "name",
|
|
4264
4687
|
"type": {
|
|
4265
4688
|
"text": "string"
|
|
4266
4689
|
},
|
|
4267
|
-
"description": "The
|
|
4268
|
-
"
|
|
4690
|
+
"description": "The name of the model.",
|
|
4691
|
+
"fieldName": "name"
|
|
4269
4692
|
},
|
|
4270
4693
|
{
|
|
4271
4694
|
"type": {
|
|
4272
4695
|
"text": "string"
|
|
4273
4696
|
},
|
|
4274
|
-
"description": "
|
|
4275
|
-
"name": "
|
|
4697
|
+
"description": "Script to run when a pointer button is pressed over the model.",
|
|
4698
|
+
"name": "onpointerdown",
|
|
4699
|
+
"fieldName": "onpointerdown"
|
|
4276
4700
|
},
|
|
4277
4701
|
{
|
|
4278
4702
|
"type": {
|
|
4279
4703
|
"text": "string"
|
|
4280
4704
|
},
|
|
4281
|
-
"description": "
|
|
4282
|
-
"name": "
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
"superclass": {
|
|
4286
|
-
"name": "AsyncElement",
|
|
4287
|
-
"module": "/src/async-element"
|
|
4288
|
-
},
|
|
4289
|
-
"tagName": "pc-module",
|
|
4290
|
-
"customElement": true,
|
|
4291
|
-
"events": [
|
|
4705
|
+
"description": "Script to run when the pointer moves onto the model.",
|
|
4706
|
+
"name": "onpointerenter",
|
|
4707
|
+
"fieldName": "onpointerenter"
|
|
4708
|
+
},
|
|
4292
4709
|
{
|
|
4293
|
-
"name": "ready",
|
|
4294
4710
|
"type": {
|
|
4295
|
-
"text": "
|
|
4711
|
+
"text": "string"
|
|
4296
4712
|
},
|
|
4297
|
-
"description": "
|
|
4298
|
-
"
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
|
|
4713
|
+
"description": "Script to run when the pointer moves off the model.",
|
|
4714
|
+
"name": "onpointerleave",
|
|
4715
|
+
"fieldName": "onpointerleave"
|
|
4716
|
+
},
|
|
4717
|
+
{
|
|
4718
|
+
"type": {
|
|
4719
|
+
"text": "string"
|
|
4720
|
+
},
|
|
4721
|
+
"description": "Script to run when the pointer moves over the model.",
|
|
4722
|
+
"name": "onpointermove",
|
|
4723
|
+
"fieldName": "onpointermove"
|
|
4724
|
+
},
|
|
4725
|
+
{
|
|
4726
|
+
"type": {
|
|
4727
|
+
"text": "string"
|
|
4728
|
+
},
|
|
4729
|
+
"description": "Script to run when a pointer button is released over the model.",
|
|
4730
|
+
"name": "onpointerup",
|
|
4731
|
+
"fieldName": "onpointerup"
|
|
4732
|
+
},
|
|
4733
|
+
{
|
|
4734
|
+
"name": "position",
|
|
4735
|
+
"type": {
|
|
4736
|
+
"text": "string"
|
|
4737
|
+
},
|
|
4738
|
+
"description": "The position of the model. Accepts 3 space-separated numbers.",
|
|
4739
|
+
"fieldName": "position",
|
|
4740
|
+
"default": "0 0 0"
|
|
4741
|
+
},
|
|
4742
|
+
{
|
|
4743
|
+
"name": "rotation",
|
|
4744
|
+
"type": {
|
|
4745
|
+
"text": "string"
|
|
4746
|
+
},
|
|
4747
|
+
"description": "The rotation of the model. Accepts 3 space-separated numbers.",
|
|
4748
|
+
"fieldName": "rotation",
|
|
4749
|
+
"default": "0 0 0"
|
|
4750
|
+
},
|
|
4751
|
+
{
|
|
4752
|
+
"name": "scale",
|
|
4753
|
+
"type": {
|
|
4754
|
+
"text": "string"
|
|
4755
|
+
},
|
|
4756
|
+
"description": "The scale of the model. Accepts 3 space-separated numbers.",
|
|
4757
|
+
"fieldName": "scale",
|
|
4758
|
+
"default": "1 1 1"
|
|
4759
|
+
},
|
|
4760
|
+
{
|
|
4761
|
+
"name": "tags",
|
|
4762
|
+
"type": {
|
|
4763
|
+
"text": "string"
|
|
4764
|
+
},
|
|
4765
|
+
"description": "The tags of the model.",
|
|
4766
|
+
"fieldName": "tags"
|
|
4302
4767
|
}
|
|
4303
|
-
]
|
|
4768
|
+
],
|
|
4769
|
+
"superclass": {
|
|
4770
|
+
"name": "EntityOwnerElement",
|
|
4771
|
+
"module": "/src/entity-owner"
|
|
4772
|
+
},
|
|
4773
|
+
"tagName": "pc-model",
|
|
4774
|
+
"customElement": true
|
|
4304
4775
|
}
|
|
4305
4776
|
],
|
|
4306
4777
|
"exports": [
|
|
4307
4778
|
{
|
|
4308
4779
|
"kind": "custom-element-definition",
|
|
4309
|
-
"name": "pc-
|
|
4780
|
+
"name": "pc-model",
|
|
4781
|
+
"declaration": {
|
|
4782
|
+
"name": "ModelElement",
|
|
4783
|
+
"module": "src/model.ts"
|
|
4784
|
+
}
|
|
4785
|
+
},
|
|
4786
|
+
{
|
|
4787
|
+
"kind": "js",
|
|
4788
|
+
"name": "ModelElement",
|
|
4789
|
+
"declaration": {
|
|
4790
|
+
"name": "ModelElement",
|
|
4791
|
+
"module": "src/model.ts"
|
|
4792
|
+
}
|
|
4793
|
+
},
|
|
4794
|
+
{
|
|
4795
|
+
"kind": "js",
|
|
4796
|
+
"name": "HierarchyMaterial",
|
|
4310
4797
|
"declaration": {
|
|
4311
|
-
"name": "
|
|
4312
|
-
"module": "src/
|
|
4798
|
+
"name": "HierarchyMaterial",
|
|
4799
|
+
"module": "src/model.ts"
|
|
4313
4800
|
}
|
|
4314
4801
|
},
|
|
4315
4802
|
{
|
|
4316
4803
|
"kind": "js",
|
|
4317
|
-
"name": "
|
|
4804
|
+
"name": "HierarchyNode",
|
|
4318
4805
|
"declaration": {
|
|
4319
|
-
"name": "
|
|
4320
|
-
"module": "src/
|
|
4806
|
+
"name": "HierarchyNode",
|
|
4807
|
+
"module": "src/model.ts"
|
|
4321
4808
|
}
|
|
4322
4809
|
}
|
|
4323
4810
|
]
|
|
@@ -4384,7 +4871,7 @@
|
|
|
4384
4871
|
"type": {
|
|
4385
4872
|
"text": "EntityBaseElement | null"
|
|
4386
4873
|
},
|
|
4387
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
4874
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
4388
4875
|
"return": {
|
|
4389
4876
|
"type": {
|
|
4390
4877
|
"text": ""
|
|
@@ -4860,7 +5347,7 @@
|
|
|
4860
5347
|
"type": {
|
|
4861
5348
|
"text": "EntityBaseElement | null"
|
|
4862
5349
|
},
|
|
4863
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
5350
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
4864
5351
|
"return": {
|
|
4865
5352
|
"type": {
|
|
4866
5353
|
"text": ""
|
|
@@ -5158,7 +5645,7 @@
|
|
|
5158
5645
|
"type": {
|
|
5159
5646
|
"text": "EntityBaseElement | null"
|
|
5160
5647
|
},
|
|
5161
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
5648
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
5162
5649
|
"return": {
|
|
5163
5650
|
"type": {
|
|
5164
5651
|
"text": ""
|
|
@@ -5318,47 +5805,177 @@
|
|
|
5318
5805
|
"description": "Whether the skybox is used as a light source."
|
|
5319
5806
|
},
|
|
5320
5807
|
{
|
|
5321
|
-
"name": "mip-level",
|
|
5808
|
+
"name": "mip-level",
|
|
5809
|
+
"type": {
|
|
5810
|
+
"text": "number"
|
|
5811
|
+
},
|
|
5812
|
+
"fieldName": "mipLevel",
|
|
5813
|
+
"default": "0",
|
|
5814
|
+
"description": "The mip level of the skybox."
|
|
5815
|
+
},
|
|
5816
|
+
{
|
|
5817
|
+
"name": "rotation",
|
|
5818
|
+
"type": {
|
|
5819
|
+
"text": "string"
|
|
5820
|
+
},
|
|
5821
|
+
"fieldName": "rotation",
|
|
5822
|
+
"default": "0 0 0",
|
|
5823
|
+
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers."
|
|
5824
|
+
},
|
|
5825
|
+
{
|
|
5826
|
+
"name": "scale",
|
|
5827
|
+
"type": {
|
|
5828
|
+
"text": "string"
|
|
5829
|
+
},
|
|
5830
|
+
"fieldName": "scale",
|
|
5831
|
+
"default": "100 100 100",
|
|
5832
|
+
"description": "The scale of the skybox. Accepts 3 space-separated numbers."
|
|
5833
|
+
},
|
|
5834
|
+
{
|
|
5835
|
+
"name": "type",
|
|
5836
|
+
"type": {
|
|
5837
|
+
"text": "'box' | 'dome' | 'infinite' | 'none'"
|
|
5838
|
+
},
|
|
5839
|
+
"fieldName": "type",
|
|
5840
|
+
"default": "infinite",
|
|
5841
|
+
"description": "The type of the skybox."
|
|
5842
|
+
}
|
|
5843
|
+
],
|
|
5844
|
+
"superclass": {
|
|
5845
|
+
"name": "AsyncElement",
|
|
5846
|
+
"module": "/src/async-element"
|
|
5847
|
+
},
|
|
5848
|
+
"tagName": "pc-sky",
|
|
5849
|
+
"customElement": true,
|
|
5850
|
+
"events": [
|
|
5851
|
+
{
|
|
5852
|
+
"name": "ready",
|
|
5853
|
+
"type": {
|
|
5854
|
+
"text": "CustomEvent"
|
|
5855
|
+
},
|
|
5856
|
+
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
5857
|
+
"inheritedFrom": {
|
|
5858
|
+
"name": "AsyncElement",
|
|
5859
|
+
"module": "src/async-element.ts"
|
|
5860
|
+
}
|
|
5861
|
+
}
|
|
5862
|
+
]
|
|
5863
|
+
}
|
|
5864
|
+
],
|
|
5865
|
+
"exports": [
|
|
5866
|
+
{
|
|
5867
|
+
"kind": "custom-element-definition",
|
|
5868
|
+
"name": "pc-sky",
|
|
5869
|
+
"declaration": {
|
|
5870
|
+
"name": "SkyElement",
|
|
5871
|
+
"module": "src/sky.ts"
|
|
5872
|
+
}
|
|
5873
|
+
},
|
|
5874
|
+
{
|
|
5875
|
+
"kind": "js",
|
|
5876
|
+
"name": "SkyElement",
|
|
5877
|
+
"declaration": {
|
|
5878
|
+
"name": "SkyElement",
|
|
5879
|
+
"module": "src/sky.ts"
|
|
5880
|
+
}
|
|
5881
|
+
}
|
|
5882
|
+
]
|
|
5883
|
+
},
|
|
5884
|
+
{
|
|
5885
|
+
"kind": "javascript-module",
|
|
5886
|
+
"path": "src/wasm.ts",
|
|
5887
|
+
"declarations": [
|
|
5888
|
+
{
|
|
5889
|
+
"kind": "class",
|
|
5890
|
+
"description": "The WasmElement interface provides properties and methods for manipulating\n[`<pc-wasm>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-wasm/)\nelements. The WasmElement interface also inherits the properties and methods of the\nAsyncElement interface.\n\nThe attributes are read once, when the module starts loading - on the element's first\nconnection, or earlier if a containing `<pc-app>` boots first and collects it - so changing\nthem later has no effect. The element becomes ready once the module has loaded. WebAssembly\nmodules configure engine-global state that never unloads, so readiness is not re-armed by\nremoving the element, and a re-inserted element does not load again.\n\nA `<pc-wasm>` without a `name` warns and never becomes ready; a containing `<pc-app>` still\nboots.\n",
|
|
5891
|
+
"name": "WasmElement",
|
|
5892
|
+
"members": [
|
|
5893
|
+
{
|
|
5894
|
+
"kind": "field",
|
|
5895
|
+
"name": "closestApp",
|
|
5896
|
+
"type": {
|
|
5897
|
+
"text": "AppElement | null"
|
|
5898
|
+
},
|
|
5899
|
+
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
5900
|
+
"return": {
|
|
5901
|
+
"type": {
|
|
5902
|
+
"text": ""
|
|
5903
|
+
}
|
|
5904
|
+
},
|
|
5905
|
+
"readonly": true,
|
|
5906
|
+
"inheritedFrom": {
|
|
5907
|
+
"name": "AsyncElement",
|
|
5908
|
+
"module": "src/async-element.ts"
|
|
5909
|
+
}
|
|
5910
|
+
},
|
|
5911
|
+
{
|
|
5912
|
+
"kind": "field",
|
|
5913
|
+
"name": "closestEntity",
|
|
5914
|
+
"type": {
|
|
5915
|
+
"text": "EntityBaseElement | null"
|
|
5916
|
+
},
|
|
5917
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
5918
|
+
"return": {
|
|
5919
|
+
"type": {
|
|
5920
|
+
"text": ""
|
|
5921
|
+
}
|
|
5922
|
+
},
|
|
5923
|
+
"readonly": true,
|
|
5924
|
+
"inheritedFrom": {
|
|
5925
|
+
"name": "AsyncElement",
|
|
5926
|
+
"module": "src/async-element.ts"
|
|
5927
|
+
}
|
|
5928
|
+
},
|
|
5929
|
+
{
|
|
5930
|
+
"kind": "method",
|
|
5931
|
+
"name": "ready",
|
|
5932
|
+
"return": {
|
|
5933
|
+
"type": {
|
|
5934
|
+
"text": ""
|
|
5935
|
+
}
|
|
5936
|
+
},
|
|
5937
|
+
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
5938
|
+
"inheritedFrom": {
|
|
5939
|
+
"name": "AsyncElement",
|
|
5940
|
+
"module": "src/async-element.ts"
|
|
5941
|
+
}
|
|
5942
|
+
}
|
|
5943
|
+
],
|
|
5944
|
+
"attributes": [
|
|
5945
|
+
{
|
|
5322
5946
|
"type": {
|
|
5323
|
-
"text": "
|
|
5947
|
+
"text": "string"
|
|
5324
5948
|
},
|
|
5325
|
-
"
|
|
5326
|
-
"
|
|
5327
|
-
"description": "The mip level of the skybox."
|
|
5949
|
+
"description": "The URL of the module's asm.js fallback script, used when WebAssembly is unavailable.",
|
|
5950
|
+
"name": "fallback"
|
|
5328
5951
|
},
|
|
5329
5952
|
{
|
|
5330
|
-
"name": "rotation",
|
|
5331
5953
|
"type": {
|
|
5332
5954
|
"text": "string"
|
|
5333
5955
|
},
|
|
5334
|
-
"
|
|
5335
|
-
"
|
|
5336
|
-
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers."
|
|
5956
|
+
"description": "The URL of the module's glue script.",
|
|
5957
|
+
"name": "glue"
|
|
5337
5958
|
},
|
|
5338
5959
|
{
|
|
5339
|
-
"name": "scale",
|
|
5340
5960
|
"type": {
|
|
5341
5961
|
"text": "string"
|
|
5342
5962
|
},
|
|
5343
|
-
"
|
|
5344
|
-
"
|
|
5345
|
-
"description": "The scale of the skybox. Accepts 3 space-separated numbers."
|
|
5963
|
+
"description": "The name of the WebAssembly module to configure, e.g. `Basis` or `Ammo`.",
|
|
5964
|
+
"name": "name"
|
|
5346
5965
|
},
|
|
5347
5966
|
{
|
|
5348
|
-
"name": "type",
|
|
5349
5967
|
"type": {
|
|
5350
|
-
"text": "
|
|
5968
|
+
"text": "string"
|
|
5351
5969
|
},
|
|
5352
|
-
"
|
|
5353
|
-
"
|
|
5354
|
-
"description": "The type of the skybox."
|
|
5970
|
+
"description": "The URL of the module's WebAssembly binary.",
|
|
5971
|
+
"name": "wasm"
|
|
5355
5972
|
}
|
|
5356
5973
|
],
|
|
5357
5974
|
"superclass": {
|
|
5358
5975
|
"name": "AsyncElement",
|
|
5359
5976
|
"module": "/src/async-element"
|
|
5360
5977
|
},
|
|
5361
|
-
"tagName": "pc-
|
|
5978
|
+
"tagName": "pc-wasm",
|
|
5362
5979
|
"customElement": true,
|
|
5363
5980
|
"events": [
|
|
5364
5981
|
{
|
|
@@ -5378,18 +5995,18 @@
|
|
|
5378
5995
|
"exports": [
|
|
5379
5996
|
{
|
|
5380
5997
|
"kind": "custom-element-definition",
|
|
5381
|
-
"name": "pc-
|
|
5998
|
+
"name": "pc-wasm",
|
|
5382
5999
|
"declaration": {
|
|
5383
|
-
"name": "
|
|
5384
|
-
"module": "src/
|
|
6000
|
+
"name": "WasmElement",
|
|
6001
|
+
"module": "src/wasm.ts"
|
|
5385
6002
|
}
|
|
5386
6003
|
},
|
|
5387
6004
|
{
|
|
5388
6005
|
"kind": "js",
|
|
5389
|
-
"name": "
|
|
6006
|
+
"name": "WasmElement",
|
|
5390
6007
|
"declaration": {
|
|
5391
|
-
"name": "
|
|
5392
|
-
"module": "src/
|
|
6008
|
+
"name": "WasmElement",
|
|
6009
|
+
"module": "src/wasm.ts"
|
|
5393
6010
|
}
|
|
5394
6011
|
}
|
|
5395
6012
|
]
|
|
@@ -5443,7 +6060,7 @@
|
|
|
5443
6060
|
"type": {
|
|
5444
6061
|
"text": "EntityBaseElement | null"
|
|
5445
6062
|
},
|
|
5446
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6063
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
5447
6064
|
"return": {
|
|
5448
6065
|
"type": {
|
|
5449
6066
|
"text": ""
|
|
@@ -5600,7 +6217,7 @@
|
|
|
5600
6217
|
"declarations": [
|
|
5601
6218
|
{
|
|
5602
6219
|
"kind": "class",
|
|
5603
|
-
"description": "The AnimComponentElement interface provides properties and methods for manipulating\n[`<pc-anim>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-anim/) elements.\nThe AnimComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element drives animation clips over the host entity's hierarchy. Clips come from\n`<pc-anim-clip>` children — or, when the element is a direct child of a `<pc-model>` and\ndeclares no clips, every animation of that model's container asset is assigned, named by track\nname, in container order. The first clip plays automatically (opt out with `activate=\"false\"`);\nswitch clips declaratively through the `clip` attribute, or imperatively through play\nand transition. Tracks bind to scene nodes by name, so any hierarchy whose node names\nmatch a clip's curves can be animated — a model's skeleton is simply the common case.\n\nThe engine reports no clip completion: a non-looping clip holds its last pose silently. Poll\nthe underlying AnimComponent (via component) for playback state beyond what\nthis element exposes.\n",
|
|
6220
|
+
"description": "The AnimComponentElement interface provides properties and methods for manipulating\n[`<pc-anim>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-anim/) elements.\nThe AnimComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element drives animation clips over the host entity's hierarchy. Clips come from\n`<pc-anim-clip>` children — or, when the element is a direct child of a `<pc-model>` and\ndeclares no clips, every animation of that model's container asset is assigned, named by track\nname, in container order. The first clip plays automatically (opt out with `activate=\"false\"`);\nswitch clips declaratively through the `clip` attribute, or imperatively through play\nand transition. Tracks bind to scene nodes by name, so any hierarchy whose node names\nmatch a clip's curves can be animated — a model's skeleton is simply the common case.\n\nThe engine reports no clip completion: a non-looping clip holds its last pose silently. Poll\nthe underlying AnimComponent (via component) for playback state beyond what\nthis element exposes.\n\nEngine component: AnimComponent (`anim`).\n",
|
|
5604
6221
|
"name": "AnimComponentElement",
|
|
5605
6222
|
"members": [
|
|
5606
6223
|
{
|
|
@@ -5673,7 +6290,7 @@
|
|
|
5673
6290
|
"type": {
|
|
5674
6291
|
"text": "EntityBaseElement | null"
|
|
5675
6292
|
},
|
|
5676
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6293
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
5677
6294
|
"return": {
|
|
5678
6295
|
"type": {
|
|
5679
6296
|
"text": ""
|
|
@@ -5753,17 +6370,233 @@
|
|
|
5753
6370
|
},
|
|
5754
6371
|
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
5755
6372
|
"inheritedFrom": {
|
|
5756
|
-
"name": "AsyncElement",
|
|
5757
|
-
"module": "src/async-element.ts"
|
|
6373
|
+
"name": "AsyncElement",
|
|
6374
|
+
"module": "src/async-element.ts"
|
|
6375
|
+
}
|
|
6376
|
+
},
|
|
6377
|
+
{
|
|
6378
|
+
"kind": "field",
|
|
6379
|
+
"name": "speed",
|
|
6380
|
+
"description": "Gets the playback speed multiplier applied across all clips.",
|
|
6381
|
+
"parameters": [
|
|
6382
|
+
{
|
|
6383
|
+
"description": "The playback speed multiplier.",
|
|
6384
|
+
"name": "value"
|
|
6385
|
+
}
|
|
6386
|
+
],
|
|
6387
|
+
"return": {
|
|
6388
|
+
"type": {
|
|
6389
|
+
"text": ""
|
|
6390
|
+
}
|
|
6391
|
+
}
|
|
6392
|
+
},
|
|
6393
|
+
{
|
|
6394
|
+
"kind": "method",
|
|
6395
|
+
"name": "transition",
|
|
6396
|
+
"parameters": [
|
|
6397
|
+
{
|
|
6398
|
+
"name": "name",
|
|
6399
|
+
"type": {
|
|
6400
|
+
"text": "string"
|
|
6401
|
+
},
|
|
6402
|
+
"description": "The name of the clip to fade to."
|
|
6403
|
+
},
|
|
6404
|
+
{
|
|
6405
|
+
"name": "time",
|
|
6406
|
+
"optional": true,
|
|
6407
|
+
"type": {
|
|
6408
|
+
"text": "number"
|
|
6409
|
+
},
|
|
6410
|
+
"description": "The fade duration in seconds. Defaults to the `transition-time` attribute."
|
|
6411
|
+
}
|
|
6412
|
+
],
|
|
6413
|
+
"description": "Cross-fades to a named clip and ensures playback is running. A name that matches no clip\nleaves the selection unchanged."
|
|
6414
|
+
},
|
|
6415
|
+
{
|
|
6416
|
+
"kind": "field",
|
|
6417
|
+
"name": "transitionTime",
|
|
6418
|
+
"description": "Gets the cross-fade duration of clip switches made through the `clip` attribute.",
|
|
6419
|
+
"parameters": [
|
|
6420
|
+
{
|
|
6421
|
+
"description": "The cross-fade duration in seconds.",
|
|
6422
|
+
"name": "value"
|
|
6423
|
+
}
|
|
6424
|
+
],
|
|
6425
|
+
"return": {
|
|
6426
|
+
"type": {
|
|
6427
|
+
"text": ""
|
|
6428
|
+
}
|
|
6429
|
+
}
|
|
6430
|
+
}
|
|
6431
|
+
],
|
|
6432
|
+
"attributes": [
|
|
6433
|
+
{
|
|
6434
|
+
"name": "activate",
|
|
6435
|
+
"type": {
|
|
6436
|
+
"text": "boolean"
|
|
6437
|
+
},
|
|
6438
|
+
"fieldName": "activate",
|
|
6439
|
+
"default": "true",
|
|
6440
|
+
"description": "Whether playback starts automatically once a clip is assigned."
|
|
6441
|
+
},
|
|
6442
|
+
{
|
|
6443
|
+
"name": "clip",
|
|
6444
|
+
"type": {
|
|
6445
|
+
"text": "string"
|
|
6446
|
+
},
|
|
6447
|
+
"fieldName": "clip",
|
|
6448
|
+
"description": "The name of the active clip."
|
|
6449
|
+
},
|
|
6450
|
+
{
|
|
6451
|
+
"name": "enabled",
|
|
6452
|
+
"type": {
|
|
6453
|
+
"text": "boolean"
|
|
6454
|
+
},
|
|
6455
|
+
"fieldName": "enabled",
|
|
6456
|
+
"default": "true",
|
|
6457
|
+
"description": "The enabled state of the component.",
|
|
6458
|
+
"inheritedFrom": {
|
|
6459
|
+
"name": "ComponentElement",
|
|
6460
|
+
"module": "src/components/component.ts"
|
|
6461
|
+
}
|
|
6462
|
+
},
|
|
6463
|
+
{
|
|
6464
|
+
"name": "speed",
|
|
6465
|
+
"type": {
|
|
6466
|
+
"text": "number"
|
|
6467
|
+
},
|
|
6468
|
+
"fieldName": "speed",
|
|
6469
|
+
"default": "1",
|
|
6470
|
+
"description": "The playback speed multiplier applied across all clips."
|
|
6471
|
+
},
|
|
6472
|
+
{
|
|
6473
|
+
"name": "transition-time",
|
|
6474
|
+
"type": {
|
|
6475
|
+
"text": "number"
|
|
6476
|
+
},
|
|
6477
|
+
"fieldName": "transitionTime",
|
|
6478
|
+
"default": "0",
|
|
6479
|
+
"description": "The cross-fade duration of clip switches made through the `clip` attribute."
|
|
6480
|
+
}
|
|
6481
|
+
],
|
|
6482
|
+
"superclass": {
|
|
6483
|
+
"name": "ComponentElement",
|
|
6484
|
+
"module": "/src/components/component"
|
|
6485
|
+
},
|
|
6486
|
+
"tagName": "pc-anim",
|
|
6487
|
+
"customElement": true,
|
|
6488
|
+
"events": [
|
|
6489
|
+
{
|
|
6490
|
+
"name": "ready",
|
|
6491
|
+
"type": {
|
|
6492
|
+
"text": "CustomEvent"
|
|
6493
|
+
},
|
|
6494
|
+
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
6495
|
+
"inheritedFrom": {
|
|
6496
|
+
"name": "AsyncElement",
|
|
6497
|
+
"module": "src/async-element.ts"
|
|
6498
|
+
}
|
|
6499
|
+
}
|
|
6500
|
+
]
|
|
6501
|
+
}
|
|
6502
|
+
],
|
|
6503
|
+
"exports": [
|
|
6504
|
+
{
|
|
6505
|
+
"kind": "custom-element-definition",
|
|
6506
|
+
"name": "pc-anim",
|
|
6507
|
+
"declaration": {
|
|
6508
|
+
"name": "AnimComponentElement",
|
|
6509
|
+
"module": "src/components/anim-component.ts"
|
|
6510
|
+
}
|
|
6511
|
+
},
|
|
6512
|
+
{
|
|
6513
|
+
"kind": "js",
|
|
6514
|
+
"name": "AnimComponentElement",
|
|
6515
|
+
"declaration": {
|
|
6516
|
+
"name": "AnimComponentElement",
|
|
6517
|
+
"module": "src/components/anim-component.ts"
|
|
6518
|
+
}
|
|
6519
|
+
},
|
|
6520
|
+
{
|
|
6521
|
+
"kind": "js",
|
|
6522
|
+
"name": "ContainerWithAnimations",
|
|
6523
|
+
"declaration": {
|
|
6524
|
+
"name": "ContainerWithAnimations",
|
|
6525
|
+
"module": "src/components/anim-component.ts"
|
|
6526
|
+
}
|
|
6527
|
+
}
|
|
6528
|
+
]
|
|
6529
|
+
},
|
|
6530
|
+
{
|
|
6531
|
+
"kind": "javascript-module",
|
|
6532
|
+
"path": "src/components/audio-listener-component.ts",
|
|
6533
|
+
"declarations": [
|
|
6534
|
+
{
|
|
6535
|
+
"kind": "class",
|
|
6536
|
+
"description": "The AudioListenerComponentElement interface provides properties and methods for manipulating\n[`<pc-audio-listener>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-audio-listener/) elements.\nThe AudioListenerComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: AudioListenerComponent (`audiolistener`).\n",
|
|
6537
|
+
"name": "AudioListenerComponentElement",
|
|
6538
|
+
"members": [
|
|
6539
|
+
{
|
|
6540
|
+
"kind": "field",
|
|
6541
|
+
"name": "closestApp",
|
|
6542
|
+
"type": {
|
|
6543
|
+
"text": "AppElement | null"
|
|
6544
|
+
},
|
|
6545
|
+
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
6546
|
+
"return": {
|
|
6547
|
+
"type": {
|
|
6548
|
+
"text": ""
|
|
6549
|
+
}
|
|
6550
|
+
},
|
|
6551
|
+
"readonly": true,
|
|
6552
|
+
"inheritedFrom": {
|
|
6553
|
+
"name": "AsyncElement",
|
|
6554
|
+
"module": "src/async-element.ts"
|
|
6555
|
+
}
|
|
6556
|
+
},
|
|
6557
|
+
{
|
|
6558
|
+
"kind": "field",
|
|
6559
|
+
"name": "closestEntity",
|
|
6560
|
+
"type": {
|
|
6561
|
+
"text": "EntityBaseElement | null"
|
|
6562
|
+
},
|
|
6563
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
6564
|
+
"return": {
|
|
6565
|
+
"type": {
|
|
6566
|
+
"text": ""
|
|
6567
|
+
}
|
|
6568
|
+
},
|
|
6569
|
+
"readonly": true,
|
|
6570
|
+
"inheritedFrom": {
|
|
6571
|
+
"name": "AsyncElement",
|
|
6572
|
+
"module": "src/async-element.ts"
|
|
6573
|
+
}
|
|
6574
|
+
},
|
|
6575
|
+
{
|
|
6576
|
+
"kind": "field",
|
|
6577
|
+
"name": "component",
|
|
6578
|
+
"type": {
|
|
6579
|
+
"text": "Component | null"
|
|
6580
|
+
},
|
|
6581
|
+
"description": "Gets the underlying PlayCanvas audio listener component.",
|
|
6582
|
+
"return": {
|
|
6583
|
+
"type": {
|
|
6584
|
+
"text": ""
|
|
6585
|
+
}
|
|
6586
|
+
},
|
|
6587
|
+
"readonly": true,
|
|
6588
|
+
"inheritedFrom": {
|
|
6589
|
+
"name": "ComponentElement",
|
|
6590
|
+
"module": "src/components/component.ts"
|
|
5758
6591
|
}
|
|
5759
6592
|
},
|
|
5760
6593
|
{
|
|
5761
6594
|
"kind": "field",
|
|
5762
|
-
"name": "
|
|
5763
|
-
"description": "Gets the
|
|
6595
|
+
"name": "enabled",
|
|
6596
|
+
"description": "Gets the enabled state of the component.",
|
|
5764
6597
|
"parameters": [
|
|
5765
6598
|
{
|
|
5766
|
-
"description": "The
|
|
6599
|
+
"description": "The enabled state of the component.",
|
|
5767
6600
|
"name": "value"
|
|
5768
6601
|
}
|
|
5769
6602
|
],
|
|
@@ -5771,65 +6604,34 @@
|
|
|
5771
6604
|
"type": {
|
|
5772
6605
|
"text": ""
|
|
5773
6606
|
}
|
|
6607
|
+
},
|
|
6608
|
+
"inheritedFrom": {
|
|
6609
|
+
"name": "ComponentElement",
|
|
6610
|
+
"module": "src/components/component.ts"
|
|
5774
6611
|
}
|
|
5775
6612
|
},
|
|
5776
6613
|
{
|
|
5777
6614
|
"kind": "method",
|
|
5778
|
-
"name": "
|
|
5779
|
-
"parameters": [
|
|
5780
|
-
{
|
|
5781
|
-
"name": "name",
|
|
5782
|
-
"type": {
|
|
5783
|
-
"text": "string"
|
|
5784
|
-
},
|
|
5785
|
-
"description": "The name of the clip to fade to."
|
|
5786
|
-
},
|
|
5787
|
-
{
|
|
5788
|
-
"name": "time",
|
|
5789
|
-
"optional": true,
|
|
5790
|
-
"type": {
|
|
5791
|
-
"text": "number"
|
|
5792
|
-
},
|
|
5793
|
-
"description": "The fade duration in seconds. Defaults to the `transition-time` attribute."
|
|
5794
|
-
}
|
|
5795
|
-
],
|
|
5796
|
-
"description": "Cross-fades to a named clip and ensures playback is running. A name that matches no clip\nleaves the selection unchanged."
|
|
5797
|
-
},
|
|
5798
|
-
{
|
|
5799
|
-
"kind": "field",
|
|
5800
|
-
"name": "transitionTime",
|
|
5801
|
-
"description": "Gets the cross-fade duration of clip switches made through the `clip` attribute.",
|
|
5802
|
-
"parameters": [
|
|
5803
|
-
{
|
|
5804
|
-
"description": "The cross-fade duration in seconds.",
|
|
5805
|
-
"name": "value"
|
|
5806
|
-
}
|
|
5807
|
-
],
|
|
6615
|
+
"name": "ready",
|
|
5808
6616
|
"return": {
|
|
5809
6617
|
"type": {
|
|
5810
6618
|
"text": ""
|
|
5811
6619
|
}
|
|
6620
|
+
},
|
|
6621
|
+
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
6622
|
+
"inheritedFrom": {
|
|
6623
|
+
"name": "AsyncElement",
|
|
6624
|
+
"module": "src/async-element.ts"
|
|
5812
6625
|
}
|
|
5813
6626
|
}
|
|
5814
6627
|
],
|
|
6628
|
+
"superclass": {
|
|
6629
|
+
"name": "ComponentElement",
|
|
6630
|
+
"module": "/src/components/component"
|
|
6631
|
+
},
|
|
6632
|
+
"tagName": "pc-audio-listener",
|
|
6633
|
+
"customElement": true,
|
|
5815
6634
|
"attributes": [
|
|
5816
|
-
{
|
|
5817
|
-
"name": "activate",
|
|
5818
|
-
"type": {
|
|
5819
|
-
"text": "boolean"
|
|
5820
|
-
},
|
|
5821
|
-
"fieldName": "activate",
|
|
5822
|
-
"default": "true",
|
|
5823
|
-
"description": "Whether playback starts automatically once a clip is assigned."
|
|
5824
|
-
},
|
|
5825
|
-
{
|
|
5826
|
-
"name": "clip",
|
|
5827
|
-
"type": {
|
|
5828
|
-
"text": "string"
|
|
5829
|
-
},
|
|
5830
|
-
"fieldName": "clip",
|
|
5831
|
-
"description": "The name of the active clip."
|
|
5832
|
-
},
|
|
5833
6635
|
{
|
|
5834
6636
|
"name": "enabled",
|
|
5835
6637
|
"type": {
|
|
@@ -5842,32 +6644,8 @@
|
|
|
5842
6644
|
"name": "ComponentElement",
|
|
5843
6645
|
"module": "src/components/component.ts"
|
|
5844
6646
|
}
|
|
5845
|
-
},
|
|
5846
|
-
{
|
|
5847
|
-
"name": "speed",
|
|
5848
|
-
"type": {
|
|
5849
|
-
"text": "number"
|
|
5850
|
-
},
|
|
5851
|
-
"fieldName": "speed",
|
|
5852
|
-
"default": "1",
|
|
5853
|
-
"description": "The playback speed multiplier applied across all clips."
|
|
5854
|
-
},
|
|
5855
|
-
{
|
|
5856
|
-
"name": "transition-time",
|
|
5857
|
-
"type": {
|
|
5858
|
-
"text": "number"
|
|
5859
|
-
},
|
|
5860
|
-
"fieldName": "transitionTime",
|
|
5861
|
-
"default": "0",
|
|
5862
|
-
"description": "The cross-fade duration of clip switches made through the `clip` attribute."
|
|
5863
6647
|
}
|
|
5864
6648
|
],
|
|
5865
|
-
"superclass": {
|
|
5866
|
-
"name": "ComponentElement",
|
|
5867
|
-
"module": "/src/components/component"
|
|
5868
|
-
},
|
|
5869
|
-
"tagName": "pc-anim",
|
|
5870
|
-
"customElement": true,
|
|
5871
6649
|
"events": [
|
|
5872
6650
|
{
|
|
5873
6651
|
"name": "ready",
|
|
@@ -5886,26 +6664,18 @@
|
|
|
5886
6664
|
"exports": [
|
|
5887
6665
|
{
|
|
5888
6666
|
"kind": "custom-element-definition",
|
|
5889
|
-
"name": "pc-
|
|
5890
|
-
"declaration": {
|
|
5891
|
-
"name": "AnimComponentElement",
|
|
5892
|
-
"module": "src/components/anim-component.ts"
|
|
5893
|
-
}
|
|
5894
|
-
},
|
|
5895
|
-
{
|
|
5896
|
-
"kind": "js",
|
|
5897
|
-
"name": "AnimComponentElement",
|
|
6667
|
+
"name": "pc-audio-listener",
|
|
5898
6668
|
"declaration": {
|
|
5899
|
-
"name": "
|
|
5900
|
-
"module": "src/components/
|
|
6669
|
+
"name": "AudioListenerComponentElement",
|
|
6670
|
+
"module": "src/components/audio-listener-component.ts"
|
|
5901
6671
|
}
|
|
5902
6672
|
},
|
|
5903
6673
|
{
|
|
5904
6674
|
"kind": "js",
|
|
5905
|
-
"name": "
|
|
6675
|
+
"name": "AudioListenerComponentElement",
|
|
5906
6676
|
"declaration": {
|
|
5907
|
-
"name": "
|
|
5908
|
-
"module": "src/components/
|
|
6677
|
+
"name": "AudioListenerComponentElement",
|
|
6678
|
+
"module": "src/components/audio-listener-component.ts"
|
|
5909
6679
|
}
|
|
5910
6680
|
}
|
|
5911
6681
|
]
|
|
@@ -5916,7 +6686,7 @@
|
|
|
5916
6686
|
"declarations": [
|
|
5917
6687
|
{
|
|
5918
6688
|
"kind": "class",
|
|
5919
|
-
"description": "The ButtonComponentElement interface provides properties and methods for manipulating\n[`<pc-button>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-button/) elements.\nThe ButtonComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
6689
|
+
"description": "The ButtonComponentElement interface provides properties and methods for manipulating\n[`<pc-button>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-button/) elements.\nThe ButtonComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: ButtonComponent (`button`).\n",
|
|
5920
6690
|
"name": "ButtonComponentElement",
|
|
5921
6691
|
"members": [
|
|
5922
6692
|
{
|
|
@@ -5959,7 +6729,7 @@
|
|
|
5959
6729
|
"type": {
|
|
5960
6730
|
"text": "EntityBaseElement | null"
|
|
5961
6731
|
},
|
|
5962
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6732
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
5963
6733
|
"return": {
|
|
5964
6734
|
"type": {
|
|
5965
6735
|
"text": ""
|
|
@@ -6415,7 +7185,7 @@
|
|
|
6415
7185
|
"declarations": [
|
|
6416
7186
|
{
|
|
6417
7187
|
"kind": "class",
|
|
6418
|
-
"description": "The CameraComponentElement interface provides properties and methods for manipulating\n[`<pc-camera>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-camera/) elements.\nThe CameraComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
7188
|
+
"description": "The CameraComponentElement interface provides properties and methods for manipulating\n[`<pc-camera>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-camera/) elements.\nThe CameraComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: CameraComponent (`camera`).\n",
|
|
6419
7189
|
"name": "CameraComponentElement",
|
|
6420
7190
|
"members": [
|
|
6421
7191
|
{
|
|
@@ -6518,7 +7288,7 @@
|
|
|
6518
7288
|
"type": {
|
|
6519
7289
|
"text": "EntityBaseElement | null"
|
|
6520
7290
|
},
|
|
6521
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
7291
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
6522
7292
|
"return": {
|
|
6523
7293
|
"type": {
|
|
6524
7294
|
"text": ""
|
|
@@ -7097,7 +7867,7 @@
|
|
|
7097
7867
|
"declarations": [
|
|
7098
7868
|
{
|
|
7099
7869
|
"kind": "class",
|
|
7100
|
-
"description": "The CollisionComponentElement interface provides properties and methods for manipulating\n[`<pc-collision>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-collision/) elements.\nThe CollisionComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nFor `type=\"mesh\"`, the collision geometry defaults to the host entity's own render component\n(its render asset) — a collider matching the visible mesh, which is what a mesh collider on a\nglTF node means. The default resolves each time the component applies, so a `pc-node` that\nretargets or rebinds picks up the new node's geometry. An entity with no asset-backed render\ncomponent warns, and the collider has no shape.\n",
|
|
7870
|
+
"description": "The CollisionComponentElement interface provides properties and methods for manipulating\n[`<pc-collision>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-collision/) elements.\nThe CollisionComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nFor `type=\"mesh\"`, the collision geometry defaults to the host entity's own render component\n(its render asset) — a collider matching the visible mesh, which is what a mesh collider on a\nglTF node means. The default resolves each time the component applies, so a `pc-node` that\nretargets or rebinds picks up the new node's geometry. An entity with no asset-backed render\ncomponent warns, and the collider has no shape.\n\nEngine component: CollisionComponent (`collision`).\n",
|
|
7101
7871
|
"name": "CollisionComponentElement",
|
|
7102
7872
|
"members": [
|
|
7103
7873
|
{
|
|
@@ -7132,7 +7902,7 @@
|
|
|
7132
7902
|
"type": {
|
|
7133
7903
|
"text": "EntityBaseElement | null"
|
|
7134
7904
|
},
|
|
7135
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
7905
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
7136
7906
|
"return": {
|
|
7137
7907
|
"type": {
|
|
7138
7908
|
"text": ""
|
|
@@ -7376,7 +8146,7 @@
|
|
|
7376
8146
|
"type": {
|
|
7377
8147
|
"text": "EntityBaseElement | null"
|
|
7378
8148
|
},
|
|
7379
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
8149
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
7380
8150
|
"return": {
|
|
7381
8151
|
"type": {
|
|
7382
8152
|
"text": ""
|
|
@@ -7394,7 +8164,7 @@
|
|
|
7394
8164
|
"type": {
|
|
7395
8165
|
"text": "Component | null"
|
|
7396
8166
|
},
|
|
7397
|
-
"description": "The PlayCanvas component instance. `null` until the element is ready, and also for an\nelement that is not a descendant of
|
|
8167
|
+
"description": "The PlayCanvas component instance. `null` until the element is ready, and also for an\nelement that is not a descendant of an entity-fronting element (`<pc-entity>`,\n`<pc-model>` or `<pc-node>`) — await whenReady or the element's `ready()` promise\nbefore accessing it.",
|
|
7398
8168
|
"return": {
|
|
7399
8169
|
"type": {
|
|
7400
8170
|
"text": ""
|
|
@@ -7480,7 +8250,7 @@
|
|
|
7480
8250
|
"declarations": [
|
|
7481
8251
|
{
|
|
7482
8252
|
"kind": "class",
|
|
7483
|
-
"description": "The ElementComponentElement interface provides properties and methods for manipulating\n[`<pc-element>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-element/) elements.\nThe ElementComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
8253
|
+
"description": "The ElementComponentElement interface provides properties and methods for manipulating\n[`<pc-element>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-element/) elements.\nThe ElementComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nDespite the name, this is not a base class or a generic wrapper: it is the engine's 2D UI\ncomponent, which gives its host entity a rectangle in a `<pc-screen>` hierarchy that draws\neither an image, a line of text or nothing (`type=\"image\"`, `\"text\"` or `\"group\"`). The tag\nspells the engine component it adds, as every component element does.\n\nEngine component: ElementComponent (`element`).\n",
|
|
7484
8254
|
"name": "ElementComponentElement",
|
|
7485
8255
|
"members": [
|
|
7486
8256
|
{
|
|
@@ -7587,7 +8357,7 @@
|
|
|
7587
8357
|
"type": {
|
|
7588
8358
|
"text": "EntityBaseElement | null"
|
|
7589
8359
|
},
|
|
7590
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
8360
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
7591
8361
|
"return": {
|
|
7592
8362
|
"type": {
|
|
7593
8363
|
"text": ""
|
|
@@ -8280,7 +9050,7 @@
|
|
|
8280
9050
|
"declarations": [
|
|
8281
9051
|
{
|
|
8282
9052
|
"kind": "class",
|
|
8283
|
-
"description": "The GSplatComponentElement interface provides properties and methods for manipulating\n[`<pc-gsplat>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-gsplat/) elements.\nThe GSplatComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
9053
|
+
"description": "The GSplatComponentElement interface provides properties and methods for manipulating\n[`<pc-gsplat>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-gsplat/) elements.\nThe GSplatComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: GSplatComponent (`gsplat`).\n",
|
|
8284
9054
|
"name": "GSplatComponentElement",
|
|
8285
9055
|
"members": [
|
|
8286
9056
|
{
|
|
@@ -8339,7 +9109,7 @@
|
|
|
8339
9109
|
"type": {
|
|
8340
9110
|
"text": "EntityBaseElement | null"
|
|
8341
9111
|
},
|
|
8342
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
9112
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
8343
9113
|
"return": {
|
|
8344
9114
|
"type": {
|
|
8345
9115
|
"text": ""
|
|
@@ -8769,7 +9539,7 @@
|
|
|
8769
9539
|
"type": {
|
|
8770
9540
|
"text": "EntityBaseElement | null"
|
|
8771
9541
|
},
|
|
8772
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
9542
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
8773
9543
|
"return": {
|
|
8774
9544
|
"type": {
|
|
8775
9545
|
"text": ""
|
|
@@ -9160,7 +9930,7 @@
|
|
|
9160
9930
|
"type": {
|
|
9161
9931
|
"text": "CustomEvent"
|
|
9162
9932
|
},
|
|
9163
|
-
"description": "Fired when the impulse on the joint exceeds `break-impulse` and the constraint breaks. A broken joint no longer constrains its bodies; calling `refreshFrames()` on the underlying component re-attaches it. Bubbles and is composed."
|
|
9933
|
+
"description": "Fired when the impulse on the joint exceeds `break-impulse` and the constraint breaks. A broken joint no longer constrains its bodies; calling `refreshFrames()` on the underlying component re-attaches it. Bubbles and is composed. Engine component: `JointComponent` (`joint`)."
|
|
9164
9934
|
},
|
|
9165
9935
|
{
|
|
9166
9936
|
"name": "ready",
|
|
@@ -9486,11 +10256,11 @@
|
|
|
9486
10256
|
},
|
|
9487
10257
|
{
|
|
9488
10258
|
"kind": "javascript-module",
|
|
9489
|
-
"path": "src/components/
|
|
10259
|
+
"path": "src/components/layout-child-component.ts",
|
|
9490
10260
|
"declarations": [
|
|
9491
10261
|
{
|
|
9492
10262
|
"kind": "class",
|
|
9493
|
-
"description": "The LayoutChildComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
10263
|
+
"description": "The LayoutChildComponentElement interface provides properties and methods for manipulating\n[`<pc-layout-child>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-layout-child/) elements.\nThe LayoutChildComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: LayoutChildComponent (`layoutchild`).\n",
|
|
9494
10264
|
"name": "LayoutChildComponentElement",
|
|
9495
10265
|
"members": [
|
|
9496
10266
|
{
|
|
@@ -9517,7 +10287,7 @@
|
|
|
9517
10287
|
"type": {
|
|
9518
10288
|
"text": "EntityBaseElement | null"
|
|
9519
10289
|
},
|
|
9520
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
10290
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
9521
10291
|
"return": {
|
|
9522
10292
|
"type": {
|
|
9523
10293
|
"text": ""
|
|
@@ -9774,7 +10544,7 @@
|
|
|
9774
10544
|
"name": "ComponentElement",
|
|
9775
10545
|
"module": "/src/components/component"
|
|
9776
10546
|
},
|
|
9777
|
-
"tagName": "pc-
|
|
10547
|
+
"tagName": "pc-layout-child",
|
|
9778
10548
|
"customElement": true,
|
|
9779
10549
|
"events": [
|
|
9780
10550
|
{
|
|
@@ -9794,10 +10564,10 @@
|
|
|
9794
10564
|
"exports": [
|
|
9795
10565
|
{
|
|
9796
10566
|
"kind": "custom-element-definition",
|
|
9797
|
-
"name": "pc-
|
|
10567
|
+
"name": "pc-layout-child",
|
|
9798
10568
|
"declaration": {
|
|
9799
10569
|
"name": "LayoutChildComponentElement",
|
|
9800
|
-
"module": "src/components/
|
|
10570
|
+
"module": "src/components/layout-child-component.ts"
|
|
9801
10571
|
}
|
|
9802
10572
|
},
|
|
9803
10573
|
{
|
|
@@ -9805,18 +10575,18 @@
|
|
|
9805
10575
|
"name": "LayoutChildComponentElement",
|
|
9806
10576
|
"declaration": {
|
|
9807
10577
|
"name": "LayoutChildComponentElement",
|
|
9808
|
-
"module": "src/components/
|
|
10578
|
+
"module": "src/components/layout-child-component.ts"
|
|
9809
10579
|
}
|
|
9810
10580
|
}
|
|
9811
10581
|
]
|
|
9812
10582
|
},
|
|
9813
10583
|
{
|
|
9814
10584
|
"kind": "javascript-module",
|
|
9815
|
-
"path": "src/components/
|
|
10585
|
+
"path": "src/components/layout-group-component.ts",
|
|
9816
10586
|
"declarations": [
|
|
9817
10587
|
{
|
|
9818
10588
|
"kind": "class",
|
|
9819
|
-
"description": "The LayoutGroupComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
10589
|
+
"description": "The LayoutGroupComponentElement interface provides properties and methods for manipulating\n[`<pc-layout-group>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-layout-group/) elements.\nThe LayoutGroupComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: LayoutGroupComponent (`layoutgroup`).\n",
|
|
9820
10590
|
"name": "LayoutGroupComponentElement",
|
|
9821
10591
|
"members": [
|
|
9822
10592
|
{
|
|
@@ -9859,7 +10629,7 @@
|
|
|
9859
10629
|
"type": {
|
|
9860
10630
|
"text": "EntityBaseElement | null"
|
|
9861
10631
|
},
|
|
9862
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
10632
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
9863
10633
|
"return": {
|
|
9864
10634
|
"type": {
|
|
9865
10635
|
"text": ""
|
|
@@ -10152,7 +10922,7 @@
|
|
|
10152
10922
|
"name": "ComponentElement",
|
|
10153
10923
|
"module": "/src/components/component"
|
|
10154
10924
|
},
|
|
10155
|
-
"tagName": "pc-
|
|
10925
|
+
"tagName": "pc-layout-group",
|
|
10156
10926
|
"customElement": true,
|
|
10157
10927
|
"events": [
|
|
10158
10928
|
{
|
|
@@ -10172,10 +10942,10 @@
|
|
|
10172
10942
|
"exports": [
|
|
10173
10943
|
{
|
|
10174
10944
|
"kind": "custom-element-definition",
|
|
10175
|
-
"name": "pc-
|
|
10945
|
+
"name": "pc-layout-group",
|
|
10176
10946
|
"declaration": {
|
|
10177
10947
|
"name": "LayoutGroupComponentElement",
|
|
10178
|
-
"module": "src/components/
|
|
10948
|
+
"module": "src/components/layout-group-component.ts"
|
|
10179
10949
|
}
|
|
10180
10950
|
},
|
|
10181
10951
|
{
|
|
@@ -10183,7 +10953,7 @@
|
|
|
10183
10953
|
"name": "LayoutGroupComponentElement",
|
|
10184
10954
|
"declaration": {
|
|
10185
10955
|
"name": "LayoutGroupComponentElement",
|
|
10186
|
-
"module": "src/components/
|
|
10956
|
+
"module": "src/components/layout-group-component.ts"
|
|
10187
10957
|
}
|
|
10188
10958
|
}
|
|
10189
10959
|
]
|
|
@@ -10194,7 +10964,7 @@
|
|
|
10194
10964
|
"declarations": [
|
|
10195
10965
|
{
|
|
10196
10966
|
"kind": "class",
|
|
10197
|
-
"description": "The LightComponentElement interface provides properties and methods for manipulating\n[`<pc-light>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/) elements.\nThe LightComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
10967
|
+
"description": "The LightComponentElement interface provides properties and methods for manipulating\n[`<pc-light>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/) elements.\nThe LightComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: LightComponent (`light`).\n",
|
|
10198
10968
|
"name": "LightComponentElement",
|
|
10199
10969
|
"members": [
|
|
10200
10970
|
{
|
|
@@ -10237,7 +11007,7 @@
|
|
|
10237
11007
|
"type": {
|
|
10238
11008
|
"text": "EntityBaseElement | null"
|
|
10239
11009
|
},
|
|
10240
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
11010
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
10241
11011
|
"return": {
|
|
10242
11012
|
"type": {
|
|
10243
11013
|
"text": ""
|
|
@@ -10803,179 +11573,26 @@
|
|
|
10803
11573
|
"name": "pc-light",
|
|
10804
11574
|
"declaration": {
|
|
10805
11575
|
"name": "LightComponentElement",
|
|
10806
|
-
"module": "src/components/light-component.ts"
|
|
10807
|
-
}
|
|
10808
|
-
},
|
|
10809
|
-
{
|
|
10810
|
-
"kind": "js",
|
|
10811
|
-
"name": "LightComponentElement",
|
|
10812
|
-
"declaration": {
|
|
10813
|
-
"name": "LightComponentElement",
|
|
10814
|
-
"module": "src/components/light-component.ts"
|
|
10815
|
-
}
|
|
10816
|
-
}
|
|
10817
|
-
]
|
|
10818
|
-
},
|
|
10819
|
-
{
|
|
10820
|
-
"kind": "javascript-module",
|
|
10821
|
-
"path": "src/components/listener-component.ts",
|
|
10822
|
-
"declarations": [
|
|
10823
|
-
{
|
|
10824
|
-
"kind": "class",
|
|
10825
|
-
"description": "The ListenerComponentElement interface provides properties and methods for manipulating\n[`<pc-listener>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-listener/) elements.\nThe ListenerComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
10826
|
-
"name": "ListenerComponentElement",
|
|
10827
|
-
"members": [
|
|
10828
|
-
{
|
|
10829
|
-
"kind": "field",
|
|
10830
|
-
"name": "closestApp",
|
|
10831
|
-
"type": {
|
|
10832
|
-
"text": "AppElement | null"
|
|
10833
|
-
},
|
|
10834
|
-
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
10835
|
-
"return": {
|
|
10836
|
-
"type": {
|
|
10837
|
-
"text": ""
|
|
10838
|
-
}
|
|
10839
|
-
},
|
|
10840
|
-
"readonly": true,
|
|
10841
|
-
"inheritedFrom": {
|
|
10842
|
-
"name": "AsyncElement",
|
|
10843
|
-
"module": "src/async-element.ts"
|
|
10844
|
-
}
|
|
10845
|
-
},
|
|
10846
|
-
{
|
|
10847
|
-
"kind": "field",
|
|
10848
|
-
"name": "closestEntity",
|
|
10849
|
-
"type": {
|
|
10850
|
-
"text": "EntityBaseElement | null"
|
|
10851
|
-
},
|
|
10852
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or `<pc-node>` — or\n`null` if this element has no such ancestor. The search starts at the parent, so an element\nnever resolves to itself.",
|
|
10853
|
-
"return": {
|
|
10854
|
-
"type": {
|
|
10855
|
-
"text": ""
|
|
10856
|
-
}
|
|
10857
|
-
},
|
|
10858
|
-
"readonly": true,
|
|
10859
|
-
"inheritedFrom": {
|
|
10860
|
-
"name": "AsyncElement",
|
|
10861
|
-
"module": "src/async-element.ts"
|
|
10862
|
-
}
|
|
10863
|
-
},
|
|
10864
|
-
{
|
|
10865
|
-
"kind": "field",
|
|
10866
|
-
"name": "component",
|
|
10867
|
-
"type": {
|
|
10868
|
-
"text": "Component | null"
|
|
10869
|
-
},
|
|
10870
|
-
"description": "Gets the underlying PlayCanvas audio listener component.",
|
|
10871
|
-
"return": {
|
|
10872
|
-
"type": {
|
|
10873
|
-
"text": ""
|
|
10874
|
-
}
|
|
10875
|
-
},
|
|
10876
|
-
"readonly": true,
|
|
10877
|
-
"inheritedFrom": {
|
|
10878
|
-
"name": "ComponentElement",
|
|
10879
|
-
"module": "src/components/component.ts"
|
|
10880
|
-
}
|
|
10881
|
-
},
|
|
10882
|
-
{
|
|
10883
|
-
"kind": "field",
|
|
10884
|
-
"name": "enabled",
|
|
10885
|
-
"description": "Gets the enabled state of the component.",
|
|
10886
|
-
"parameters": [
|
|
10887
|
-
{
|
|
10888
|
-
"description": "The enabled state of the component.",
|
|
10889
|
-
"name": "value"
|
|
10890
|
-
}
|
|
10891
|
-
],
|
|
10892
|
-
"return": {
|
|
10893
|
-
"type": {
|
|
10894
|
-
"text": ""
|
|
10895
|
-
}
|
|
10896
|
-
},
|
|
10897
|
-
"inheritedFrom": {
|
|
10898
|
-
"name": "ComponentElement",
|
|
10899
|
-
"module": "src/components/component.ts"
|
|
10900
|
-
}
|
|
10901
|
-
},
|
|
10902
|
-
{
|
|
10903
|
-
"kind": "method",
|
|
10904
|
-
"name": "ready",
|
|
10905
|
-
"return": {
|
|
10906
|
-
"type": {
|
|
10907
|
-
"text": ""
|
|
10908
|
-
}
|
|
10909
|
-
},
|
|
10910
|
-
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
10911
|
-
"inheritedFrom": {
|
|
10912
|
-
"name": "AsyncElement",
|
|
10913
|
-
"module": "src/async-element.ts"
|
|
10914
|
-
}
|
|
10915
|
-
}
|
|
10916
|
-
],
|
|
10917
|
-
"superclass": {
|
|
10918
|
-
"name": "ComponentElement",
|
|
10919
|
-
"module": "/src/components/component"
|
|
10920
|
-
},
|
|
10921
|
-
"tagName": "pc-listener",
|
|
10922
|
-
"customElement": true,
|
|
10923
|
-
"attributes": [
|
|
10924
|
-
{
|
|
10925
|
-
"name": "enabled",
|
|
10926
|
-
"type": {
|
|
10927
|
-
"text": "boolean"
|
|
10928
|
-
},
|
|
10929
|
-
"fieldName": "enabled",
|
|
10930
|
-
"default": "true",
|
|
10931
|
-
"description": "The enabled state of the component.",
|
|
10932
|
-
"inheritedFrom": {
|
|
10933
|
-
"name": "ComponentElement",
|
|
10934
|
-
"module": "src/components/component.ts"
|
|
10935
|
-
}
|
|
10936
|
-
}
|
|
10937
|
-
],
|
|
10938
|
-
"events": [
|
|
10939
|
-
{
|
|
10940
|
-
"name": "ready",
|
|
10941
|
-
"type": {
|
|
10942
|
-
"text": "CustomEvent"
|
|
10943
|
-
},
|
|
10944
|
-
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
10945
|
-
"inheritedFrom": {
|
|
10946
|
-
"name": "AsyncElement",
|
|
10947
|
-
"module": "src/async-element.ts"
|
|
10948
|
-
}
|
|
10949
|
-
}
|
|
10950
|
-
]
|
|
10951
|
-
}
|
|
10952
|
-
],
|
|
10953
|
-
"exports": [
|
|
10954
|
-
{
|
|
10955
|
-
"kind": "custom-element-definition",
|
|
10956
|
-
"name": "pc-listener",
|
|
10957
|
-
"declaration": {
|
|
10958
|
-
"name": "ListenerComponentElement",
|
|
10959
|
-
"module": "src/components/listener-component.ts"
|
|
11576
|
+
"module": "src/components/light-component.ts"
|
|
10960
11577
|
}
|
|
10961
11578
|
},
|
|
10962
11579
|
{
|
|
10963
11580
|
"kind": "js",
|
|
10964
|
-
"name": "
|
|
11581
|
+
"name": "LightComponentElement",
|
|
10965
11582
|
"declaration": {
|
|
10966
|
-
"name": "
|
|
10967
|
-
"module": "src/components/
|
|
11583
|
+
"name": "LightComponentElement",
|
|
11584
|
+
"module": "src/components/light-component.ts"
|
|
10968
11585
|
}
|
|
10969
11586
|
}
|
|
10970
11587
|
]
|
|
10971
11588
|
},
|
|
10972
11589
|
{
|
|
10973
11590
|
"kind": "javascript-module",
|
|
10974
|
-
"path": "src/components/
|
|
11591
|
+
"path": "src/components/particle-system-component.ts",
|
|
10975
11592
|
"declarations": [
|
|
10976
11593
|
{
|
|
10977
11594
|
"kind": "class",
|
|
10978
|
-
"description": "The ParticleSystemComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
11595
|
+
"description": "The ParticleSystemComponentElement interface provides properties and methods for manipulating\n[`<pc-particle-system>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-particle-system/) elements.\nThe ParticleSystemComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: ParticleSystemComponent (`particlesystem`).\n",
|
|
10979
11596
|
"name": "ParticleSystemComponentElement",
|
|
10980
11597
|
"members": [
|
|
10981
11598
|
{
|
|
@@ -11021,7 +11638,7 @@
|
|
|
11021
11638
|
"type": {
|
|
11022
11639
|
"text": "EntityBaseElement | null"
|
|
11023
11640
|
},
|
|
11024
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
11641
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
11025
11642
|
"return": {
|
|
11026
11643
|
"type": {
|
|
11027
11644
|
"text": ""
|
|
@@ -11133,7 +11750,7 @@
|
|
|
11133
11750
|
"name": "ComponentElement",
|
|
11134
11751
|
"module": "/src/components/component"
|
|
11135
11752
|
},
|
|
11136
|
-
"tagName": "pc-
|
|
11753
|
+
"tagName": "pc-particle-system",
|
|
11137
11754
|
"customElement": true,
|
|
11138
11755
|
"events": [
|
|
11139
11756
|
{
|
|
@@ -11153,10 +11770,10 @@
|
|
|
11153
11770
|
"exports": [
|
|
11154
11771
|
{
|
|
11155
11772
|
"kind": "custom-element-definition",
|
|
11156
|
-
"name": "pc-
|
|
11773
|
+
"name": "pc-particle-system",
|
|
11157
11774
|
"declaration": {
|
|
11158
11775
|
"name": "ParticleSystemComponentElement",
|
|
11159
|
-
"module": "src/components/
|
|
11776
|
+
"module": "src/components/particle-system-component.ts"
|
|
11160
11777
|
}
|
|
11161
11778
|
},
|
|
11162
11779
|
{
|
|
@@ -11164,7 +11781,7 @@
|
|
|
11164
11781
|
"name": "ParticleSystemComponentElement",
|
|
11165
11782
|
"declaration": {
|
|
11166
11783
|
"name": "ParticleSystemComponentElement",
|
|
11167
|
-
"module": "src/components/
|
|
11784
|
+
"module": "src/components/particle-system-component.ts"
|
|
11168
11785
|
}
|
|
11169
11786
|
}
|
|
11170
11787
|
]
|
|
@@ -11175,7 +11792,7 @@
|
|
|
11175
11792
|
"declarations": [
|
|
11176
11793
|
{
|
|
11177
11794
|
"kind": "class",
|
|
11178
|
-
"description": "The RenderComponentElement interface provides properties and methods for manipulating\n[`<pc-render>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/) elements.\nThe RenderComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThis element renders one of the engine's built-in primitives, selected with `type` (defaulting\nto `box`). It does not cover the engine's `asset` render type, since there is no way to supply\na render asset here — use `pc-model` for glTF content instead.\n",
|
|
11795
|
+
"description": "The RenderComponentElement interface provides properties and methods for manipulating\n[`<pc-render>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/) elements.\nThe RenderComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThis element renders one of the engine's built-in primitives, selected with `type` (defaulting\nto `box`). It does not cover the engine's `asset` render type, since there is no way to supply\na render asset here — use `pc-model` for glTF content instead.\n\nEngine component: RenderComponent (`render`).\n",
|
|
11179
11796
|
"name": "RenderComponentElement",
|
|
11180
11797
|
"members": [
|
|
11181
11798
|
{
|
|
@@ -11221,7 +11838,7 @@
|
|
|
11221
11838
|
"type": {
|
|
11222
11839
|
"text": "EntityBaseElement | null"
|
|
11223
11840
|
},
|
|
11224
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
11841
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
11225
11842
|
"return": {
|
|
11226
11843
|
"type": {
|
|
11227
11844
|
"text": ""
|
|
@@ -11432,11 +12049,11 @@
|
|
|
11432
12049
|
},
|
|
11433
12050
|
{
|
|
11434
12051
|
"kind": "javascript-module",
|
|
11435
|
-
"path": "src/components/
|
|
12052
|
+
"path": "src/components/rigid-body-component.ts",
|
|
11436
12053
|
"declarations": [
|
|
11437
12054
|
{
|
|
11438
12055
|
"kind": "class",
|
|
11439
|
-
"description": "The RigidBodyComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
12056
|
+
"description": "The RigidBodyComponentElement interface provides properties and methods for manipulating\n[`<pc-rigid-body>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-rigid-body/) elements.\nThe RigidBodyComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: RigidBodyComponent (`rigidbody`).\n",
|
|
11440
12057
|
"name": "RigidBodyComponentElement",
|
|
11441
12058
|
"members": [
|
|
11442
12059
|
{
|
|
@@ -11471,7 +12088,7 @@
|
|
|
11471
12088
|
"type": {
|
|
11472
12089
|
"text": "EntityBaseElement | null"
|
|
11473
12090
|
},
|
|
11474
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12091
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
11475
12092
|
"return": {
|
|
11476
12093
|
"type": {
|
|
11477
12094
|
"text": ""
|
|
@@ -11657,7 +12274,7 @@
|
|
|
11657
12274
|
"name": "ComponentElement",
|
|
11658
12275
|
"module": "/src/components/component"
|
|
11659
12276
|
},
|
|
11660
|
-
"tagName": "pc-
|
|
12277
|
+
"tagName": "pc-rigid-body",
|
|
11661
12278
|
"customElement": true,
|
|
11662
12279
|
"events": [
|
|
11663
12280
|
{
|
|
@@ -11677,10 +12294,10 @@
|
|
|
11677
12294
|
"exports": [
|
|
11678
12295
|
{
|
|
11679
12296
|
"kind": "custom-element-definition",
|
|
11680
|
-
"name": "pc-
|
|
12297
|
+
"name": "pc-rigid-body",
|
|
11681
12298
|
"declaration": {
|
|
11682
12299
|
"name": "RigidBodyComponentElement",
|
|
11683
|
-
"module": "src/components/
|
|
12300
|
+
"module": "src/components/rigid-body-component.ts"
|
|
11684
12301
|
}
|
|
11685
12302
|
},
|
|
11686
12303
|
{
|
|
@@ -11688,7 +12305,7 @@
|
|
|
11688
12305
|
"name": "RigidBodyComponentElement",
|
|
11689
12306
|
"declaration": {
|
|
11690
12307
|
"name": "RigidBodyComponentElement",
|
|
11691
|
-
"module": "src/components/
|
|
12308
|
+
"module": "src/components/rigid-body-component.ts"
|
|
11692
12309
|
}
|
|
11693
12310
|
}
|
|
11694
12311
|
]
|
|
@@ -11699,7 +12316,7 @@
|
|
|
11699
12316
|
"declarations": [
|
|
11700
12317
|
{
|
|
11701
12318
|
"kind": "class",
|
|
11702
|
-
"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",
|
|
12319
|
+
"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\nEngine component: ScreenComponent (`screen`).\n",
|
|
11703
12320
|
"name": "ScreenComponentElement",
|
|
11704
12321
|
"members": [
|
|
11705
12322
|
{
|
|
@@ -11726,7 +12343,7 @@
|
|
|
11726
12343
|
"type": {
|
|
11727
12344
|
"text": "EntityBaseElement | null"
|
|
11728
12345
|
},
|
|
11729
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12346
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
11730
12347
|
"return": {
|
|
11731
12348
|
"type": {
|
|
11732
12349
|
"text": ""
|
|
@@ -11952,7 +12569,7 @@
|
|
|
11952
12569
|
"declarations": [
|
|
11953
12570
|
{
|
|
11954
12571
|
"kind": "class",
|
|
11955
|
-
"description": "The ScriptComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
12572
|
+
"description": "The ScriptComponentElement interface provides properties and methods for manipulating\n[`<pc-script>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-script/) elements.\nThe ScriptComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: ScriptComponent (`script`).\n",
|
|
11956
12573
|
"name": "ScriptComponentElement",
|
|
11957
12574
|
"members": [
|
|
11958
12575
|
{
|
|
@@ -11979,7 +12596,7 @@
|
|
|
11979
12596
|
"type": {
|
|
11980
12597
|
"text": "EntityBaseElement | null"
|
|
11981
12598
|
},
|
|
11982
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12599
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
11983
12600
|
"return": {
|
|
11984
12601
|
"type": {
|
|
11985
12602
|
"text": ""
|
|
@@ -12048,7 +12665,7 @@
|
|
|
12048
12665
|
"name": "ComponentElement",
|
|
12049
12666
|
"module": "/src/components/component"
|
|
12050
12667
|
},
|
|
12051
|
-
"tagName": "pc-
|
|
12668
|
+
"tagName": "pc-script",
|
|
12052
12669
|
"customElement": true,
|
|
12053
12670
|
"attributes": [
|
|
12054
12671
|
{
|
|
@@ -12083,7 +12700,7 @@
|
|
|
12083
12700
|
"exports": [
|
|
12084
12701
|
{
|
|
12085
12702
|
"kind": "custom-element-definition",
|
|
12086
|
-
"name": "pc-
|
|
12703
|
+
"name": "pc-script",
|
|
12087
12704
|
"declaration": {
|
|
12088
12705
|
"name": "ScriptComponentElement",
|
|
12089
12706
|
"module": "src/components/script-component.ts"
|
|
@@ -12101,12 +12718,12 @@
|
|
|
12101
12718
|
},
|
|
12102
12719
|
{
|
|
12103
12720
|
"kind": "javascript-module",
|
|
12104
|
-
"path": "src/components/script.ts",
|
|
12721
|
+
"path": "src/components/script-instance.ts",
|
|
12105
12722
|
"declarations": [
|
|
12106
12723
|
{
|
|
12107
12724
|
"kind": "class",
|
|
12108
|
-
"description": "The
|
|
12109
|
-
"name": "
|
|
12725
|
+
"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",
|
|
12726
|
+
"name": "ScriptInstanceElement",
|
|
12110
12727
|
"members": [
|
|
12111
12728
|
{
|
|
12112
12729
|
"kind": "field",
|
|
@@ -12132,7 +12749,7 @@
|
|
|
12132
12749
|
"type": {
|
|
12133
12750
|
"text": "EntityBaseElement | null"
|
|
12134
12751
|
},
|
|
12135
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12752
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
12136
12753
|
"return": {
|
|
12137
12754
|
"type": {
|
|
12138
12755
|
"text": ""
|
|
@@ -12289,288 +12906,36 @@
|
|
|
12289
12906
|
"name": "AsyncElement",
|
|
12290
12907
|
"module": "/src/async-element"
|
|
12291
12908
|
},
|
|
12292
|
-
"tagName": "pc-script",
|
|
12909
|
+
"tagName": "pc-script-instance",
|
|
12293
12910
|
"customElement": true
|
|
12294
12911
|
}
|
|
12295
12912
|
],
|
|
12296
12913
|
"exports": [
|
|
12297
12914
|
{
|
|
12298
12915
|
"kind": "custom-element-definition",
|
|
12299
|
-
"name": "pc-script",
|
|
12300
|
-
"declaration": {
|
|
12301
|
-
"name": "ScriptElement",
|
|
12302
|
-
"module": "src/components/script.ts"
|
|
12303
|
-
}
|
|
12304
|
-
},
|
|
12305
|
-
{
|
|
12306
|
-
"kind": "js",
|
|
12307
|
-
"name": "ScriptElement",
|
|
12308
|
-
"declaration": {
|
|
12309
|
-
"name": "ScriptElement",
|
|
12310
|
-
"module": "src/components/script.ts"
|
|
12311
|
-
}
|
|
12312
|
-
}
|
|
12313
|
-
]
|
|
12314
|
-
},
|
|
12315
|
-
{
|
|
12316
|
-
"kind": "javascript-module",
|
|
12317
|
-
"path": "src/components/scrollbar-component.ts",
|
|
12318
|
-
"declarations": [
|
|
12319
|
-
{
|
|
12320
|
-
"kind": "class",
|
|
12321
|
-
"description": "The ScrollbarComponentElement interface provides properties and methods for manipulating\n[`<pc-scrollbar>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/) elements.\nThe ScrollbarComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
12322
|
-
"name": "ScrollbarComponentElement",
|
|
12323
|
-
"members": [
|
|
12324
|
-
{
|
|
12325
|
-
"kind": "field",
|
|
12326
|
-
"name": "closestApp",
|
|
12327
|
-
"type": {
|
|
12328
|
-
"text": "AppElement | null"
|
|
12329
|
-
},
|
|
12330
|
-
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
12331
|
-
"return": {
|
|
12332
|
-
"type": {
|
|
12333
|
-
"text": ""
|
|
12334
|
-
}
|
|
12335
|
-
},
|
|
12336
|
-
"readonly": true,
|
|
12337
|
-
"inheritedFrom": {
|
|
12338
|
-
"name": "AsyncElement",
|
|
12339
|
-
"module": "src/async-element.ts"
|
|
12340
|
-
}
|
|
12341
|
-
},
|
|
12342
|
-
{
|
|
12343
|
-
"kind": "field",
|
|
12344
|
-
"name": "closestEntity",
|
|
12345
|
-
"type": {
|
|
12346
|
-
"text": "EntityBaseElement | null"
|
|
12347
|
-
},
|
|
12348
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or `<pc-node>` — or\n`null` if this element has no such ancestor. The search starts at the parent, so an element\nnever resolves to itself.",
|
|
12349
|
-
"return": {
|
|
12350
|
-
"type": {
|
|
12351
|
-
"text": ""
|
|
12352
|
-
}
|
|
12353
|
-
},
|
|
12354
|
-
"readonly": true,
|
|
12355
|
-
"inheritedFrom": {
|
|
12356
|
-
"name": "AsyncElement",
|
|
12357
|
-
"module": "src/async-element.ts"
|
|
12358
|
-
}
|
|
12359
|
-
},
|
|
12360
|
-
{
|
|
12361
|
-
"kind": "field",
|
|
12362
|
-
"name": "component",
|
|
12363
|
-
"type": {
|
|
12364
|
-
"text": "Component | null"
|
|
12365
|
-
},
|
|
12366
|
-
"description": "Gets the underlying PlayCanvas scrollbar component.",
|
|
12367
|
-
"return": {
|
|
12368
|
-
"type": {
|
|
12369
|
-
"text": ""
|
|
12370
|
-
}
|
|
12371
|
-
},
|
|
12372
|
-
"readonly": true,
|
|
12373
|
-
"inheritedFrom": {
|
|
12374
|
-
"name": "ComponentElement",
|
|
12375
|
-
"module": "src/components/component.ts"
|
|
12376
|
-
}
|
|
12377
|
-
},
|
|
12378
|
-
{
|
|
12379
|
-
"kind": "field",
|
|
12380
|
-
"name": "enabled",
|
|
12381
|
-
"description": "Gets the enabled state of the component.",
|
|
12382
|
-
"parameters": [
|
|
12383
|
-
{
|
|
12384
|
-
"description": "The enabled state of the component.",
|
|
12385
|
-
"name": "value"
|
|
12386
|
-
}
|
|
12387
|
-
],
|
|
12388
|
-
"return": {
|
|
12389
|
-
"type": {
|
|
12390
|
-
"text": ""
|
|
12391
|
-
}
|
|
12392
|
-
},
|
|
12393
|
-
"inheritedFrom": {
|
|
12394
|
-
"name": "ComponentElement",
|
|
12395
|
-
"module": "src/components/component.ts"
|
|
12396
|
-
}
|
|
12397
|
-
},
|
|
12398
|
-
{
|
|
12399
|
-
"kind": "field",
|
|
12400
|
-
"name": "handle",
|
|
12401
|
-
"description": "Gets the reference to the `<pc-entity>` used as the scrollbar handle.",
|
|
12402
|
-
"parameters": [
|
|
12403
|
-
{
|
|
12404
|
-
"description": "The handle entity reference.",
|
|
12405
|
-
"name": "value"
|
|
12406
|
-
}
|
|
12407
|
-
],
|
|
12408
|
-
"return": {
|
|
12409
|
-
"type": {
|
|
12410
|
-
"text": ""
|
|
12411
|
-
}
|
|
12412
|
-
}
|
|
12413
|
-
},
|
|
12414
|
-
{
|
|
12415
|
-
"kind": "field",
|
|
12416
|
-
"name": "handleSize",
|
|
12417
|
-
"description": "Gets the size of the handle relative to the size of the track.",
|
|
12418
|
-
"parameters": [
|
|
12419
|
-
{
|
|
12420
|
-
"description": "The handle size.",
|
|
12421
|
-
"name": "value"
|
|
12422
|
-
}
|
|
12423
|
-
],
|
|
12424
|
-
"return": {
|
|
12425
|
-
"type": {
|
|
12426
|
-
"text": ""
|
|
12427
|
-
}
|
|
12428
|
-
}
|
|
12429
|
-
},
|
|
12430
|
-
{
|
|
12431
|
-
"kind": "field",
|
|
12432
|
-
"name": "orientation",
|
|
12433
|
-
"description": "Gets the orientation of the scrollbar.",
|
|
12434
|
-
"parameters": [
|
|
12435
|
-
{
|
|
12436
|
-
"description": "The orientation.",
|
|
12437
|
-
"name": "value"
|
|
12438
|
-
}
|
|
12439
|
-
],
|
|
12440
|
-
"return": {
|
|
12441
|
-
"type": {
|
|
12442
|
-
"text": ""
|
|
12443
|
-
}
|
|
12444
|
-
}
|
|
12445
|
-
},
|
|
12446
|
-
{
|
|
12447
|
-
"kind": "method",
|
|
12448
|
-
"name": "ready",
|
|
12449
|
-
"return": {
|
|
12450
|
-
"type": {
|
|
12451
|
-
"text": ""
|
|
12452
|
-
}
|
|
12453
|
-
},
|
|
12454
|
-
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
12455
|
-
"inheritedFrom": {
|
|
12456
|
-
"name": "AsyncElement",
|
|
12457
|
-
"module": "src/async-element.ts"
|
|
12458
|
-
}
|
|
12459
|
-
},
|
|
12460
|
-
{
|
|
12461
|
-
"kind": "field",
|
|
12462
|
-
"name": "value",
|
|
12463
|
-
"description": "Gets the current position value of the scrollbar.",
|
|
12464
|
-
"parameters": [
|
|
12465
|
-
{
|
|
12466
|
-
"description": "The scrollbar value.",
|
|
12467
|
-
"name": "value"
|
|
12468
|
-
}
|
|
12469
|
-
],
|
|
12470
|
-
"return": {
|
|
12471
|
-
"type": {
|
|
12472
|
-
"text": ""
|
|
12473
|
-
}
|
|
12474
|
-
}
|
|
12475
|
-
}
|
|
12476
|
-
],
|
|
12477
|
-
"attributes": [
|
|
12478
|
-
{
|
|
12479
|
-
"name": "enabled",
|
|
12480
|
-
"type": {
|
|
12481
|
-
"text": "boolean"
|
|
12482
|
-
},
|
|
12483
|
-
"fieldName": "enabled",
|
|
12484
|
-
"default": "true",
|
|
12485
|
-
"description": "The enabled state of the component.",
|
|
12486
|
-
"inheritedFrom": {
|
|
12487
|
-
"name": "ComponentElement",
|
|
12488
|
-
"module": "src/components/component.ts"
|
|
12489
|
-
}
|
|
12490
|
-
},
|
|
12491
|
-
{
|
|
12492
|
-
"name": "handle",
|
|
12493
|
-
"type": {
|
|
12494
|
-
"text": "string"
|
|
12495
|
-
},
|
|
12496
|
-
"fieldName": "handle",
|
|
12497
|
-
"description": "The reference to the `<pc-entity>` used as the scrollbar handle."
|
|
12498
|
-
},
|
|
12499
|
-
{
|
|
12500
|
-
"name": "handle-size",
|
|
12501
|
-
"type": {
|
|
12502
|
-
"text": "number"
|
|
12503
|
-
},
|
|
12504
|
-
"fieldName": "handleSize",
|
|
12505
|
-
"default": "0.5",
|
|
12506
|
-
"description": "The size of the handle relative to the size of the track."
|
|
12507
|
-
},
|
|
12508
|
-
{
|
|
12509
|
-
"name": "orientation",
|
|
12510
|
-
"type": {
|
|
12511
|
-
"text": "'horizontal' | 'vertical'"
|
|
12512
|
-
},
|
|
12513
|
-
"fieldName": "orientation",
|
|
12514
|
-
"default": "horizontal",
|
|
12515
|
-
"description": "The orientation of the scrollbar."
|
|
12516
|
-
},
|
|
12517
|
-
{
|
|
12518
|
-
"name": "value",
|
|
12519
|
-
"type": {
|
|
12520
|
-
"text": "number"
|
|
12521
|
-
},
|
|
12522
|
-
"fieldName": "value",
|
|
12523
|
-
"default": "0",
|
|
12524
|
-
"description": "The current position value of the scrollbar."
|
|
12525
|
-
}
|
|
12526
|
-
],
|
|
12527
|
-
"superclass": {
|
|
12528
|
-
"name": "ComponentElement",
|
|
12529
|
-
"module": "/src/components/component"
|
|
12530
|
-
},
|
|
12531
|
-
"tagName": "pc-scrollbar",
|
|
12532
|
-
"customElement": true,
|
|
12533
|
-
"events": [
|
|
12534
|
-
{
|
|
12535
|
-
"name": "ready",
|
|
12536
|
-
"type": {
|
|
12537
|
-
"text": "CustomEvent"
|
|
12538
|
-
},
|
|
12539
|
-
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
12540
|
-
"inheritedFrom": {
|
|
12541
|
-
"name": "AsyncElement",
|
|
12542
|
-
"module": "src/async-element.ts"
|
|
12543
|
-
}
|
|
12544
|
-
}
|
|
12545
|
-
]
|
|
12546
|
-
}
|
|
12547
|
-
],
|
|
12548
|
-
"exports": [
|
|
12549
|
-
{
|
|
12550
|
-
"kind": "custom-element-definition",
|
|
12551
|
-
"name": "pc-scrollbar",
|
|
12916
|
+
"name": "pc-script-instance",
|
|
12552
12917
|
"declaration": {
|
|
12553
|
-
"name": "
|
|
12554
|
-
"module": "src/components/
|
|
12918
|
+
"name": "ScriptInstanceElement",
|
|
12919
|
+
"module": "src/components/script-instance.ts"
|
|
12555
12920
|
}
|
|
12556
12921
|
},
|
|
12557
12922
|
{
|
|
12558
12923
|
"kind": "js",
|
|
12559
|
-
"name": "
|
|
12924
|
+
"name": "ScriptInstanceElement",
|
|
12560
12925
|
"declaration": {
|
|
12561
|
-
"name": "
|
|
12562
|
-
"module": "src/components/
|
|
12926
|
+
"name": "ScriptInstanceElement",
|
|
12927
|
+
"module": "src/components/script-instance.ts"
|
|
12563
12928
|
}
|
|
12564
12929
|
}
|
|
12565
12930
|
]
|
|
12566
12931
|
},
|
|
12567
12932
|
{
|
|
12568
12933
|
"kind": "javascript-module",
|
|
12569
|
-
"path": "src/components/
|
|
12934
|
+
"path": "src/components/scroll-view-component.ts",
|
|
12570
12935
|
"declarations": [
|
|
12571
12936
|
{
|
|
12572
12937
|
"kind": "class",
|
|
12573
|
-
"description": "The ScrollViewComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
12938
|
+
"description": "The ScrollViewComponentElement interface provides properties and methods for manipulating\n[`<pc-scroll-view>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scroll-view/) elements.\nThe ScrollViewComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: ScrollViewComponent (`scrollview`).\n",
|
|
12574
12939
|
"name": "ScrollViewComponentElement",
|
|
12575
12940
|
"members": [
|
|
12576
12941
|
{
|
|
@@ -12613,7 +12978,7 @@
|
|
|
12613
12978
|
"type": {
|
|
12614
12979
|
"text": "EntityBaseElement | null"
|
|
12615
12980
|
},
|
|
12616
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12981
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
12617
12982
|
"return": {
|
|
12618
12983
|
"type": {
|
|
12619
12984
|
"text": ""
|
|
@@ -13002,7 +13367,7 @@
|
|
|
13002
13367
|
"name": "ComponentElement",
|
|
13003
13368
|
"module": "/src/components/component"
|
|
13004
13369
|
},
|
|
13005
|
-
"tagName": "pc-
|
|
13370
|
+
"tagName": "pc-scroll-view",
|
|
13006
13371
|
"customElement": true,
|
|
13007
13372
|
"events": [
|
|
13008
13373
|
{
|
|
@@ -13022,10 +13387,10 @@
|
|
|
13022
13387
|
"exports": [
|
|
13023
13388
|
{
|
|
13024
13389
|
"kind": "custom-element-definition",
|
|
13025
|
-
"name": "pc-
|
|
13390
|
+
"name": "pc-scroll-view",
|
|
13026
13391
|
"declaration": {
|
|
13027
13392
|
"name": "ScrollViewComponentElement",
|
|
13028
|
-
"module": "src/components/
|
|
13393
|
+
"module": "src/components/scroll-view-component.ts"
|
|
13029
13394
|
}
|
|
13030
13395
|
},
|
|
13031
13396
|
{
|
|
@@ -13033,7 +13398,259 @@
|
|
|
13033
13398
|
"name": "ScrollViewComponentElement",
|
|
13034
13399
|
"declaration": {
|
|
13035
13400
|
"name": "ScrollViewComponentElement",
|
|
13036
|
-
"module": "src/components/
|
|
13401
|
+
"module": "src/components/scroll-view-component.ts"
|
|
13402
|
+
}
|
|
13403
|
+
}
|
|
13404
|
+
]
|
|
13405
|
+
},
|
|
13406
|
+
{
|
|
13407
|
+
"kind": "javascript-module",
|
|
13408
|
+
"path": "src/components/scrollbar-component.ts",
|
|
13409
|
+
"declarations": [
|
|
13410
|
+
{
|
|
13411
|
+
"kind": "class",
|
|
13412
|
+
"description": "The ScrollbarComponentElement interface provides properties and methods for manipulating\n[`<pc-scrollbar>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/) elements.\nThe ScrollbarComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: ScrollbarComponent (`scrollbar`).\n",
|
|
13413
|
+
"name": "ScrollbarComponentElement",
|
|
13414
|
+
"members": [
|
|
13415
|
+
{
|
|
13416
|
+
"kind": "field",
|
|
13417
|
+
"name": "closestApp",
|
|
13418
|
+
"type": {
|
|
13419
|
+
"text": "AppElement | null"
|
|
13420
|
+
},
|
|
13421
|
+
"description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
13422
|
+
"return": {
|
|
13423
|
+
"type": {
|
|
13424
|
+
"text": ""
|
|
13425
|
+
}
|
|
13426
|
+
},
|
|
13427
|
+
"readonly": true,
|
|
13428
|
+
"inheritedFrom": {
|
|
13429
|
+
"name": "AsyncElement",
|
|
13430
|
+
"module": "src/async-element.ts"
|
|
13431
|
+
}
|
|
13432
|
+
},
|
|
13433
|
+
{
|
|
13434
|
+
"kind": "field",
|
|
13435
|
+
"name": "closestEntity",
|
|
13436
|
+
"type": {
|
|
13437
|
+
"text": "EntityBaseElement | null"
|
|
13438
|
+
},
|
|
13439
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
13440
|
+
"return": {
|
|
13441
|
+
"type": {
|
|
13442
|
+
"text": ""
|
|
13443
|
+
}
|
|
13444
|
+
},
|
|
13445
|
+
"readonly": true,
|
|
13446
|
+
"inheritedFrom": {
|
|
13447
|
+
"name": "AsyncElement",
|
|
13448
|
+
"module": "src/async-element.ts"
|
|
13449
|
+
}
|
|
13450
|
+
},
|
|
13451
|
+
{
|
|
13452
|
+
"kind": "field",
|
|
13453
|
+
"name": "component",
|
|
13454
|
+
"type": {
|
|
13455
|
+
"text": "Component | null"
|
|
13456
|
+
},
|
|
13457
|
+
"description": "Gets the underlying PlayCanvas scrollbar component.",
|
|
13458
|
+
"return": {
|
|
13459
|
+
"type": {
|
|
13460
|
+
"text": ""
|
|
13461
|
+
}
|
|
13462
|
+
},
|
|
13463
|
+
"readonly": true,
|
|
13464
|
+
"inheritedFrom": {
|
|
13465
|
+
"name": "ComponentElement",
|
|
13466
|
+
"module": "src/components/component.ts"
|
|
13467
|
+
}
|
|
13468
|
+
},
|
|
13469
|
+
{
|
|
13470
|
+
"kind": "field",
|
|
13471
|
+
"name": "enabled",
|
|
13472
|
+
"description": "Gets the enabled state of the component.",
|
|
13473
|
+
"parameters": [
|
|
13474
|
+
{
|
|
13475
|
+
"description": "The enabled state of the component.",
|
|
13476
|
+
"name": "value"
|
|
13477
|
+
}
|
|
13478
|
+
],
|
|
13479
|
+
"return": {
|
|
13480
|
+
"type": {
|
|
13481
|
+
"text": ""
|
|
13482
|
+
}
|
|
13483
|
+
},
|
|
13484
|
+
"inheritedFrom": {
|
|
13485
|
+
"name": "ComponentElement",
|
|
13486
|
+
"module": "src/components/component.ts"
|
|
13487
|
+
}
|
|
13488
|
+
},
|
|
13489
|
+
{
|
|
13490
|
+
"kind": "field",
|
|
13491
|
+
"name": "handle",
|
|
13492
|
+
"description": "Gets the reference to the `<pc-entity>` used as the scrollbar handle.",
|
|
13493
|
+
"parameters": [
|
|
13494
|
+
{
|
|
13495
|
+
"description": "The handle entity reference.",
|
|
13496
|
+
"name": "value"
|
|
13497
|
+
}
|
|
13498
|
+
],
|
|
13499
|
+
"return": {
|
|
13500
|
+
"type": {
|
|
13501
|
+
"text": ""
|
|
13502
|
+
}
|
|
13503
|
+
}
|
|
13504
|
+
},
|
|
13505
|
+
{
|
|
13506
|
+
"kind": "field",
|
|
13507
|
+
"name": "handleSize",
|
|
13508
|
+
"description": "Gets the size of the handle relative to the size of the track.",
|
|
13509
|
+
"parameters": [
|
|
13510
|
+
{
|
|
13511
|
+
"description": "The handle size.",
|
|
13512
|
+
"name": "value"
|
|
13513
|
+
}
|
|
13514
|
+
],
|
|
13515
|
+
"return": {
|
|
13516
|
+
"type": {
|
|
13517
|
+
"text": ""
|
|
13518
|
+
}
|
|
13519
|
+
}
|
|
13520
|
+
},
|
|
13521
|
+
{
|
|
13522
|
+
"kind": "field",
|
|
13523
|
+
"name": "orientation",
|
|
13524
|
+
"description": "Gets the orientation of the scrollbar.",
|
|
13525
|
+
"parameters": [
|
|
13526
|
+
{
|
|
13527
|
+
"description": "The orientation.",
|
|
13528
|
+
"name": "value"
|
|
13529
|
+
}
|
|
13530
|
+
],
|
|
13531
|
+
"return": {
|
|
13532
|
+
"type": {
|
|
13533
|
+
"text": ""
|
|
13534
|
+
}
|
|
13535
|
+
}
|
|
13536
|
+
},
|
|
13537
|
+
{
|
|
13538
|
+
"kind": "method",
|
|
13539
|
+
"name": "ready",
|
|
13540
|
+
"return": {
|
|
13541
|
+
"type": {
|
|
13542
|
+
"text": ""
|
|
13543
|
+
}
|
|
13544
|
+
},
|
|
13545
|
+
"description": "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.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
|
|
13546
|
+
"inheritedFrom": {
|
|
13547
|
+
"name": "AsyncElement",
|
|
13548
|
+
"module": "src/async-element.ts"
|
|
13549
|
+
}
|
|
13550
|
+
},
|
|
13551
|
+
{
|
|
13552
|
+
"kind": "field",
|
|
13553
|
+
"name": "value",
|
|
13554
|
+
"description": "Gets the current position value of the scrollbar.",
|
|
13555
|
+
"parameters": [
|
|
13556
|
+
{
|
|
13557
|
+
"description": "The scrollbar value.",
|
|
13558
|
+
"name": "value"
|
|
13559
|
+
}
|
|
13560
|
+
],
|
|
13561
|
+
"return": {
|
|
13562
|
+
"type": {
|
|
13563
|
+
"text": ""
|
|
13564
|
+
}
|
|
13565
|
+
}
|
|
13566
|
+
}
|
|
13567
|
+
],
|
|
13568
|
+
"attributes": [
|
|
13569
|
+
{
|
|
13570
|
+
"name": "enabled",
|
|
13571
|
+
"type": {
|
|
13572
|
+
"text": "boolean"
|
|
13573
|
+
},
|
|
13574
|
+
"fieldName": "enabled",
|
|
13575
|
+
"default": "true",
|
|
13576
|
+
"description": "The enabled state of the component.",
|
|
13577
|
+
"inheritedFrom": {
|
|
13578
|
+
"name": "ComponentElement",
|
|
13579
|
+
"module": "src/components/component.ts"
|
|
13580
|
+
}
|
|
13581
|
+
},
|
|
13582
|
+
{
|
|
13583
|
+
"name": "handle",
|
|
13584
|
+
"type": {
|
|
13585
|
+
"text": "string"
|
|
13586
|
+
},
|
|
13587
|
+
"fieldName": "handle",
|
|
13588
|
+
"description": "The reference to the `<pc-entity>` used as the scrollbar handle."
|
|
13589
|
+
},
|
|
13590
|
+
{
|
|
13591
|
+
"name": "handle-size",
|
|
13592
|
+
"type": {
|
|
13593
|
+
"text": "number"
|
|
13594
|
+
},
|
|
13595
|
+
"fieldName": "handleSize",
|
|
13596
|
+
"default": "0.5",
|
|
13597
|
+
"description": "The size of the handle relative to the size of the track."
|
|
13598
|
+
},
|
|
13599
|
+
{
|
|
13600
|
+
"name": "orientation",
|
|
13601
|
+
"type": {
|
|
13602
|
+
"text": "'horizontal' | 'vertical'"
|
|
13603
|
+
},
|
|
13604
|
+
"fieldName": "orientation",
|
|
13605
|
+
"default": "horizontal",
|
|
13606
|
+
"description": "The orientation of the scrollbar."
|
|
13607
|
+
},
|
|
13608
|
+
{
|
|
13609
|
+
"name": "value",
|
|
13610
|
+
"type": {
|
|
13611
|
+
"text": "number"
|
|
13612
|
+
},
|
|
13613
|
+
"fieldName": "value",
|
|
13614
|
+
"default": "0",
|
|
13615
|
+
"description": "The current position value of the scrollbar."
|
|
13616
|
+
}
|
|
13617
|
+
],
|
|
13618
|
+
"superclass": {
|
|
13619
|
+
"name": "ComponentElement",
|
|
13620
|
+
"module": "/src/components/component"
|
|
13621
|
+
},
|
|
13622
|
+
"tagName": "pc-scrollbar",
|
|
13623
|
+
"customElement": true,
|
|
13624
|
+
"events": [
|
|
13625
|
+
{
|
|
13626
|
+
"name": "ready",
|
|
13627
|
+
"type": {
|
|
13628
|
+
"text": "CustomEvent"
|
|
13629
|
+
},
|
|
13630
|
+
"description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
|
|
13631
|
+
"inheritedFrom": {
|
|
13632
|
+
"name": "AsyncElement",
|
|
13633
|
+
"module": "src/async-element.ts"
|
|
13634
|
+
}
|
|
13635
|
+
}
|
|
13636
|
+
]
|
|
13637
|
+
}
|
|
13638
|
+
],
|
|
13639
|
+
"exports": [
|
|
13640
|
+
{
|
|
13641
|
+
"kind": "custom-element-definition",
|
|
13642
|
+
"name": "pc-scrollbar",
|
|
13643
|
+
"declaration": {
|
|
13644
|
+
"name": "ScrollbarComponentElement",
|
|
13645
|
+
"module": "src/components/scrollbar-component.ts"
|
|
13646
|
+
}
|
|
13647
|
+
},
|
|
13648
|
+
{
|
|
13649
|
+
"kind": "js",
|
|
13650
|
+
"name": "ScrollbarComponentElement",
|
|
13651
|
+
"declaration": {
|
|
13652
|
+
"name": "ScrollbarComponentElement",
|
|
13653
|
+
"module": "src/components/scrollbar-component.ts"
|
|
13037
13654
|
}
|
|
13038
13655
|
}
|
|
13039
13656
|
]
|
|
@@ -13044,7 +13661,7 @@
|
|
|
13044
13661
|
"declarations": [
|
|
13045
13662
|
{
|
|
13046
13663
|
"kind": "class",
|
|
13047
|
-
"description": "The SoundComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
13664
|
+
"description": "The SoundComponentElement interface provides properties and methods for manipulating\n[`<pc-sound>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-sound/) elements.\nThe SoundComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nEngine component: SoundComponent (`sound`).\n",
|
|
13048
13665
|
"name": "SoundComponentElement",
|
|
13049
13666
|
"members": [
|
|
13050
13667
|
{
|
|
@@ -13071,7 +13688,7 @@
|
|
|
13071
13688
|
"type": {
|
|
13072
13689
|
"text": "EntityBaseElement | null"
|
|
13073
13690
|
},
|
|
13074
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
13691
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
13075
13692
|
"return": {
|
|
13076
13693
|
"type": {
|
|
13077
13694
|
"text": ""
|
|
@@ -13333,7 +13950,7 @@
|
|
|
13333
13950
|
"name": "ComponentElement",
|
|
13334
13951
|
"module": "/src/components/component"
|
|
13335
13952
|
},
|
|
13336
|
-
"tagName": "pc-
|
|
13953
|
+
"tagName": "pc-sound",
|
|
13337
13954
|
"customElement": true,
|
|
13338
13955
|
"events": [
|
|
13339
13956
|
{
|
|
@@ -13353,7 +13970,7 @@
|
|
|
13353
13970
|
"exports": [
|
|
13354
13971
|
{
|
|
13355
13972
|
"kind": "custom-element-definition",
|
|
13356
|
-
"name": "pc-
|
|
13973
|
+
"name": "pc-sound",
|
|
13357
13974
|
"declaration": {
|
|
13358
13975
|
"name": "SoundComponentElement",
|
|
13359
13976
|
"module": "src/components/sound-component.ts"
|
|
@@ -13375,7 +13992,7 @@
|
|
|
13375
13992
|
"declarations": [
|
|
13376
13993
|
{
|
|
13377
13994
|
"kind": "class",
|
|
13378
|
-
"description": "The SoundSlotElement interface provides properties and methods for manipulating\n`<pc-sound>` elements. The SoundSlotElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n",
|
|
13995
|
+
"description": "The SoundSlotElement interface provides properties and methods for manipulating\n`<pc-sound-slot>` elements. The SoundSlotElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n",
|
|
13379
13996
|
"name": "SoundSlotElement",
|
|
13380
13997
|
"members": [
|
|
13381
13998
|
{
|
|
@@ -13434,7 +14051,7 @@
|
|
|
13434
14051
|
"type": {
|
|
13435
14052
|
"text": "EntityBaseElement | null"
|
|
13436
14053
|
},
|
|
13437
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
14054
|
+
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>`, `<pc-model>` or\n`<pc-node>` — or `null` if this element has no such ancestor. The search starts at the\nparent, so an element never resolves to itself.",
|
|
13438
14055
|
"return": {
|
|
13439
14056
|
"type": {
|
|
13440
14057
|
"text": ""
|
|
@@ -13669,7 +14286,7 @@
|
|
|
13669
14286
|
"name": "AsyncElement",
|
|
13670
14287
|
"module": "/src/async-element"
|
|
13671
14288
|
},
|
|
13672
|
-
"tagName": "pc-sound",
|
|
14289
|
+
"tagName": "pc-sound-slot",
|
|
13673
14290
|
"customElement": true,
|
|
13674
14291
|
"events": [
|
|
13675
14292
|
{
|
|
@@ -13689,7 +14306,7 @@
|
|
|
13689
14306
|
"exports": [
|
|
13690
14307
|
{
|
|
13691
14308
|
"kind": "custom-element-definition",
|
|
13692
|
-
"name": "pc-sound",
|
|
14309
|
+
"name": "pc-sound-slot",
|
|
13693
14310
|
"declaration": {
|
|
13694
14311
|
"name": "SoundSlotElement",
|
|
13695
14312
|
"module": "src/components/sound-slot.ts"
|