@playcanvas/web-components 0.16.0 → 0.18.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/README.md +5 -3
- package/dist/app.d.cts +18 -13
- package/dist/app.d.ts +18 -13
- package/dist/asset.d.cts +13 -3
- package/dist/asset.d.ts +13 -3
- package/dist/async-element.d.cts +13 -13
- package/dist/async-element.d.ts +13 -13
- package/dist/components/anim-clip.d.cts +4 -0
- package/dist/components/anim-clip.d.ts +4 -0
- package/dist/components/anim-component.d.cts +38 -5
- package/dist/components/anim-component.d.ts +38 -5
- package/dist/components/audio-listener-component.d.cts +26 -0
- package/dist/components/audio-listener-component.d.ts +26 -0
- package/dist/components/button-component.d.cts +10 -1
- package/dist/components/button-component.d.ts +10 -1
- package/dist/components/camera-component.d.cts +37 -1
- package/dist/components/camera-component.d.ts +37 -1
- package/dist/components/collision-component.d.cts +9 -1
- package/dist/components/collision-component.d.ts +9 -1
- package/dist/components/component.d.cts +3 -2
- package/dist/components/component.d.ts +3 -2
- package/dist/components/element-component.d.cts +11 -0
- package/dist/components/element-component.d.ts +11 -0
- package/dist/components/gsplat-component.d.cts +6 -0
- package/dist/components/gsplat-component.d.ts +6 -0
- package/dist/components/joint-component.d.cts +14 -2
- package/dist/components/joint-component.d.ts +14 -2
- package/dist/components/{layoutchild-component.d.cts → layout-child-component.d.cts} +7 -1
- package/dist/components/{layoutchild-component.d.ts → layout-child-component.d.ts} +7 -1
- package/dist/components/{layoutgroup-component.d.cts → layout-group-component.d.cts} +7 -1
- package/dist/components/{layoutgroup-component.d.ts → layout-group-component.d.ts} +7 -1
- package/dist/components/light-component.d.cts +52 -1
- package/dist/components/light-component.d.ts +52 -1
- package/dist/components/{particlesystem-component.d.cts → particle-system-component.d.cts} +7 -1
- package/dist/components/{particlesystem-component.d.ts → particle-system-component.d.ts} +7 -1
- package/dist/components/render-component.d.cts +7 -0
- package/dist/components/render-component.d.ts +7 -0
- package/dist/components/{rigidbody-component.d.cts → rigid-body-component.d.cts} +8 -1
- package/dist/components/{rigidbody-component.d.ts → rigid-body-component.d.ts} +8 -1
- package/dist/components/screen-component.d.cts +6 -0
- package/dist/components/screen-component.d.ts +6 -0
- package/dist/components/script-component.d.cts +26 -12
- package/dist/components/script-component.d.ts +26 -12
- package/dist/components/{script.d.cts → script-instance.d.cts} +11 -7
- package/dist/components/{script.d.ts → script-instance.d.ts} +11 -7
- package/dist/components/{scrollview-component.d.cts → scroll-view-component.d.cts} +7 -1
- package/dist/components/{scrollview-component.d.ts → scroll-view-component.d.ts} +7 -1
- package/dist/components/scrollbar-component.d.cts +6 -0
- package/dist/components/scrollbar-component.d.ts +6 -0
- package/dist/components/sound-component.d.cts +7 -1
- package/dist/components/sound-component.d.ts +7 -1
- package/dist/components/sound-slot.d.cts +5 -2
- package/dist/components/sound-slot.d.ts +5 -2
- package/dist/custom-elements.json +1852 -974
- package/dist/entity-base.d.cts +7 -6
- package/dist/entity-base.d.ts +7 -6
- package/dist/entity-owner.d.cts +118 -0
- package/dist/entity-owner.d.ts +118 -0
- package/dist/entity.d.cts +14 -102
- package/dist/entity.d.ts +14 -102
- package/dist/index.d.cts +26 -22
- package/dist/index.d.ts +26 -22
- package/dist/material.d.cts +18 -7
- package/dist/material.d.ts +18 -7
- package/dist/model.d.cts +72 -24
- package/dist/model.d.ts +72 -24
- package/dist/node.d.cts +6 -1
- package/dist/node.d.ts +6 -1
- package/dist/pwc.cjs +807 -293
- package/dist/pwc.cjs.map +1 -1
- package/dist/pwc.js +807 -293
- 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 +805 -292
- package/dist/pwc.mjs.map +1 -1
- package/dist/scene.d.cts +3 -0
- package/dist/scene.d.ts +3 -0
- package/dist/sky.d.cts +4 -0
- package/dist/sky.d.ts +4 -0
- package/dist/vscode.html-custom-data.json +351 -121
- package/dist/{module.d.cts → wasm.d.cts} +10 -6
- package/dist/{module.d.ts → wasm.d.ts} +10 -6
- package/dist/web-types.json +465 -291
- package/package.json +7 -7
- package/src/app.ts +49 -35
- package/src/asset.ts +13 -4
- package/src/async-element.ts +14 -14
- package/src/components/anim-clip.ts +4 -0
- package/src/components/anim-component.ts +89 -14
- package/src/components/audio-listener-component.ts +36 -0
- package/src/components/button-component.ts +10 -1
- package/src/components/camera-component.ts +65 -6
- package/src/components/collision-component.ts +9 -1
- package/src/components/component.ts +4 -3
- package/src/components/element-component.ts +11 -0
- package/src/components/gsplat-component.ts +6 -0
- package/src/components/joint-component.ts +14 -2
- package/src/components/{layoutchild-component.ts → layout-child-component.ts} +8 -2
- package/src/components/{layoutgroup-component.ts → layout-group-component.ts} +8 -2
- package/src/components/light-component.ts +110 -17
- package/src/components/{particlesystem-component.ts → particle-system-component.ts} +8 -2
- package/src/components/render-component.ts +7 -0
- package/src/components/{rigidbody-component.ts → rigid-body-component.ts} +9 -2
- package/src/components/screen-component.ts +6 -0
- package/src/components/script-component.ts +66 -42
- package/src/components/{script.ts → script-instance.ts} +18 -14
- package/src/components/{scrollview-component.ts → scroll-view-component.ts} +8 -2
- package/src/components/scrollbar-component.ts +6 -0
- package/src/components/sound-component.ts +8 -2
- package/src/components/sound-slot.ts +7 -4
- package/src/entity-base.ts +8 -7
- package/src/entity-owner.ts +298 -0
- package/src/entity.ts +21 -271
- package/src/index.ts +38 -25
- package/src/material.ts +19 -8
- package/src/model.ts +164 -72
- package/src/node.ts +15 -6
- package/src/scene.ts +3 -0
- package/src/sky.ts +4 -0
- package/src/{module.ts → wasm.ts} +12 -8
- package/dist/components/listener-component.d.cts +0 -20
- package/dist/components/listener-component.d.ts +0 -20
- package/src/components/listener-component.ts +0 -30
|
@@ -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",
|
|
@@ -317,6 +317,7 @@
|
|
|
317
317
|
"name": "AsyncElement",
|
|
318
318
|
"module": "/src/async-element"
|
|
319
319
|
},
|
|
320
|
+
"summary": "The `<pc-app>` element creates a PlayCanvas application and the canvas it renders\ninto, and is the root of every scene. It holds the `<pc-asset>`, `<pc-material>`, `<pc-wasm>` and\n`<pc-scene>` elements, and the page's CSS sizes it, as it would a `<video>`.\n",
|
|
320
321
|
"tagName": "pc-app",
|
|
321
322
|
"customElement": true
|
|
322
323
|
}
|
|
@@ -439,7 +440,7 @@
|
|
|
439
440
|
"type": {
|
|
440
441
|
"text": "EntityBaseElement | null"
|
|
441
442
|
},
|
|
442
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
443
|
+
"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
444
|
"return": {
|
|
444
445
|
"type": {
|
|
445
446
|
"text": ""
|
|
@@ -767,6 +768,7 @@
|
|
|
767
768
|
"name": "AsyncElement",
|
|
768
769
|
"module": "/src/async-element"
|
|
769
770
|
},
|
|
771
|
+
"summary": "The `<pc-asset>` element declares an asset for the application to load — a model,\ntexture, font, sound, script or JSON file — under an `id` that other elements reference. Must be\na direct child of `<pc-app>`.\n",
|
|
770
772
|
"tagName": "pc-asset",
|
|
771
773
|
"customElement": true
|
|
772
774
|
}
|
|
@@ -819,7 +821,7 @@
|
|
|
819
821
|
"type": {
|
|
820
822
|
"text": "EntityBaseElement | null"
|
|
821
823
|
},
|
|
822
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
824
|
+
"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
825
|
"return": {
|
|
824
826
|
"type": {
|
|
825
827
|
"text": ""
|
|
@@ -869,7 +871,7 @@
|
|
|
869
871
|
"description": "The tag name of the element to wait for (e.g. `'pc-app'`)."
|
|
870
872
|
}
|
|
871
873
|
],
|
|
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-
|
|
874
|
+
"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
875
|
},
|
|
874
876
|
{
|
|
875
877
|
"kind": "function",
|
|
@@ -907,7 +909,7 @@
|
|
|
907
909
|
"description": "A CSS selector matching the element to wait for (e.g. `'#my-app'`)."
|
|
908
910
|
}
|
|
909
911
|
],
|
|
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-
|
|
912
|
+
"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
913
|
},
|
|
912
914
|
{
|
|
913
915
|
"kind": "function",
|
|
@@ -960,7 +962,7 @@
|
|
|
960
962
|
"declarations": [
|
|
961
963
|
{
|
|
962
964
|
"kind": "class",
|
|
963
|
-
"description": "The base class for elements that front an engine Entity: `<pc-entity>`, which
|
|
965
|
+
"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
966
|
"name": "EntityBaseElement",
|
|
965
967
|
"members": [
|
|
966
968
|
{
|
|
@@ -1012,7 +1014,7 @@
|
|
|
1012
1014
|
"type": {
|
|
1013
1015
|
"text": "EntityBaseElement | null"
|
|
1014
1016
|
},
|
|
1015
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
1017
|
+
"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
1018
|
"return": {
|
|
1017
1019
|
"type": {
|
|
1018
1020
|
"text": ""
|
|
@@ -1110,12 +1112,12 @@
|
|
|
1110
1112
|
},
|
|
1111
1113
|
{
|
|
1112
1114
|
"kind": "javascript-module",
|
|
1113
|
-
"path": "src/entity.ts",
|
|
1115
|
+
"path": "src/entity-owner.ts",
|
|
1114
1116
|
"declarations": [
|
|
1115
1117
|
{
|
|
1116
1118
|
"kind": "class",
|
|
1117
|
-
"description": "The
|
|
1118
|
-
"name": "
|
|
1119
|
+
"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.",
|
|
1120
|
+
"name": "EntityOwnerElement",
|
|
1119
1121
|
"members": [
|
|
1120
1122
|
{
|
|
1121
1123
|
"kind": "method",
|
|
@@ -1170,7 +1172,7 @@
|
|
|
1170
1172
|
"type": {
|
|
1171
1173
|
"text": "EntityBaseElement | null"
|
|
1172
1174
|
},
|
|
1173
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
1175
|
+
"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
1176
|
"return": {
|
|
1175
1177
|
"type": {
|
|
1176
1178
|
"text": ""
|
|
@@ -1340,6 +1342,44 @@
|
|
|
1340
1342
|
}
|
|
1341
1343
|
}
|
|
1342
1344
|
],
|
|
1345
|
+
"superclass": {
|
|
1346
|
+
"name": "EntityBaseElement",
|
|
1347
|
+
"module": "/src/entity-base"
|
|
1348
|
+
},
|
|
1349
|
+
"events": [
|
|
1350
|
+
{
|
|
1351
|
+
"name": "ready",
|
|
1352
|
+
"type": {
|
|
1353
|
+
"text": "CustomEvent"
|
|
1354
|
+
},
|
|
1355
|
+
"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.",
|
|
1356
|
+
"inheritedFrom": {
|
|
1357
|
+
"name": "AsyncElement",
|
|
1358
|
+
"module": "src/async-element.ts"
|
|
1359
|
+
}
|
|
1360
|
+
}
|
|
1361
|
+
]
|
|
1362
|
+
}
|
|
1363
|
+
],
|
|
1364
|
+
"exports": [
|
|
1365
|
+
{
|
|
1366
|
+
"kind": "js",
|
|
1367
|
+
"name": "EntityOwnerElement",
|
|
1368
|
+
"declaration": {
|
|
1369
|
+
"name": "EntityOwnerElement",
|
|
1370
|
+
"module": "src/entity-owner.ts"
|
|
1371
|
+
}
|
|
1372
|
+
}
|
|
1373
|
+
]
|
|
1374
|
+
},
|
|
1375
|
+
{
|
|
1376
|
+
"kind": "javascript-module",
|
|
1377
|
+
"path": "src/entity.ts",
|
|
1378
|
+
"declarations": [
|
|
1379
|
+
{
|
|
1380
|
+
"kind": "class",
|
|
1381
|
+
"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 EventTarget.addEventListener or with the matching inline `onpointer*`\nattribute.\n",
|
|
1382
|
+
"name": "EntityElement",
|
|
1343
1383
|
"events": [
|
|
1344
1384
|
{
|
|
1345
1385
|
"type": {
|
|
@@ -1394,17 +1434,17 @@
|
|
|
1394
1434
|
"type": {
|
|
1395
1435
|
"text": "boolean"
|
|
1396
1436
|
},
|
|
1437
|
+
"description": "The enabled state of the entity.",
|
|
1397
1438
|
"fieldName": "enabled",
|
|
1398
|
-
"default": "true"
|
|
1399
|
-
"description": "The enabled state of the entity."
|
|
1439
|
+
"default": "true"
|
|
1400
1440
|
},
|
|
1401
1441
|
{
|
|
1402
1442
|
"name": "name",
|
|
1403
1443
|
"type": {
|
|
1404
1444
|
"text": "string"
|
|
1405
1445
|
},
|
|
1406
|
-
"
|
|
1407
|
-
"
|
|
1446
|
+
"description": "The name of the entity.",
|
|
1447
|
+
"fieldName": "name"
|
|
1408
1448
|
},
|
|
1409
1449
|
{
|
|
1410
1450
|
"type": {
|
|
@@ -1451,266 +1491,515 @@
|
|
|
1451
1491
|
"type": {
|
|
1452
1492
|
"text": "string"
|
|
1453
1493
|
},
|
|
1494
|
+
"description": "The position of the entity. Accepts 3 space-separated numbers.",
|
|
1454
1495
|
"fieldName": "position",
|
|
1455
|
-
"default": "0 0 0"
|
|
1456
|
-
"description": "The position of the entity. Accepts 3 space-separated numbers."
|
|
1496
|
+
"default": "0 0 0"
|
|
1457
1497
|
},
|
|
1458
1498
|
{
|
|
1459
1499
|
"name": "rotation",
|
|
1460
1500
|
"type": {
|
|
1461
1501
|
"text": "string"
|
|
1462
1502
|
},
|
|
1503
|
+
"description": "The rotation of the entity. Accepts 3 space-separated numbers.",
|
|
1463
1504
|
"fieldName": "rotation",
|
|
1464
|
-
"default": "0 0 0"
|
|
1465
|
-
"description": "The rotation of the entity. Accepts 3 space-separated numbers."
|
|
1505
|
+
"default": "0 0 0"
|
|
1466
1506
|
},
|
|
1467
1507
|
{
|
|
1468
1508
|
"name": "scale",
|
|
1469
1509
|
"type": {
|
|
1470
1510
|
"text": "string"
|
|
1471
1511
|
},
|
|
1512
|
+
"description": "The scale of the entity. Accepts 3 space-separated numbers.",
|
|
1472
1513
|
"fieldName": "scale",
|
|
1473
|
-
"default": "1 1 1"
|
|
1474
|
-
"description": "The scale of the entity. Accepts 3 space-separated numbers."
|
|
1514
|
+
"default": "1 1 1"
|
|
1475
1515
|
},
|
|
1476
1516
|
{
|
|
1477
1517
|
"name": "tags",
|
|
1478
1518
|
"type": {
|
|
1479
1519
|
"text": "string"
|
|
1480
1520
|
},
|
|
1481
|
-
"
|
|
1482
|
-
"
|
|
1521
|
+
"description": "The tags of the entity.",
|
|
1522
|
+
"fieldName": "tags"
|
|
1483
1523
|
}
|
|
1484
1524
|
],
|
|
1485
1525
|
"superclass": {
|
|
1486
|
-
"name": "
|
|
1487
|
-
"module": "/src/entity-
|
|
1526
|
+
"name": "EntityOwnerElement",
|
|
1527
|
+
"module": "/src/entity-owner"
|
|
1488
1528
|
},
|
|
1529
|
+
"summary": "The `<pc-entity>` element creates an entity: a named, transformable node of the\nscene hierarchy, and the host for component elements such as `<pc-camera>`, `<pc-light>` and\n`<pc-render>`. Place it in the `<pc-scene>`, or nest it under another `<pc-entity>`, a\n`<pc-model>` or a `<pc-node>` to parent it there.\n",
|
|
1489
1530
|
"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
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1531
|
+
"customElement": true,
|
|
1532
|
+
"members": [
|
|
1533
|
+
{
|
|
1534
|
+
"kind": "method",
|
|
1535
|
+
"name": "addEventListener",
|
|
1536
|
+
"parameters": [
|
|
1537
|
+
{
|
|
1538
|
+
"name": "type",
|
|
1539
|
+
"type": {
|
|
1540
|
+
"text": "string"
|
|
1541
|
+
}
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"name": "listener",
|
|
1545
|
+
"type": {
|
|
1546
|
+
"text": "EventListener"
|
|
1547
|
+
}
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"name": "options",
|
|
1551
|
+
"optional": true,
|
|
1552
|
+
"type": {
|
|
1553
|
+
"text": "boolean | AddEventListenerOptions"
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
],
|
|
1557
|
+
"inheritedFrom": {
|
|
1558
|
+
"name": "EntityBaseElement",
|
|
1559
|
+
"module": "src/entity-base.ts"
|
|
1560
|
+
}
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"kind": "field",
|
|
1564
|
+
"name": "closestApp",
|
|
1565
|
+
"type": {
|
|
1566
|
+
"text": "AppElement | null"
|
|
1567
|
+
},
|
|
1568
|
+
"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.",
|
|
1569
|
+
"return": {
|
|
1570
|
+
"type": {
|
|
1571
|
+
"text": ""
|
|
1572
|
+
}
|
|
1573
|
+
},
|
|
1574
|
+
"readonly": true,
|
|
1575
|
+
"inheritedFrom": {
|
|
1576
|
+
"name": "AsyncElement",
|
|
1577
|
+
"module": "src/async-element.ts"
|
|
1578
|
+
}
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"kind": "field",
|
|
1582
|
+
"name": "closestEntity",
|
|
1583
|
+
"type": {
|
|
1584
|
+
"text": "EntityBaseElement | null"
|
|
1585
|
+
},
|
|
1586
|
+
"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.",
|
|
1587
|
+
"return": {
|
|
1588
|
+
"type": {
|
|
1589
|
+
"text": ""
|
|
1590
|
+
}
|
|
1591
|
+
},
|
|
1592
|
+
"readonly": true,
|
|
1593
|
+
"inheritedFrom": {
|
|
1594
|
+
"name": "AsyncElement",
|
|
1595
|
+
"module": "src/async-element.ts"
|
|
1596
|
+
}
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"kind": "field",
|
|
1600
|
+
"name": "enabled",
|
|
1601
|
+
"description": "Gets the enabled state of the entity.",
|
|
1602
|
+
"parameters": [
|
|
1603
|
+
{
|
|
1604
|
+
"description": "Whether the entity is enabled.",
|
|
1605
|
+
"name": "value"
|
|
1606
|
+
}
|
|
1607
|
+
],
|
|
1608
|
+
"return": {
|
|
1609
|
+
"type": {
|
|
1610
|
+
"text": ""
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
"inheritedFrom": {
|
|
1614
|
+
"name": "EntityOwnerElement",
|
|
1615
|
+
"module": "src/entity-owner.ts"
|
|
1616
|
+
}
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"kind": "field",
|
|
1620
|
+
"name": "entity",
|
|
1621
|
+
"type": {
|
|
1622
|
+
"text": "Entity | null"
|
|
1623
|
+
},
|
|
1624
|
+
"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.",
|
|
1625
|
+
"return": {
|
|
1626
|
+
"type": {
|
|
1627
|
+
"text": ""
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1630
|
+
"readonly": true,
|
|
1631
|
+
"inheritedFrom": {
|
|
1632
|
+
"name": "EntityBaseElement",
|
|
1633
|
+
"module": "src/entity-base.ts"
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
{
|
|
1637
|
+
"kind": "field",
|
|
1638
|
+
"name": "name",
|
|
1639
|
+
"description": "Gets the name of the entity.",
|
|
1640
|
+
"parameters": [
|
|
1641
|
+
{
|
|
1642
|
+
"description": "The name of the entity.",
|
|
1643
|
+
"name": "value"
|
|
1644
|
+
}
|
|
1645
|
+
],
|
|
1646
|
+
"return": {
|
|
1647
|
+
"type": {
|
|
1648
|
+
"text": ""
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
"inheritedFrom": {
|
|
1652
|
+
"name": "EntityOwnerElement",
|
|
1653
|
+
"module": "src/entity-owner.ts"
|
|
1654
|
+
}
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"kind": "field",
|
|
1658
|
+
"name": "position",
|
|
1659
|
+
"description": "Gets the position of the entity.",
|
|
1660
|
+
"parameters": [
|
|
1661
|
+
{
|
|
1662
|
+
"description": "The position of the entity.",
|
|
1663
|
+
"name": "value"
|
|
1664
|
+
}
|
|
1665
|
+
],
|
|
1666
|
+
"return": {
|
|
1667
|
+
"type": {
|
|
1668
|
+
"text": ""
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
"inheritedFrom": {
|
|
1672
|
+
"name": "EntityOwnerElement",
|
|
1673
|
+
"module": "src/entity-owner.ts"
|
|
1674
|
+
}
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"kind": "method",
|
|
1678
|
+
"name": "ready",
|
|
1679
|
+
"return": {
|
|
1680
|
+
"type": {
|
|
1681
|
+
"text": ""
|
|
1682
|
+
}
|
|
1683
|
+
},
|
|
1684
|
+
"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.",
|
|
1685
|
+
"inheritedFrom": {
|
|
1686
|
+
"name": "AsyncElement",
|
|
1687
|
+
"module": "src/async-element.ts"
|
|
1688
|
+
}
|
|
1689
|
+
},
|
|
1690
|
+
{
|
|
1691
|
+
"kind": "method",
|
|
1692
|
+
"name": "removeEventListener",
|
|
1693
|
+
"parameters": [
|
|
1694
|
+
{
|
|
1695
|
+
"name": "type",
|
|
1696
|
+
"type": {
|
|
1697
|
+
"text": "string"
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"name": "listener",
|
|
1702
|
+
"type": {
|
|
1703
|
+
"text": "EventListener"
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"name": "options",
|
|
1708
|
+
"optional": true,
|
|
1709
|
+
"type": {
|
|
1710
|
+
"text": "boolean | EventListenerOptions"
|
|
1711
|
+
}
|
|
1712
|
+
}
|
|
1713
|
+
],
|
|
1714
|
+
"inheritedFrom": {
|
|
1715
|
+
"name": "EntityBaseElement",
|
|
1716
|
+
"module": "src/entity-base.ts"
|
|
1717
|
+
}
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
"kind": "field",
|
|
1721
|
+
"name": "rotation",
|
|
1722
|
+
"description": "Gets the rotation of the entity.",
|
|
1723
|
+
"parameters": [
|
|
1724
|
+
{
|
|
1725
|
+
"description": "The rotation of the entity.",
|
|
1726
|
+
"name": "value"
|
|
1727
|
+
}
|
|
1728
|
+
],
|
|
1729
|
+
"return": {
|
|
1730
|
+
"type": {
|
|
1731
|
+
"text": ""
|
|
1732
|
+
}
|
|
1733
|
+
},
|
|
1734
|
+
"inheritedFrom": {
|
|
1735
|
+
"name": "EntityOwnerElement",
|
|
1736
|
+
"module": "src/entity-owner.ts"
|
|
1737
|
+
}
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"kind": "field",
|
|
1741
|
+
"name": "scale",
|
|
1742
|
+
"description": "Gets the scale of the entity.",
|
|
1743
|
+
"parameters": [
|
|
1744
|
+
{
|
|
1745
|
+
"description": "The scale of the entity.",
|
|
1746
|
+
"name": "value"
|
|
1747
|
+
}
|
|
1748
|
+
],
|
|
1749
|
+
"return": {
|
|
1750
|
+
"type": {
|
|
1751
|
+
"text": ""
|
|
1752
|
+
}
|
|
1753
|
+
},
|
|
1754
|
+
"inheritedFrom": {
|
|
1755
|
+
"name": "EntityOwnerElement",
|
|
1756
|
+
"module": "src/entity-owner.ts"
|
|
1757
|
+
}
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"kind": "field",
|
|
1761
|
+
"name": "tags",
|
|
1762
|
+
"description": "Gets the tags of the entity.",
|
|
1763
|
+
"parameters": [
|
|
1764
|
+
{
|
|
1765
|
+
"description": "The tags of the entity.",
|
|
1766
|
+
"name": "value"
|
|
1767
|
+
}
|
|
1768
|
+
],
|
|
1769
|
+
"return": {
|
|
1770
|
+
"type": {
|
|
1771
|
+
"text": ""
|
|
1772
|
+
}
|
|
1773
|
+
},
|
|
1774
|
+
"inheritedFrom": {
|
|
1775
|
+
"name": "EntityOwnerElement",
|
|
1776
|
+
"module": "src/entity-owner.ts"
|
|
1777
|
+
}
|
|
1778
|
+
}
|
|
1779
|
+
]
|
|
1780
|
+
}
|
|
1781
|
+
],
|
|
1782
|
+
"exports": [
|
|
1783
|
+
{
|
|
1784
|
+
"kind": "custom-element-definition",
|
|
1785
|
+
"name": "pc-entity",
|
|
1786
|
+
"declaration": {
|
|
1787
|
+
"name": "EntityElement",
|
|
1788
|
+
"module": "src/entity.ts"
|
|
1789
|
+
}
|
|
1790
|
+
},
|
|
1791
|
+
{
|
|
1792
|
+
"kind": "js",
|
|
1793
|
+
"name": "EntityElement",
|
|
1794
|
+
"declaration": {
|
|
1795
|
+
"name": "EntityElement",
|
|
1796
|
+
"module": "src/entity.ts"
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
]
|
|
1800
|
+
},
|
|
1801
|
+
{
|
|
1802
|
+
"kind": "javascript-module",
|
|
1803
|
+
"path": "src/index.ts",
|
|
1804
|
+
"declarations": [],
|
|
1805
|
+
"exports": [
|
|
1806
|
+
{
|
|
1807
|
+
"kind": "js",
|
|
1808
|
+
"name": "AsyncElement",
|
|
1809
|
+
"declaration": {
|
|
1810
|
+
"name": "AsyncElement",
|
|
1811
|
+
"module": "src/index.ts"
|
|
1812
|
+
}
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"kind": "js",
|
|
1816
|
+
"name": "WasmElement",
|
|
1817
|
+
"declaration": {
|
|
1818
|
+
"name": "WasmElement",
|
|
1819
|
+
"module": "src/index.ts"
|
|
1820
|
+
}
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"kind": "js",
|
|
1824
|
+
"name": "AppElement",
|
|
1825
|
+
"declaration": {
|
|
1826
|
+
"name": "AppElement",
|
|
1827
|
+
"module": "src/index.ts"
|
|
1828
|
+
}
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"kind": "js",
|
|
1832
|
+
"name": "EntityElement",
|
|
1833
|
+
"declaration": {
|
|
1834
|
+
"name": "EntityElement",
|
|
1835
|
+
"module": "src/index.ts"
|
|
1836
|
+
}
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
"kind": "js",
|
|
1840
|
+
"name": "AssetElement",
|
|
1841
|
+
"declaration": {
|
|
1842
|
+
"name": "AssetElement",
|
|
1843
|
+
"module": "src/index.ts"
|
|
1844
|
+
}
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"kind": "js",
|
|
1848
|
+
"name": "AnimComponentElement",
|
|
1849
|
+
"declaration": {
|
|
1850
|
+
"name": "AnimComponentElement",
|
|
1851
|
+
"module": "src/index.ts"
|
|
1852
|
+
}
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"kind": "js",
|
|
1856
|
+
"name": "AnimClipElement",
|
|
1857
|
+
"declaration": {
|
|
1858
|
+
"name": "AnimClipElement",
|
|
1859
|
+
"module": "src/index.ts"
|
|
1860
|
+
}
|
|
1861
|
+
},
|
|
1862
|
+
{
|
|
1863
|
+
"kind": "js",
|
|
1864
|
+
"name": "ButtonComponentElement",
|
|
1865
|
+
"declaration": {
|
|
1866
|
+
"name": "ButtonComponentElement",
|
|
1867
|
+
"module": "src/index.ts"
|
|
1868
|
+
}
|
|
1869
|
+
},
|
|
1870
|
+
{
|
|
1871
|
+
"kind": "js",
|
|
1872
|
+
"name": "CameraComponentElement",
|
|
1873
|
+
"declaration": {
|
|
1874
|
+
"name": "CameraComponentElement",
|
|
1875
|
+
"module": "src/index.ts"
|
|
1876
|
+
}
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"kind": "js",
|
|
1880
|
+
"name": "CollisionComponentElement",
|
|
1881
|
+
"declaration": {
|
|
1882
|
+
"name": "CollisionComponentElement",
|
|
1883
|
+
"module": "src/index.ts"
|
|
1884
|
+
}
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
"kind": "js",
|
|
1888
|
+
"name": "ComponentElement",
|
|
1889
|
+
"declaration": {
|
|
1890
|
+
"name": "ComponentElement",
|
|
1891
|
+
"module": "src/index.ts"
|
|
1892
|
+
}
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"kind": "js",
|
|
1896
|
+
"name": "ElementComponentElement",
|
|
1897
|
+
"declaration": {
|
|
1898
|
+
"name": "ElementComponentElement",
|
|
1899
|
+
"module": "src/index.ts"
|
|
1900
|
+
}
|
|
1901
|
+
},
|
|
1902
|
+
{
|
|
1903
|
+
"kind": "js",
|
|
1904
|
+
"name": "JointComponentElement",
|
|
1905
|
+
"declaration": {
|
|
1906
|
+
"name": "JointComponentElement",
|
|
1907
|
+
"module": "src/index.ts"
|
|
1908
|
+
}
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"kind": "js",
|
|
1912
|
+
"name": "LayoutChildComponentElement",
|
|
1913
|
+
"declaration": {
|
|
1914
|
+
"name": "LayoutChildComponentElement",
|
|
1915
|
+
"module": "src/index.ts"
|
|
1916
|
+
}
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
"kind": "js",
|
|
1920
|
+
"name": "LayoutGroupComponentElement",
|
|
1921
|
+
"declaration": {
|
|
1922
|
+
"name": "LayoutGroupComponentElement",
|
|
1923
|
+
"module": "src/index.ts"
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"kind": "js",
|
|
1928
|
+
"name": "ParticleSystemComponentElement",
|
|
1929
|
+
"declaration": {
|
|
1930
|
+
"name": "ParticleSystemComponentElement",
|
|
1931
|
+
"module": "src/index.ts"
|
|
1932
|
+
}
|
|
1933
|
+
},
|
|
1934
|
+
{
|
|
1935
|
+
"kind": "js",
|
|
1936
|
+
"name": "LightComponentElement",
|
|
1937
|
+
"declaration": {
|
|
1938
|
+
"name": "LightComponentElement",
|
|
1939
|
+
"module": "src/index.ts"
|
|
1940
|
+
}
|
|
1941
|
+
},
|
|
1942
|
+
{
|
|
1943
|
+
"kind": "js",
|
|
1944
|
+
"name": "AudioListenerComponentElement",
|
|
1945
|
+
"declaration": {
|
|
1946
|
+
"name": "AudioListenerComponentElement",
|
|
1947
|
+
"module": "src/index.ts"
|
|
1948
|
+
}
|
|
1949
|
+
},
|
|
1950
|
+
{
|
|
1951
|
+
"kind": "js",
|
|
1952
|
+
"name": "RenderComponentElement",
|
|
1953
|
+
"declaration": {
|
|
1954
|
+
"name": "RenderComponentElement",
|
|
1955
|
+
"module": "src/index.ts"
|
|
1956
|
+
}
|
|
1957
|
+
},
|
|
1958
|
+
{
|
|
1959
|
+
"kind": "js",
|
|
1960
|
+
"name": "RigidBodyComponentElement",
|
|
1961
|
+
"declaration": {
|
|
1962
|
+
"name": "RigidBodyComponentElement",
|
|
1963
|
+
"module": "src/index.ts"
|
|
1964
|
+
}
|
|
1965
|
+
},
|
|
1966
|
+
{
|
|
1967
|
+
"kind": "js",
|
|
1968
|
+
"name": "ScreenComponentElement",
|
|
1969
|
+
"declaration": {
|
|
1970
|
+
"name": "ScreenComponentElement",
|
|
1971
|
+
"module": "src/index.ts"
|
|
1972
|
+
}
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"kind": "js",
|
|
1976
|
+
"name": "ScrollbarComponentElement",
|
|
1977
|
+
"declaration": {
|
|
1978
|
+
"name": "ScrollbarComponentElement",
|
|
1979
|
+
"module": "src/index.ts"
|
|
1980
|
+
}
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"kind": "js",
|
|
1984
|
+
"name": "ScrollViewComponentElement",
|
|
1985
|
+
"declaration": {
|
|
1986
|
+
"name": "ScrollViewComponentElement",
|
|
1987
|
+
"module": "src/index.ts"
|
|
1988
|
+
}
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"kind": "js",
|
|
1992
|
+
"name": "ScriptComponentElement",
|
|
1993
|
+
"declaration": {
|
|
1705
1994
|
"name": "ScriptComponentElement",
|
|
1706
1995
|
"module": "src/index.ts"
|
|
1707
1996
|
}
|
|
1708
1997
|
},
|
|
1709
1998
|
{
|
|
1710
1999
|
"kind": "js",
|
|
1711
|
-
"name": "
|
|
2000
|
+
"name": "ScriptInstanceElement",
|
|
1712
2001
|
"declaration": {
|
|
1713
|
-
"name": "
|
|
2002
|
+
"name": "ScriptInstanceElement",
|
|
1714
2003
|
"module": "src/index.ts"
|
|
1715
2004
|
}
|
|
1716
2005
|
},
|
|
@@ -1746,6 +2035,14 @@
|
|
|
1746
2035
|
"module": "src/index.ts"
|
|
1747
2036
|
}
|
|
1748
2037
|
},
|
|
2038
|
+
{
|
|
2039
|
+
"kind": "js",
|
|
2040
|
+
"name": "EntityOwnerElement",
|
|
2041
|
+
"declaration": {
|
|
2042
|
+
"name": "EntityOwnerElement",
|
|
2043
|
+
"module": "src/index.ts"
|
|
2044
|
+
}
|
|
2045
|
+
},
|
|
1749
2046
|
{
|
|
1750
2047
|
"kind": "js",
|
|
1751
2048
|
"name": "MaterialElement",
|
|
@@ -1794,6 +2091,30 @@
|
|
|
1794
2091
|
"module": "src/index.ts"
|
|
1795
2092
|
}
|
|
1796
2093
|
},
|
|
2094
|
+
{
|
|
2095
|
+
"kind": "js",
|
|
2096
|
+
"name": "AddressMode",
|
|
2097
|
+
"declaration": {
|
|
2098
|
+
"name": "AddressMode",
|
|
2099
|
+
"module": "./asset"
|
|
2100
|
+
}
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"kind": "js",
|
|
2104
|
+
"name": "MagFilterMode",
|
|
2105
|
+
"declaration": {
|
|
2106
|
+
"name": "MagFilterMode",
|
|
2107
|
+
"module": "./asset"
|
|
2108
|
+
}
|
|
2109
|
+
},
|
|
2110
|
+
{
|
|
2111
|
+
"kind": "js",
|
|
2112
|
+
"name": "MinFilterMode",
|
|
2113
|
+
"declaration": {
|
|
2114
|
+
"name": "MinFilterMode",
|
|
2115
|
+
"module": "./asset"
|
|
2116
|
+
}
|
|
2117
|
+
},
|
|
1797
2118
|
{
|
|
1798
2119
|
"kind": "js",
|
|
1799
2120
|
"name": "AsyncElementTagName",
|
|
@@ -1802,6 +2123,78 @@
|
|
|
1802
2123
|
"module": "./async-element"
|
|
1803
2124
|
}
|
|
1804
2125
|
},
|
|
2126
|
+
{
|
|
2127
|
+
"kind": "js",
|
|
2128
|
+
"name": "JointType",
|
|
2129
|
+
"declaration": {
|
|
2130
|
+
"name": "JointType",
|
|
2131
|
+
"module": "./components/joint-component"
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
"kind": "js",
|
|
2136
|
+
"name": "MotionMode",
|
|
2137
|
+
"declaration": {
|
|
2138
|
+
"name": "MotionMode",
|
|
2139
|
+
"module": "./components/joint-component"
|
|
2140
|
+
}
|
|
2141
|
+
},
|
|
2142
|
+
{
|
|
2143
|
+
"kind": "js",
|
|
2144
|
+
"name": "BlendType",
|
|
2145
|
+
"declaration": {
|
|
2146
|
+
"name": "BlendType",
|
|
2147
|
+
"module": "./material"
|
|
2148
|
+
}
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"kind": "js",
|
|
2152
|
+
"name": "ColorChannel",
|
|
2153
|
+
"declaration": {
|
|
2154
|
+
"name": "ColorChannel",
|
|
2155
|
+
"module": "./material"
|
|
2156
|
+
}
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"kind": "js",
|
|
2160
|
+
"name": "CullMode",
|
|
2161
|
+
"declaration": {
|
|
2162
|
+
"name": "CullMode",
|
|
2163
|
+
"module": "./material"
|
|
2164
|
+
}
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"kind": "js",
|
|
2168
|
+
"name": "FresnelModel",
|
|
2169
|
+
"declaration": {
|
|
2170
|
+
"name": "FresnelModel",
|
|
2171
|
+
"module": "./material"
|
|
2172
|
+
}
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"kind": "js",
|
|
2176
|
+
"name": "OccludeSpecular",
|
|
2177
|
+
"declaration": {
|
|
2178
|
+
"name": "OccludeSpecular",
|
|
2179
|
+
"module": "./material"
|
|
2180
|
+
}
|
|
2181
|
+
},
|
|
2182
|
+
{
|
|
2183
|
+
"kind": "js",
|
|
2184
|
+
"name": "OpacityDither",
|
|
2185
|
+
"declaration": {
|
|
2186
|
+
"name": "OpacityDither",
|
|
2187
|
+
"module": "./material"
|
|
2188
|
+
}
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"kind": "js",
|
|
2192
|
+
"name": "ScalarChannel",
|
|
2193
|
+
"declaration": {
|
|
2194
|
+
"name": "ScalarChannel",
|
|
2195
|
+
"module": "./material"
|
|
2196
|
+
}
|
|
2197
|
+
},
|
|
1805
2198
|
{
|
|
1806
2199
|
"kind": "js",
|
|
1807
2200
|
"name": "HierarchyMaterial",
|
|
@@ -1825,6 +2218,14 @@
|
|
|
1825
2218
|
"name": "MaterialOverrides",
|
|
1826
2219
|
"module": "./node"
|
|
1827
2220
|
}
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
"kind": "js",
|
|
2224
|
+
"name": "NodeBindingState",
|
|
2225
|
+
"declaration": {
|
|
2226
|
+
"name": "NodeBindingState",
|
|
2227
|
+
"module": "./node"
|
|
2228
|
+
}
|
|
1828
2229
|
}
|
|
1829
2230
|
]
|
|
1830
2231
|
},
|
|
@@ -3982,6 +4383,7 @@
|
|
|
3982
4383
|
"superclass": {
|
|
3983
4384
|
"name": "HTMLElement"
|
|
3984
4385
|
},
|
|
4386
|
+
"summary": "The `<pc-material>` element defines a physically based material, which\n`<pc-render>` elements apply by naming its `id`. It is metal/rough by default, with `metalness`\nstarting at 0. Must be a direct child of `<pc-app>`.\n",
|
|
3985
4387
|
"tagName": "pc-material",
|
|
3986
4388
|
"customElement": true
|
|
3987
4389
|
}
|
|
@@ -4015,35 +4417,134 @@
|
|
|
4015
4417
|
},
|
|
4016
4418
|
{
|
|
4017
4419
|
"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
|
|
4420
|
+
"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
4421
|
"name": "ModelElement",
|
|
4020
4422
|
"members": [
|
|
4423
|
+
{
|
|
4424
|
+
"kind": "method",
|
|
4425
|
+
"name": "addEventListener",
|
|
4426
|
+
"parameters": [
|
|
4427
|
+
{
|
|
4428
|
+
"name": "type",
|
|
4429
|
+
"type": {
|
|
4430
|
+
"text": "string"
|
|
4431
|
+
}
|
|
4432
|
+
},
|
|
4433
|
+
{
|
|
4434
|
+
"name": "listener",
|
|
4435
|
+
"type": {
|
|
4436
|
+
"text": "EventListener"
|
|
4437
|
+
}
|
|
4438
|
+
},
|
|
4439
|
+
{
|
|
4440
|
+
"name": "options",
|
|
4441
|
+
"optional": true,
|
|
4442
|
+
"type": {
|
|
4443
|
+
"text": "boolean | AddEventListenerOptions"
|
|
4444
|
+
}
|
|
4445
|
+
}
|
|
4446
|
+
],
|
|
4447
|
+
"inheritedFrom": {
|
|
4448
|
+
"name": "EntityBaseElement",
|
|
4449
|
+
"module": "src/entity-base.ts"
|
|
4450
|
+
}
|
|
4451
|
+
},
|
|
4021
4452
|
{
|
|
4022
4453
|
"kind": "field",
|
|
4023
4454
|
"name": "asset",
|
|
4024
4455
|
"description": "Gets the id of the `pc-asset` to use for the model.",
|
|
4025
4456
|
"parameters": [
|
|
4026
4457
|
{
|
|
4027
|
-
"description": "The asset ID.",
|
|
4458
|
+
"description": "The asset ID.",
|
|
4459
|
+
"name": "value"
|
|
4460
|
+
}
|
|
4461
|
+
],
|
|
4462
|
+
"type": {
|
|
4463
|
+
"text": "string"
|
|
4464
|
+
},
|
|
4465
|
+
"return": {
|
|
4466
|
+
"type": {
|
|
4467
|
+
"text": ""
|
|
4468
|
+
}
|
|
4469
|
+
}
|
|
4470
|
+
},
|
|
4471
|
+
{
|
|
4472
|
+
"kind": "field",
|
|
4473
|
+
"name": "closestApp",
|
|
4474
|
+
"type": {
|
|
4475
|
+
"text": "AppElement | null"
|
|
4476
|
+
},
|
|
4477
|
+
"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.",
|
|
4478
|
+
"return": {
|
|
4479
|
+
"type": {
|
|
4480
|
+
"text": ""
|
|
4481
|
+
}
|
|
4482
|
+
},
|
|
4483
|
+
"readonly": true,
|
|
4484
|
+
"inheritedFrom": {
|
|
4485
|
+
"name": "AsyncElement",
|
|
4486
|
+
"module": "src/async-element.ts"
|
|
4487
|
+
}
|
|
4488
|
+
},
|
|
4489
|
+
{
|
|
4490
|
+
"kind": "field",
|
|
4491
|
+
"name": "closestEntity",
|
|
4492
|
+
"type": {
|
|
4493
|
+
"text": "EntityBaseElement | null"
|
|
4494
|
+
},
|
|
4495
|
+
"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.",
|
|
4496
|
+
"return": {
|
|
4497
|
+
"type": {
|
|
4498
|
+
"text": ""
|
|
4499
|
+
}
|
|
4500
|
+
},
|
|
4501
|
+
"readonly": true,
|
|
4502
|
+
"inheritedFrom": {
|
|
4503
|
+
"name": "AsyncElement",
|
|
4504
|
+
"module": "src/async-element.ts"
|
|
4505
|
+
}
|
|
4506
|
+
},
|
|
4507
|
+
{
|
|
4508
|
+
"kind": "field",
|
|
4509
|
+
"name": "contentEntity",
|
|
4510
|
+
"type": {
|
|
4511
|
+
"text": "Entity | null"
|
|
4512
|
+
},
|
|
4513
|
+
"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.",
|
|
4514
|
+
"return": {
|
|
4515
|
+
"type": {
|
|
4516
|
+
"text": ""
|
|
4517
|
+
}
|
|
4518
|
+
},
|
|
4519
|
+
"readonly": true
|
|
4520
|
+
},
|
|
4521
|
+
{
|
|
4522
|
+
"kind": "field",
|
|
4523
|
+
"name": "enabled",
|
|
4524
|
+
"description": "Gets the enabled state of the entity.",
|
|
4525
|
+
"parameters": [
|
|
4526
|
+
{
|
|
4527
|
+
"description": "Whether the entity is enabled.",
|
|
4028
4528
|
"name": "value"
|
|
4029
4529
|
}
|
|
4030
4530
|
],
|
|
4031
|
-
"type": {
|
|
4032
|
-
"text": "string"
|
|
4033
|
-
},
|
|
4034
4531
|
"return": {
|
|
4035
4532
|
"type": {
|
|
4036
4533
|
"text": ""
|
|
4037
4534
|
}
|
|
4535
|
+
},
|
|
4536
|
+
"inheritedFrom": {
|
|
4537
|
+
"name": "EntityOwnerElement",
|
|
4538
|
+
"module": "src/entity-owner.ts"
|
|
4038
4539
|
}
|
|
4039
4540
|
},
|
|
4040
4541
|
{
|
|
4041
4542
|
"kind": "field",
|
|
4042
|
-
"name": "
|
|
4543
|
+
"name": "entity",
|
|
4043
4544
|
"type": {
|
|
4044
|
-
"text": "
|
|
4545
|
+
"text": "Entity | null"
|
|
4045
4546
|
},
|
|
4046
|
-
"description": "The
|
|
4547
|
+
"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.",
|
|
4047
4548
|
"return": {
|
|
4048
4549
|
"type": {
|
|
4049
4550
|
"text": ""
|
|
@@ -4051,64 +4552,161 @@
|
|
|
4051
4552
|
},
|
|
4052
4553
|
"readonly": true,
|
|
4053
4554
|
"inheritedFrom": {
|
|
4054
|
-
"name": "
|
|
4055
|
-
"module": "src/
|
|
4555
|
+
"name": "EntityBaseElement",
|
|
4556
|
+
"module": "src/entity-base.ts"
|
|
4056
4557
|
}
|
|
4057
4558
|
},
|
|
4559
|
+
{
|
|
4560
|
+
"kind": "method",
|
|
4561
|
+
"name": "hierarchy",
|
|
4562
|
+
"return": {
|
|
4563
|
+
"type": {
|
|
4564
|
+
"text": ""
|
|
4565
|
+
}
|
|
4566
|
+
},
|
|
4567
|
+
"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."
|
|
4568
|
+
},
|
|
4058
4569
|
{
|
|
4059
4570
|
"kind": "field",
|
|
4060
|
-
"name": "
|
|
4061
|
-
"
|
|
4062
|
-
|
|
4571
|
+
"name": "name",
|
|
4572
|
+
"description": "Gets the name of the entity.",
|
|
4573
|
+
"parameters": [
|
|
4574
|
+
{
|
|
4575
|
+
"description": "The name of the entity.",
|
|
4576
|
+
"name": "value"
|
|
4577
|
+
}
|
|
4578
|
+
],
|
|
4579
|
+
"return": {
|
|
4580
|
+
"type": {
|
|
4581
|
+
"text": ""
|
|
4582
|
+
}
|
|
4063
4583
|
},
|
|
4064
|
-
"
|
|
4584
|
+
"inheritedFrom": {
|
|
4585
|
+
"name": "EntityOwnerElement",
|
|
4586
|
+
"module": "src/entity-owner.ts"
|
|
4587
|
+
}
|
|
4588
|
+
},
|
|
4589
|
+
{
|
|
4590
|
+
"kind": "field",
|
|
4591
|
+
"name": "position",
|
|
4592
|
+
"description": "Gets the position of the entity.",
|
|
4593
|
+
"parameters": [
|
|
4594
|
+
{
|
|
4595
|
+
"description": "The position of the entity.",
|
|
4596
|
+
"name": "value"
|
|
4597
|
+
}
|
|
4598
|
+
],
|
|
4065
4599
|
"return": {
|
|
4066
4600
|
"type": {
|
|
4067
4601
|
"text": ""
|
|
4068
4602
|
}
|
|
4069
4603
|
},
|
|
4070
|
-
"
|
|
4604
|
+
"inheritedFrom": {
|
|
4605
|
+
"name": "EntityOwnerElement",
|
|
4606
|
+
"module": "src/entity-owner.ts"
|
|
4607
|
+
}
|
|
4608
|
+
},
|
|
4609
|
+
{
|
|
4610
|
+
"kind": "method",
|
|
4611
|
+
"name": "ready",
|
|
4612
|
+
"return": {
|
|
4613
|
+
"type": {
|
|
4614
|
+
"text": ""
|
|
4615
|
+
}
|
|
4616
|
+
},
|
|
4617
|
+
"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.",
|
|
4071
4618
|
"inheritedFrom": {
|
|
4072
4619
|
"name": "AsyncElement",
|
|
4073
4620
|
"module": "src/async-element.ts"
|
|
4074
4621
|
}
|
|
4075
4622
|
},
|
|
4623
|
+
{
|
|
4624
|
+
"kind": "method",
|
|
4625
|
+
"name": "removeEventListener",
|
|
4626
|
+
"parameters": [
|
|
4627
|
+
{
|
|
4628
|
+
"name": "type",
|
|
4629
|
+
"type": {
|
|
4630
|
+
"text": "string"
|
|
4631
|
+
}
|
|
4632
|
+
},
|
|
4633
|
+
{
|
|
4634
|
+
"name": "listener",
|
|
4635
|
+
"type": {
|
|
4636
|
+
"text": "EventListener"
|
|
4637
|
+
}
|
|
4638
|
+
},
|
|
4639
|
+
{
|
|
4640
|
+
"name": "options",
|
|
4641
|
+
"optional": true,
|
|
4642
|
+
"type": {
|
|
4643
|
+
"text": "boolean | EventListenerOptions"
|
|
4644
|
+
}
|
|
4645
|
+
}
|
|
4646
|
+
],
|
|
4647
|
+
"inheritedFrom": {
|
|
4648
|
+
"name": "EntityBaseElement",
|
|
4649
|
+
"module": "src/entity-base.ts"
|
|
4650
|
+
}
|
|
4651
|
+
},
|
|
4076
4652
|
{
|
|
4077
4653
|
"kind": "field",
|
|
4078
|
-
"name": "
|
|
4079
|
-
"
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
|
|
4654
|
+
"name": "rotation",
|
|
4655
|
+
"description": "Gets the rotation of the entity.",
|
|
4656
|
+
"parameters": [
|
|
4657
|
+
{
|
|
4658
|
+
"description": "The rotation of the entity.",
|
|
4659
|
+
"name": "value"
|
|
4660
|
+
}
|
|
4661
|
+
],
|
|
4083
4662
|
"return": {
|
|
4084
4663
|
"type": {
|
|
4085
4664
|
"text": ""
|
|
4086
4665
|
}
|
|
4087
4666
|
},
|
|
4088
|
-
"
|
|
4667
|
+
"inheritedFrom": {
|
|
4668
|
+
"name": "EntityOwnerElement",
|
|
4669
|
+
"module": "src/entity-owner.ts"
|
|
4670
|
+
}
|
|
4089
4671
|
},
|
|
4090
4672
|
{
|
|
4091
|
-
"kind": "
|
|
4092
|
-
"name": "
|
|
4673
|
+
"kind": "field",
|
|
4674
|
+
"name": "scale",
|
|
4675
|
+
"description": "Gets the scale of the entity.",
|
|
4676
|
+
"parameters": [
|
|
4677
|
+
{
|
|
4678
|
+
"description": "The scale of the entity.",
|
|
4679
|
+
"name": "value"
|
|
4680
|
+
}
|
|
4681
|
+
],
|
|
4093
4682
|
"return": {
|
|
4094
4683
|
"type": {
|
|
4095
4684
|
"text": ""
|
|
4096
4685
|
}
|
|
4097
4686
|
},
|
|
4098
|
-
"
|
|
4687
|
+
"inheritedFrom": {
|
|
4688
|
+
"name": "EntityOwnerElement",
|
|
4689
|
+
"module": "src/entity-owner.ts"
|
|
4690
|
+
}
|
|
4099
4691
|
},
|
|
4100
4692
|
{
|
|
4101
|
-
"kind": "
|
|
4102
|
-
"name": "
|
|
4693
|
+
"kind": "field",
|
|
4694
|
+
"name": "tags",
|
|
4695
|
+
"description": "Gets the tags of the entity.",
|
|
4696
|
+
"parameters": [
|
|
4697
|
+
{
|
|
4698
|
+
"description": "The tags of the entity.",
|
|
4699
|
+
"name": "value"
|
|
4700
|
+
}
|
|
4701
|
+
],
|
|
4103
4702
|
"return": {
|
|
4104
4703
|
"type": {
|
|
4105
4704
|
"text": ""
|
|
4106
4705
|
}
|
|
4107
4706
|
},
|
|
4108
|
-
"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.",
|
|
4109
4707
|
"inheritedFrom": {
|
|
4110
|
-
"name": "
|
|
4111
|
-
"module": "src/
|
|
4708
|
+
"name": "EntityOwnerElement",
|
|
4709
|
+
"module": "src/entity-owner.ts"
|
|
4112
4710
|
}
|
|
4113
4711
|
}
|
|
4114
4712
|
],
|
|
@@ -4127,6 +4725,41 @@
|
|
|
4127
4725
|
},
|
|
4128
4726
|
"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
4727
|
},
|
|
4728
|
+
{
|
|
4729
|
+
"type": {
|
|
4730
|
+
"text": "PointerEvent"
|
|
4731
|
+
},
|
|
4732
|
+
"description": "Fired when a pointer button is pressed over the model.",
|
|
4733
|
+
"name": "pointerdown"
|
|
4734
|
+
},
|
|
4735
|
+
{
|
|
4736
|
+
"type": {
|
|
4737
|
+
"text": "PointerEvent"
|
|
4738
|
+
},
|
|
4739
|
+
"description": "Fired when the pointer moves onto the model.",
|
|
4740
|
+
"name": "pointerenter"
|
|
4741
|
+
},
|
|
4742
|
+
{
|
|
4743
|
+
"type": {
|
|
4744
|
+
"text": "PointerEvent"
|
|
4745
|
+
},
|
|
4746
|
+
"description": "Fired when the pointer moves off the model.",
|
|
4747
|
+
"name": "pointerleave"
|
|
4748
|
+
},
|
|
4749
|
+
{
|
|
4750
|
+
"type": {
|
|
4751
|
+
"text": "PointerEvent"
|
|
4752
|
+
},
|
|
4753
|
+
"description": "Fired when the pointer moves over the model.",
|
|
4754
|
+
"name": "pointermove"
|
|
4755
|
+
},
|
|
4756
|
+
{
|
|
4757
|
+
"type": {
|
|
4758
|
+
"text": "PointerEvent"
|
|
4759
|
+
},
|
|
4760
|
+
"description": "Fired when a pointer button is released over the model.",
|
|
4761
|
+
"name": "pointerup"
|
|
4762
|
+
},
|
|
4130
4763
|
{
|
|
4131
4764
|
"name": "ready",
|
|
4132
4765
|
"type": {
|
|
@@ -4147,177 +4780,140 @@
|
|
|
4147
4780
|
},
|
|
4148
4781
|
"fieldName": "asset",
|
|
4149
4782
|
"description": "The id of the `pc-asset` to use for the model."
|
|
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": [
|
|
4783
|
+
},
|
|
4204
4784
|
{
|
|
4205
|
-
"
|
|
4206
|
-
"name": "closestApp",
|
|
4785
|
+
"name": "enabled",
|
|
4207
4786
|
"type": {
|
|
4208
|
-
"text": "
|
|
4787
|
+
"text": "boolean"
|
|
4209
4788
|
},
|
|
4210
|
-
"description": "The
|
|
4211
|
-
"
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4789
|
+
"description": "The enabled state of the model.",
|
|
4790
|
+
"fieldName": "enabled",
|
|
4791
|
+
"default": "true"
|
|
4792
|
+
},
|
|
4793
|
+
{
|
|
4794
|
+
"name": "name",
|
|
4795
|
+
"type": {
|
|
4796
|
+
"text": "string"
|
|
4215
4797
|
},
|
|
4216
|
-
"
|
|
4217
|
-
"
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4798
|
+
"description": "The name of the model.",
|
|
4799
|
+
"fieldName": "name"
|
|
4800
|
+
},
|
|
4801
|
+
{
|
|
4802
|
+
"type": {
|
|
4803
|
+
"text": "string"
|
|
4804
|
+
},
|
|
4805
|
+
"description": "Script to run when a pointer button is pressed over the model.",
|
|
4806
|
+
"name": "onpointerdown",
|
|
4807
|
+
"fieldName": "onpointerdown"
|
|
4808
|
+
},
|
|
4809
|
+
{
|
|
4810
|
+
"type": {
|
|
4811
|
+
"text": "string"
|
|
4812
|
+
},
|
|
4813
|
+
"description": "Script to run when the pointer moves onto the model.",
|
|
4814
|
+
"name": "onpointerenter",
|
|
4815
|
+
"fieldName": "onpointerenter"
|
|
4221
4816
|
},
|
|
4222
4817
|
{
|
|
4223
|
-
"kind": "field",
|
|
4224
|
-
"name": "closestEntity",
|
|
4225
4818
|
"type": {
|
|
4226
|
-
"text": "
|
|
4819
|
+
"text": "string"
|
|
4227
4820
|
},
|
|
4228
|
-
"description": "
|
|
4229
|
-
"
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
|
|
4821
|
+
"description": "Script to run when the pointer moves off the model.",
|
|
4822
|
+
"name": "onpointerleave",
|
|
4823
|
+
"fieldName": "onpointerleave"
|
|
4824
|
+
},
|
|
4825
|
+
{
|
|
4826
|
+
"type": {
|
|
4827
|
+
"text": "string"
|
|
4233
4828
|
},
|
|
4234
|
-
"
|
|
4235
|
-
"
|
|
4236
|
-
|
|
4237
|
-
"module": "src/async-element.ts"
|
|
4238
|
-
}
|
|
4829
|
+
"description": "Script to run when the pointer moves over the model.",
|
|
4830
|
+
"name": "onpointermove",
|
|
4831
|
+
"fieldName": "onpointermove"
|
|
4239
4832
|
},
|
|
4240
4833
|
{
|
|
4241
|
-
"
|
|
4242
|
-
|
|
4243
|
-
"return": {
|
|
4244
|
-
"type": {
|
|
4245
|
-
"text": ""
|
|
4246
|
-
}
|
|
4834
|
+
"type": {
|
|
4835
|
+
"text": "string"
|
|
4247
4836
|
},
|
|
4248
|
-
"description": "
|
|
4249
|
-
"
|
|
4250
|
-
|
|
4251
|
-
|
|
4252
|
-
}
|
|
4253
|
-
}
|
|
4254
|
-
],
|
|
4255
|
-
"attributes": [
|
|
4837
|
+
"description": "Script to run when a pointer button is released over the model.",
|
|
4838
|
+
"name": "onpointerup",
|
|
4839
|
+
"fieldName": "onpointerup"
|
|
4840
|
+
},
|
|
4256
4841
|
{
|
|
4842
|
+
"name": "position",
|
|
4257
4843
|
"type": {
|
|
4258
4844
|
"text": "string"
|
|
4259
4845
|
},
|
|
4260
|
-
"description": "The
|
|
4261
|
-
"
|
|
4846
|
+
"description": "The position of the model. Accepts 3 space-separated numbers.",
|
|
4847
|
+
"fieldName": "position",
|
|
4848
|
+
"default": "0 0 0"
|
|
4262
4849
|
},
|
|
4263
4850
|
{
|
|
4851
|
+
"name": "rotation",
|
|
4264
4852
|
"type": {
|
|
4265
4853
|
"text": "string"
|
|
4266
4854
|
},
|
|
4267
|
-
"description": "The
|
|
4268
|
-
"
|
|
4855
|
+
"description": "The rotation of the model. Accepts 3 space-separated numbers.",
|
|
4856
|
+
"fieldName": "rotation",
|
|
4857
|
+
"default": "0 0 0"
|
|
4269
4858
|
},
|
|
4270
4859
|
{
|
|
4860
|
+
"name": "scale",
|
|
4271
4861
|
"type": {
|
|
4272
4862
|
"text": "string"
|
|
4273
4863
|
},
|
|
4274
|
-
"description": "The
|
|
4275
|
-
"
|
|
4864
|
+
"description": "The scale of the model. Accepts 3 space-separated numbers.",
|
|
4865
|
+
"fieldName": "scale",
|
|
4866
|
+
"default": "1 1 1"
|
|
4276
4867
|
},
|
|
4277
4868
|
{
|
|
4869
|
+
"name": "tags",
|
|
4278
4870
|
"type": {
|
|
4279
4871
|
"text": "string"
|
|
4280
4872
|
},
|
|
4281
|
-
"description": "The
|
|
4282
|
-
"
|
|
4873
|
+
"description": "The tags of the model.",
|
|
4874
|
+
"fieldName": "tags"
|
|
4283
4875
|
}
|
|
4284
4876
|
],
|
|
4285
4877
|
"superclass": {
|
|
4286
|
-
"name": "
|
|
4287
|
-
"module": "/src/
|
|
4878
|
+
"name": "EntityOwnerElement",
|
|
4879
|
+
"module": "/src/entity-owner"
|
|
4288
4880
|
},
|
|
4289
|
-
"
|
|
4290
|
-
"
|
|
4291
|
-
"
|
|
4292
|
-
{
|
|
4293
|
-
"name": "ready",
|
|
4294
|
-
"type": {
|
|
4295
|
-
"text": "CustomEvent"
|
|
4296
|
-
},
|
|
4297
|
-
"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.",
|
|
4298
|
-
"inheritedFrom": {
|
|
4299
|
-
"name": "AsyncElement",
|
|
4300
|
-
"module": "src/async-element.ts"
|
|
4301
|
-
}
|
|
4302
|
-
}
|
|
4303
|
-
]
|
|
4881
|
+
"summary": "The `<pc-model>` element instantiates a 3D model from a container asset\n(typically a GLB) beneath an entity of its own, so the element's transform and tags place the\ninstance in the scene. Its `<pc-node>` children override what the asset authored. Place it in the\n`<pc-scene>`, or nest it under a `<pc-entity>`, another `<pc-model>` or a `<pc-node>`.\n",
|
|
4882
|
+
"tagName": "pc-model",
|
|
4883
|
+
"customElement": true
|
|
4304
4884
|
}
|
|
4305
4885
|
],
|
|
4306
4886
|
"exports": [
|
|
4307
4887
|
{
|
|
4308
4888
|
"kind": "custom-element-definition",
|
|
4309
|
-
"name": "pc-
|
|
4889
|
+
"name": "pc-model",
|
|
4890
|
+
"declaration": {
|
|
4891
|
+
"name": "ModelElement",
|
|
4892
|
+
"module": "src/model.ts"
|
|
4893
|
+
}
|
|
4894
|
+
},
|
|
4895
|
+
{
|
|
4896
|
+
"kind": "js",
|
|
4897
|
+
"name": "ModelElement",
|
|
4898
|
+
"declaration": {
|
|
4899
|
+
"name": "ModelElement",
|
|
4900
|
+
"module": "src/model.ts"
|
|
4901
|
+
}
|
|
4902
|
+
},
|
|
4903
|
+
{
|
|
4904
|
+
"kind": "js",
|
|
4905
|
+
"name": "HierarchyMaterial",
|
|
4310
4906
|
"declaration": {
|
|
4311
|
-
"name": "
|
|
4312
|
-
"module": "src/
|
|
4907
|
+
"name": "HierarchyMaterial",
|
|
4908
|
+
"module": "src/model.ts"
|
|
4313
4909
|
}
|
|
4314
4910
|
},
|
|
4315
4911
|
{
|
|
4316
4912
|
"kind": "js",
|
|
4317
|
-
"name": "
|
|
4913
|
+
"name": "HierarchyNode",
|
|
4318
4914
|
"declaration": {
|
|
4319
|
-
"name": "
|
|
4320
|
-
"module": "src/
|
|
4915
|
+
"name": "HierarchyNode",
|
|
4916
|
+
"module": "src/model.ts"
|
|
4321
4917
|
}
|
|
4322
4918
|
}
|
|
4323
4919
|
]
|
|
@@ -4384,7 +4980,7 @@
|
|
|
4384
4980
|
"type": {
|
|
4385
4981
|
"text": "EntityBaseElement | null"
|
|
4386
4982
|
},
|
|
4387
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
4983
|
+
"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
4984
|
"return": {
|
|
4389
4985
|
"type": {
|
|
4390
4986
|
"text": ""
|
|
@@ -4796,6 +5392,7 @@
|
|
|
4796
5392
|
"name": "EntityBaseElement",
|
|
4797
5393
|
"module": "/src/entity-base"
|
|
4798
5394
|
},
|
|
5395
|
+
"summary": "The `<pc-node>` element binds to a node inside the hierarchy a `<pc-model>`\ninstantiated and declares overrides against it: a transform, an enabled state, tags, components\nto add, or content to attach. Its `name` is a lookup, never a rename. Must be a descendant of\n`<pc-model>`.\n",
|
|
4799
5396
|
"tagName": "pc-node",
|
|
4800
5397
|
"customElement": true
|
|
4801
5398
|
}
|
|
@@ -4860,7 +5457,7 @@
|
|
|
4860
5457
|
"type": {
|
|
4861
5458
|
"text": "EntityBaseElement | null"
|
|
4862
5459
|
},
|
|
4863
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
5460
|
+
"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
5461
|
"return": {
|
|
4865
5462
|
"type": {
|
|
4866
5463
|
"text": ""
|
|
@@ -5057,6 +5654,7 @@
|
|
|
5057
5654
|
"name": "AsyncElement",
|
|
5058
5655
|
"module": "/src/async-element"
|
|
5059
5656
|
},
|
|
5657
|
+
"summary": "The `<pc-scene>` element holds the entity hierarchy the application renders,\nalong with the scene-wide fog and gravity settings. Must be a direct child of `<pc-app>`.\n",
|
|
5060
5658
|
"tagName": "pc-scene",
|
|
5061
5659
|
"customElement": true,
|
|
5062
5660
|
"events": [
|
|
@@ -5158,7 +5756,7 @@
|
|
|
5158
5756
|
"type": {
|
|
5159
5757
|
"text": "EntityBaseElement | null"
|
|
5160
5758
|
},
|
|
5161
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
5759
|
+
"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
5760
|
"return": {
|
|
5163
5761
|
"type": {
|
|
5164
5762
|
"text": ""
|
|
@@ -5250,115 +5848,247 @@
|
|
|
5250
5848
|
},
|
|
5251
5849
|
{
|
|
5252
5850
|
"kind": "field",
|
|
5253
|
-
"name": "scale",
|
|
5254
|
-
"description": "Gets the scale of the skybox.",
|
|
5255
|
-
"parameters": [
|
|
5256
|
-
{
|
|
5257
|
-
"description": "The scale.",
|
|
5258
|
-
"name": "value"
|
|
5259
|
-
}
|
|
5260
|
-
],
|
|
5851
|
+
"name": "scale",
|
|
5852
|
+
"description": "Gets the scale of the skybox.",
|
|
5853
|
+
"parameters": [
|
|
5854
|
+
{
|
|
5855
|
+
"description": "The scale.",
|
|
5856
|
+
"name": "value"
|
|
5857
|
+
}
|
|
5858
|
+
],
|
|
5859
|
+
"return": {
|
|
5860
|
+
"type": {
|
|
5861
|
+
"text": ""
|
|
5862
|
+
}
|
|
5863
|
+
}
|
|
5864
|
+
},
|
|
5865
|
+
{
|
|
5866
|
+
"kind": "field",
|
|
5867
|
+
"name": "type",
|
|
5868
|
+
"description": "Gets the type of the skybox.",
|
|
5869
|
+
"parameters": [
|
|
5870
|
+
{
|
|
5871
|
+
"description": "The type.",
|
|
5872
|
+
"name": "value"
|
|
5873
|
+
}
|
|
5874
|
+
],
|
|
5875
|
+
"return": {
|
|
5876
|
+
"type": {
|
|
5877
|
+
"text": ""
|
|
5878
|
+
}
|
|
5879
|
+
}
|
|
5880
|
+
}
|
|
5881
|
+
],
|
|
5882
|
+
"attributes": [
|
|
5883
|
+
{
|
|
5884
|
+
"name": "asset",
|
|
5885
|
+
"type": {
|
|
5886
|
+
"text": "string"
|
|
5887
|
+
},
|
|
5888
|
+
"fieldName": "asset",
|
|
5889
|
+
"description": "The id of the `pc-asset` to use for the skybox."
|
|
5890
|
+
},
|
|
5891
|
+
{
|
|
5892
|
+
"name": "center",
|
|
5893
|
+
"type": {
|
|
5894
|
+
"text": "string"
|
|
5895
|
+
},
|
|
5896
|
+
"fieldName": "center",
|
|
5897
|
+
"default": "0 0.01 0",
|
|
5898
|
+
"description": "The center of the skybox. Accepts 3 space-separated numbers."
|
|
5899
|
+
},
|
|
5900
|
+
{
|
|
5901
|
+
"name": "intensity",
|
|
5902
|
+
"type": {
|
|
5903
|
+
"text": "number"
|
|
5904
|
+
},
|
|
5905
|
+
"fieldName": "intensity",
|
|
5906
|
+
"default": "1",
|
|
5907
|
+
"description": "The intensity of the skybox."
|
|
5908
|
+
},
|
|
5909
|
+
{
|
|
5910
|
+
"name": "lighting",
|
|
5911
|
+
"type": {
|
|
5912
|
+
"text": "boolean"
|
|
5913
|
+
},
|
|
5914
|
+
"fieldName": "lighting",
|
|
5915
|
+
"default": "false",
|
|
5916
|
+
"description": "Whether the skybox is used as a light source."
|
|
5917
|
+
},
|
|
5918
|
+
{
|
|
5919
|
+
"name": "mip-level",
|
|
5920
|
+
"type": {
|
|
5921
|
+
"text": "number"
|
|
5922
|
+
},
|
|
5923
|
+
"fieldName": "mipLevel",
|
|
5924
|
+
"default": "0",
|
|
5925
|
+
"description": "The mip level of the skybox."
|
|
5926
|
+
},
|
|
5927
|
+
{
|
|
5928
|
+
"name": "rotation",
|
|
5929
|
+
"type": {
|
|
5930
|
+
"text": "string"
|
|
5931
|
+
},
|
|
5932
|
+
"fieldName": "rotation",
|
|
5933
|
+
"default": "0 0 0",
|
|
5934
|
+
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers."
|
|
5935
|
+
},
|
|
5936
|
+
{
|
|
5937
|
+
"name": "scale",
|
|
5938
|
+
"type": {
|
|
5939
|
+
"text": "string"
|
|
5940
|
+
},
|
|
5941
|
+
"fieldName": "scale",
|
|
5942
|
+
"default": "100 100 100",
|
|
5943
|
+
"description": "The scale of the skybox. Accepts 3 space-separated numbers."
|
|
5944
|
+
},
|
|
5945
|
+
{
|
|
5946
|
+
"name": "type",
|
|
5947
|
+
"type": {
|
|
5948
|
+
"text": "'box' | 'dome' | 'infinite' | 'none'"
|
|
5949
|
+
},
|
|
5950
|
+
"fieldName": "type",
|
|
5951
|
+
"default": "infinite",
|
|
5952
|
+
"description": "The type of the skybox."
|
|
5953
|
+
}
|
|
5954
|
+
],
|
|
5955
|
+
"superclass": {
|
|
5956
|
+
"name": "AsyncElement",
|
|
5957
|
+
"module": "/src/async-element"
|
|
5958
|
+
},
|
|
5959
|
+
"summary": "The `<pc-sky>` element renders a skybox from a texture asset, projected as an\ninfinite background, a box or a dome, and optionally lights the scene from it. Must be a direct\nchild of `<pc-scene>`.\n",
|
|
5960
|
+
"tagName": "pc-sky",
|
|
5961
|
+
"customElement": true,
|
|
5962
|
+
"events": [
|
|
5963
|
+
{
|
|
5964
|
+
"name": "ready",
|
|
5965
|
+
"type": {
|
|
5966
|
+
"text": "CustomEvent"
|
|
5967
|
+
},
|
|
5968
|
+
"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.",
|
|
5969
|
+
"inheritedFrom": {
|
|
5970
|
+
"name": "AsyncElement",
|
|
5971
|
+
"module": "src/async-element.ts"
|
|
5972
|
+
}
|
|
5973
|
+
}
|
|
5974
|
+
]
|
|
5975
|
+
}
|
|
5976
|
+
],
|
|
5977
|
+
"exports": [
|
|
5978
|
+
{
|
|
5979
|
+
"kind": "custom-element-definition",
|
|
5980
|
+
"name": "pc-sky",
|
|
5981
|
+
"declaration": {
|
|
5982
|
+
"name": "SkyElement",
|
|
5983
|
+
"module": "src/sky.ts"
|
|
5984
|
+
}
|
|
5985
|
+
},
|
|
5986
|
+
{
|
|
5987
|
+
"kind": "js",
|
|
5988
|
+
"name": "SkyElement",
|
|
5989
|
+
"declaration": {
|
|
5990
|
+
"name": "SkyElement",
|
|
5991
|
+
"module": "src/sky.ts"
|
|
5992
|
+
}
|
|
5993
|
+
}
|
|
5994
|
+
]
|
|
5995
|
+
},
|
|
5996
|
+
{
|
|
5997
|
+
"kind": "javascript-module",
|
|
5998
|
+
"path": "src/wasm.ts",
|
|
5999
|
+
"declarations": [
|
|
6000
|
+
{
|
|
6001
|
+
"kind": "class",
|
|
6002
|
+
"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",
|
|
6003
|
+
"name": "WasmElement",
|
|
6004
|
+
"members": [
|
|
6005
|
+
{
|
|
6006
|
+
"kind": "field",
|
|
6007
|
+
"name": "closestApp",
|
|
6008
|
+
"type": {
|
|
6009
|
+
"text": "AppElement | null"
|
|
6010
|
+
},
|
|
6011
|
+
"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.",
|
|
6012
|
+
"return": {
|
|
6013
|
+
"type": {
|
|
6014
|
+
"text": ""
|
|
6015
|
+
}
|
|
6016
|
+
},
|
|
6017
|
+
"readonly": true,
|
|
6018
|
+
"inheritedFrom": {
|
|
6019
|
+
"name": "AsyncElement",
|
|
6020
|
+
"module": "src/async-element.ts"
|
|
6021
|
+
}
|
|
6022
|
+
},
|
|
6023
|
+
{
|
|
6024
|
+
"kind": "field",
|
|
6025
|
+
"name": "closestEntity",
|
|
6026
|
+
"type": {
|
|
6027
|
+
"text": "EntityBaseElement | null"
|
|
6028
|
+
},
|
|
6029
|
+
"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.",
|
|
5261
6030
|
"return": {
|
|
5262
6031
|
"type": {
|
|
5263
6032
|
"text": ""
|
|
5264
6033
|
}
|
|
6034
|
+
},
|
|
6035
|
+
"readonly": true,
|
|
6036
|
+
"inheritedFrom": {
|
|
6037
|
+
"name": "AsyncElement",
|
|
6038
|
+
"module": "src/async-element.ts"
|
|
5265
6039
|
}
|
|
5266
6040
|
},
|
|
5267
6041
|
{
|
|
5268
|
-
"kind": "
|
|
5269
|
-
"name": "
|
|
5270
|
-
"description": "Gets the type of the skybox.",
|
|
5271
|
-
"parameters": [
|
|
5272
|
-
{
|
|
5273
|
-
"description": "The type.",
|
|
5274
|
-
"name": "value"
|
|
5275
|
-
}
|
|
5276
|
-
],
|
|
6042
|
+
"kind": "method",
|
|
6043
|
+
"name": "ready",
|
|
5277
6044
|
"return": {
|
|
5278
6045
|
"type": {
|
|
5279
6046
|
"text": ""
|
|
5280
6047
|
}
|
|
6048
|
+
},
|
|
6049
|
+
"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.",
|
|
6050
|
+
"inheritedFrom": {
|
|
6051
|
+
"name": "AsyncElement",
|
|
6052
|
+
"module": "src/async-element.ts"
|
|
5281
6053
|
}
|
|
5282
6054
|
}
|
|
5283
6055
|
],
|
|
5284
6056
|
"attributes": [
|
|
5285
6057
|
{
|
|
5286
|
-
"name": "asset",
|
|
5287
6058
|
"type": {
|
|
5288
6059
|
"text": "string"
|
|
5289
6060
|
},
|
|
5290
|
-
"
|
|
5291
|
-
"
|
|
6061
|
+
"description": "The URL of the module's asm.js fallback script, used when WebAssembly is unavailable.",
|
|
6062
|
+
"name": "fallback"
|
|
5292
6063
|
},
|
|
5293
6064
|
{
|
|
5294
|
-
"name": "center",
|
|
5295
6065
|
"type": {
|
|
5296
6066
|
"text": "string"
|
|
5297
6067
|
},
|
|
5298
|
-
"
|
|
5299
|
-
"
|
|
5300
|
-
"description": "The center of the skybox. Accepts 3 space-separated numbers."
|
|
5301
|
-
},
|
|
5302
|
-
{
|
|
5303
|
-
"name": "intensity",
|
|
5304
|
-
"type": {
|
|
5305
|
-
"text": "number"
|
|
5306
|
-
},
|
|
5307
|
-
"fieldName": "intensity",
|
|
5308
|
-
"default": "1",
|
|
5309
|
-
"description": "The intensity of the skybox."
|
|
5310
|
-
},
|
|
5311
|
-
{
|
|
5312
|
-
"name": "lighting",
|
|
5313
|
-
"type": {
|
|
5314
|
-
"text": "boolean"
|
|
5315
|
-
},
|
|
5316
|
-
"fieldName": "lighting",
|
|
5317
|
-
"default": "false",
|
|
5318
|
-
"description": "Whether the skybox is used as a light source."
|
|
5319
|
-
},
|
|
5320
|
-
{
|
|
5321
|
-
"name": "mip-level",
|
|
5322
|
-
"type": {
|
|
5323
|
-
"text": "number"
|
|
5324
|
-
},
|
|
5325
|
-
"fieldName": "mipLevel",
|
|
5326
|
-
"default": "0",
|
|
5327
|
-
"description": "The mip level of the skybox."
|
|
6068
|
+
"description": "The URL of the module's glue script.",
|
|
6069
|
+
"name": "glue"
|
|
5328
6070
|
},
|
|
5329
6071
|
{
|
|
5330
|
-
"name": "rotation",
|
|
5331
6072
|
"type": {
|
|
5332
6073
|
"text": "string"
|
|
5333
6074
|
},
|
|
5334
|
-
"
|
|
5335
|
-
"
|
|
5336
|
-
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers."
|
|
6075
|
+
"description": "The name of the WebAssembly module to configure, e.g. `Basis` or `Ammo`.",
|
|
6076
|
+
"name": "name"
|
|
5337
6077
|
},
|
|
5338
6078
|
{
|
|
5339
|
-
"name": "scale",
|
|
5340
6079
|
"type": {
|
|
5341
6080
|
"text": "string"
|
|
5342
6081
|
},
|
|
5343
|
-
"
|
|
5344
|
-
"
|
|
5345
|
-
"description": "The scale of the skybox. Accepts 3 space-separated numbers."
|
|
5346
|
-
},
|
|
5347
|
-
{
|
|
5348
|
-
"name": "type",
|
|
5349
|
-
"type": {
|
|
5350
|
-
"text": "'box' | 'dome' | 'infinite' | 'none'"
|
|
5351
|
-
},
|
|
5352
|
-
"fieldName": "type",
|
|
5353
|
-
"default": "infinite",
|
|
5354
|
-
"description": "The type of the skybox."
|
|
6082
|
+
"description": "The URL of the module's WebAssembly binary.",
|
|
6083
|
+
"name": "wasm"
|
|
5355
6084
|
}
|
|
5356
6085
|
],
|
|
5357
6086
|
"superclass": {
|
|
5358
6087
|
"name": "AsyncElement",
|
|
5359
6088
|
"module": "/src/async-element"
|
|
5360
6089
|
},
|
|
5361
|
-
"
|
|
6090
|
+
"summary": "The `<pc-wasm>` element loads a WebAssembly module the engine needs before the\napplication starts — `Ammo` for physics, `Basis` or `DracoDecoderModule` for compressed assets.\nMust be a direct child of `<pc-app>`.\n",
|
|
6091
|
+
"tagName": "pc-wasm",
|
|
5362
6092
|
"customElement": true,
|
|
5363
6093
|
"events": [
|
|
5364
6094
|
{
|
|
@@ -5378,18 +6108,18 @@
|
|
|
5378
6108
|
"exports": [
|
|
5379
6109
|
{
|
|
5380
6110
|
"kind": "custom-element-definition",
|
|
5381
|
-
"name": "pc-
|
|
6111
|
+
"name": "pc-wasm",
|
|
5382
6112
|
"declaration": {
|
|
5383
|
-
"name": "
|
|
5384
|
-
"module": "src/
|
|
6113
|
+
"name": "WasmElement",
|
|
6114
|
+
"module": "src/wasm.ts"
|
|
5385
6115
|
}
|
|
5386
6116
|
},
|
|
5387
6117
|
{
|
|
5388
6118
|
"kind": "js",
|
|
5389
|
-
"name": "
|
|
6119
|
+
"name": "WasmElement",
|
|
5390
6120
|
"declaration": {
|
|
5391
|
-
"name": "
|
|
5392
|
-
"module": "src/
|
|
6121
|
+
"name": "WasmElement",
|
|
6122
|
+
"module": "src/wasm.ts"
|
|
5393
6123
|
}
|
|
5394
6124
|
}
|
|
5395
6125
|
]
|
|
@@ -5443,7 +6173,7 @@
|
|
|
5443
6173
|
"type": {
|
|
5444
6174
|
"text": "EntityBaseElement | null"
|
|
5445
6175
|
},
|
|
5446
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6176
|
+
"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
6177
|
"return": {
|
|
5448
6178
|
"type": {
|
|
5449
6179
|
"text": ""
|
|
@@ -5558,6 +6288,7 @@
|
|
|
5558
6288
|
"name": "AsyncElement",
|
|
5559
6289
|
"module": "/src/async-element"
|
|
5560
6290
|
},
|
|
6291
|
+
"summary": "The `<pc-anim-clip>` element declares one named animation clip on its parent\n`<pc-anim>`, taken from the `asset` it names or, without one, from the enclosing `<pc-model>`'s\nown animations. Must be a direct child of `<pc-anim>`.\n",
|
|
5561
6292
|
"tagName": "pc-anim-clip",
|
|
5562
6293
|
"customElement": true,
|
|
5563
6294
|
"events": [
|
|
@@ -5600,7 +6331,7 @@
|
|
|
5600
6331
|
"declarations": [
|
|
5601
6332
|
{
|
|
5602
6333
|
"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",
|
|
6334
|
+
"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
6335
|
"name": "AnimComponentElement",
|
|
5605
6336
|
"members": [
|
|
5606
6337
|
{
|
|
@@ -5673,7 +6404,7 @@
|
|
|
5673
6404
|
"type": {
|
|
5674
6405
|
"text": "EntityBaseElement | null"
|
|
5675
6406
|
},
|
|
5676
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6407
|
+
"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
6408
|
"return": {
|
|
5678
6409
|
"type": {
|
|
5679
6410
|
"text": ""
|
|
@@ -5866,6 +6597,7 @@
|
|
|
5866
6597
|
"name": "ComponentElement",
|
|
5867
6598
|
"module": "/src/components/component"
|
|
5868
6599
|
},
|
|
6600
|
+
"summary": "The `<pc-anim>` element plays animation clips over its entity's hierarchy, taken\nfrom `<pc-anim-clip>` children or from the enclosing `<pc-model>`'s own animations. The first\nclip plays automatically, and the `clip` attribute switches between them. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
5869
6601
|
"tagName": "pc-anim",
|
|
5870
6602
|
"customElement": true,
|
|
5871
6603
|
"events": [
|
|
@@ -5902,10 +6634,164 @@
|
|
|
5902
6634
|
},
|
|
5903
6635
|
{
|
|
5904
6636
|
"kind": "js",
|
|
5905
|
-
"name": "ContainerWithAnimations",
|
|
6637
|
+
"name": "ContainerWithAnimations",
|
|
6638
|
+
"declaration": {
|
|
6639
|
+
"name": "ContainerWithAnimations",
|
|
6640
|
+
"module": "src/components/anim-component.ts"
|
|
6641
|
+
}
|
|
6642
|
+
}
|
|
6643
|
+
]
|
|
6644
|
+
},
|
|
6645
|
+
{
|
|
6646
|
+
"kind": "javascript-module",
|
|
6647
|
+
"path": "src/components/audio-listener-component.ts",
|
|
6648
|
+
"declarations": [
|
|
6649
|
+
{
|
|
6650
|
+
"kind": "class",
|
|
6651
|
+
"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",
|
|
6652
|
+
"name": "AudioListenerComponentElement",
|
|
6653
|
+
"members": [
|
|
6654
|
+
{
|
|
6655
|
+
"kind": "field",
|
|
6656
|
+
"name": "closestApp",
|
|
6657
|
+
"type": {
|
|
6658
|
+
"text": "AppElement | null"
|
|
6659
|
+
},
|
|
6660
|
+
"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.",
|
|
6661
|
+
"return": {
|
|
6662
|
+
"type": {
|
|
6663
|
+
"text": ""
|
|
6664
|
+
}
|
|
6665
|
+
},
|
|
6666
|
+
"readonly": true,
|
|
6667
|
+
"inheritedFrom": {
|
|
6668
|
+
"name": "AsyncElement",
|
|
6669
|
+
"module": "src/async-element.ts"
|
|
6670
|
+
}
|
|
6671
|
+
},
|
|
6672
|
+
{
|
|
6673
|
+
"kind": "field",
|
|
6674
|
+
"name": "closestEntity",
|
|
6675
|
+
"type": {
|
|
6676
|
+
"text": "EntityBaseElement | null"
|
|
6677
|
+
},
|
|
6678
|
+
"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.",
|
|
6679
|
+
"return": {
|
|
6680
|
+
"type": {
|
|
6681
|
+
"text": ""
|
|
6682
|
+
}
|
|
6683
|
+
},
|
|
6684
|
+
"readonly": true,
|
|
6685
|
+
"inheritedFrom": {
|
|
6686
|
+
"name": "AsyncElement",
|
|
6687
|
+
"module": "src/async-element.ts"
|
|
6688
|
+
}
|
|
6689
|
+
},
|
|
6690
|
+
{
|
|
6691
|
+
"kind": "field",
|
|
6692
|
+
"name": "component",
|
|
6693
|
+
"type": {
|
|
6694
|
+
"text": "Component | null"
|
|
6695
|
+
},
|
|
6696
|
+
"description": "Gets the underlying PlayCanvas audio listener component.",
|
|
6697
|
+
"return": {
|
|
6698
|
+
"type": {
|
|
6699
|
+
"text": ""
|
|
6700
|
+
}
|
|
6701
|
+
},
|
|
6702
|
+
"readonly": true,
|
|
6703
|
+
"inheritedFrom": {
|
|
6704
|
+
"name": "ComponentElement",
|
|
6705
|
+
"module": "src/components/component.ts"
|
|
6706
|
+
}
|
|
6707
|
+
},
|
|
6708
|
+
{
|
|
6709
|
+
"kind": "field",
|
|
6710
|
+
"name": "enabled",
|
|
6711
|
+
"description": "Gets the enabled state of the component.",
|
|
6712
|
+
"parameters": [
|
|
6713
|
+
{
|
|
6714
|
+
"description": "The enabled state of the component.",
|
|
6715
|
+
"name": "value"
|
|
6716
|
+
}
|
|
6717
|
+
],
|
|
6718
|
+
"return": {
|
|
6719
|
+
"type": {
|
|
6720
|
+
"text": ""
|
|
6721
|
+
}
|
|
6722
|
+
},
|
|
6723
|
+
"inheritedFrom": {
|
|
6724
|
+
"name": "ComponentElement",
|
|
6725
|
+
"module": "src/components/component.ts"
|
|
6726
|
+
}
|
|
6727
|
+
},
|
|
6728
|
+
{
|
|
6729
|
+
"kind": "method",
|
|
6730
|
+
"name": "ready",
|
|
6731
|
+
"return": {
|
|
6732
|
+
"type": {
|
|
6733
|
+
"text": ""
|
|
6734
|
+
}
|
|
6735
|
+
},
|
|
6736
|
+
"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.",
|
|
6737
|
+
"inheritedFrom": {
|
|
6738
|
+
"name": "AsyncElement",
|
|
6739
|
+
"module": "src/async-element.ts"
|
|
6740
|
+
}
|
|
6741
|
+
}
|
|
6742
|
+
],
|
|
6743
|
+
"superclass": {
|
|
6744
|
+
"name": "ComponentElement",
|
|
6745
|
+
"module": "/src/components/component"
|
|
6746
|
+
},
|
|
6747
|
+
"summary": "The `<pc-audio-listener>` element makes its entity the point from which\npositional sounds are heard, typically the entity holding the `<pc-camera>`. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
6748
|
+
"tagName": "pc-audio-listener",
|
|
6749
|
+
"customElement": true,
|
|
6750
|
+
"attributes": [
|
|
6751
|
+
{
|
|
6752
|
+
"name": "enabled",
|
|
6753
|
+
"type": {
|
|
6754
|
+
"text": "boolean"
|
|
6755
|
+
},
|
|
6756
|
+
"fieldName": "enabled",
|
|
6757
|
+
"default": "true",
|
|
6758
|
+
"description": "The enabled state of the component.",
|
|
6759
|
+
"inheritedFrom": {
|
|
6760
|
+
"name": "ComponentElement",
|
|
6761
|
+
"module": "src/components/component.ts"
|
|
6762
|
+
}
|
|
6763
|
+
}
|
|
6764
|
+
],
|
|
6765
|
+
"events": [
|
|
6766
|
+
{
|
|
6767
|
+
"name": "ready",
|
|
6768
|
+
"type": {
|
|
6769
|
+
"text": "CustomEvent"
|
|
6770
|
+
},
|
|
6771
|
+
"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.",
|
|
6772
|
+
"inheritedFrom": {
|
|
6773
|
+
"name": "AsyncElement",
|
|
6774
|
+
"module": "src/async-element.ts"
|
|
6775
|
+
}
|
|
6776
|
+
}
|
|
6777
|
+
]
|
|
6778
|
+
}
|
|
6779
|
+
],
|
|
6780
|
+
"exports": [
|
|
6781
|
+
{
|
|
6782
|
+
"kind": "custom-element-definition",
|
|
6783
|
+
"name": "pc-audio-listener",
|
|
6784
|
+
"declaration": {
|
|
6785
|
+
"name": "AudioListenerComponentElement",
|
|
6786
|
+
"module": "src/components/audio-listener-component.ts"
|
|
6787
|
+
}
|
|
6788
|
+
},
|
|
6789
|
+
{
|
|
6790
|
+
"kind": "js",
|
|
6791
|
+
"name": "AudioListenerComponentElement",
|
|
5906
6792
|
"declaration": {
|
|
5907
|
-
"name": "
|
|
5908
|
-
"module": "src/components/
|
|
6793
|
+
"name": "AudioListenerComponentElement",
|
|
6794
|
+
"module": "src/components/audio-listener-component.ts"
|
|
5909
6795
|
}
|
|
5910
6796
|
}
|
|
5911
6797
|
]
|
|
@@ -5916,7 +6802,7 @@
|
|
|
5916
6802
|
"declarations": [
|
|
5917
6803
|
{
|
|
5918
6804
|
"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",
|
|
6805
|
+
"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
6806
|
"name": "ButtonComponentElement",
|
|
5921
6807
|
"members": [
|
|
5922
6808
|
{
|
|
@@ -5959,7 +6845,7 @@
|
|
|
5959
6845
|
"type": {
|
|
5960
6846
|
"text": "EntityBaseElement | null"
|
|
5961
6847
|
},
|
|
5962
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
6848
|
+
"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
6849
|
"return": {
|
|
5964
6850
|
"type": {
|
|
5965
6851
|
"text": ""
|
|
@@ -6373,6 +7259,7 @@
|
|
|
6373
7259
|
"name": "ComponentElement",
|
|
6374
7260
|
"module": "/src/components/component"
|
|
6375
7261
|
},
|
|
7262
|
+
"summary": "The `<pc-button>` element makes its entity respond to pointer input, tinting or\nswapping its image as the pointer hovers, presses and releases it. The entity also needs a\n`<pc-element>` with `use-input` set. Must be a child of a `<pc-entity>`, `<pc-model>` or\n`<pc-node>`.\n",
|
|
6376
7263
|
"tagName": "pc-button",
|
|
6377
7264
|
"customElement": true,
|
|
6378
7265
|
"events": [
|
|
@@ -6415,9 +7302,23 @@
|
|
|
6415
7302
|
"declarations": [
|
|
6416
7303
|
{
|
|
6417
7304
|
"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",
|
|
7305
|
+
"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
7306
|
"name": "CameraComponentElement",
|
|
6420
7307
|
"members": [
|
|
7308
|
+
{
|
|
7309
|
+
"kind": "field",
|
|
7310
|
+
"name": "arAvailable",
|
|
7311
|
+
"type": {
|
|
7312
|
+
"text": "boolean"
|
|
7313
|
+
},
|
|
7314
|
+
"description": "Whether immersive AR is available. Independent of vrAvailable: a device can offer\neither mode without the other.",
|
|
7315
|
+
"return": {
|
|
7316
|
+
"type": {
|
|
7317
|
+
"text": ""
|
|
7318
|
+
}
|
|
7319
|
+
},
|
|
7320
|
+
"readonly": true
|
|
7321
|
+
},
|
|
6421
7322
|
{
|
|
6422
7323
|
"kind": "field",
|
|
6423
7324
|
"name": "clearColor",
|
|
@@ -6456,6 +7357,25 @@
|
|
|
6456
7357
|
}
|
|
6457
7358
|
}
|
|
6458
7359
|
},
|
|
7360
|
+
{
|
|
7361
|
+
"kind": "field",
|
|
7362
|
+
"name": "clearDepth",
|
|
7363
|
+
"description": "Gets the depth value the depth buffer is cleared to.",
|
|
7364
|
+
"parameters": [
|
|
7365
|
+
{
|
|
7366
|
+
"description": "The clear depth value.",
|
|
7367
|
+
"name": "value"
|
|
7368
|
+
}
|
|
7369
|
+
],
|
|
7370
|
+
"type": {
|
|
7371
|
+
"text": "number"
|
|
7372
|
+
},
|
|
7373
|
+
"return": {
|
|
7374
|
+
"type": {
|
|
7375
|
+
"text": ""
|
|
7376
|
+
}
|
|
7377
|
+
}
|
|
7378
|
+
},
|
|
6459
7379
|
{
|
|
6460
7380
|
"kind": "field",
|
|
6461
7381
|
"name": "clearDepthBuffer",
|
|
@@ -6518,7 +7438,7 @@
|
|
|
6518
7438
|
"type": {
|
|
6519
7439
|
"text": "EntityBaseElement | null"
|
|
6520
7440
|
},
|
|
6521
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
7441
|
+
"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
7442
|
"return": {
|
|
6523
7443
|
"type": {
|
|
6524
7444
|
"text": ""
|
|
@@ -6870,7 +7790,16 @@
|
|
|
6870
7790
|
},
|
|
6871
7791
|
{
|
|
6872
7792
|
"kind": "field",
|
|
6873
|
-
"name": "
|
|
7793
|
+
"name": "vrAvailable",
|
|
7794
|
+
"type": {
|
|
7795
|
+
"text": "boolean"
|
|
7796
|
+
},
|
|
7797
|
+
"description": "Whether immersive VR is available. Independent of arAvailable: a device can offer\neither mode without the other.",
|
|
7798
|
+
"return": {
|
|
7799
|
+
"type": {
|
|
7800
|
+
"text": ""
|
|
7801
|
+
}
|
|
7802
|
+
},
|
|
6874
7803
|
"readonly": true
|
|
6875
7804
|
}
|
|
6876
7805
|
],
|
|
@@ -6893,6 +7822,15 @@
|
|
|
6893
7822
|
"default": "true",
|
|
6894
7823
|
"description": "The clear color buffer of the camera."
|
|
6895
7824
|
},
|
|
7825
|
+
{
|
|
7826
|
+
"name": "clear-depth",
|
|
7827
|
+
"type": {
|
|
7828
|
+
"text": "number"
|
|
7829
|
+
},
|
|
7830
|
+
"fieldName": "clearDepth",
|
|
7831
|
+
"default": "1",
|
|
7832
|
+
"description": "The depth value the depth buffer is cleared to."
|
|
7833
|
+
},
|
|
6896
7834
|
{
|
|
6897
7835
|
"name": "clear-depth-buffer",
|
|
6898
7836
|
"type": {
|
|
@@ -6908,7 +7846,7 @@
|
|
|
6908
7846
|
"text": "boolean"
|
|
6909
7847
|
},
|
|
6910
7848
|
"fieldName": "clearStencilBuffer",
|
|
6911
|
-
"default": "
|
|
7849
|
+
"default": "true",
|
|
6912
7850
|
"description": "The clear stencil buffer of the camera."
|
|
6913
7851
|
},
|
|
6914
7852
|
{
|
|
@@ -7055,6 +7993,7 @@
|
|
|
7055
7993
|
"name": "ComponentElement",
|
|
7056
7994
|
"module": "/src/components/component"
|
|
7057
7995
|
},
|
|
7996
|
+
"summary": "The `<pc-camera>` element renders the scene from its entity's transform, with\nattributes for the projection, field of view, clip planes, clear color and tonemapping. Must be a\nchild of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
7058
7997
|
"tagName": "pc-camera",
|
|
7059
7998
|
"customElement": true,
|
|
7060
7999
|
"events": [
|
|
@@ -7097,7 +8036,7 @@
|
|
|
7097
8036
|
"declarations": [
|
|
7098
8037
|
{
|
|
7099
8038
|
"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",
|
|
8039
|
+
"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
8040
|
"name": "CollisionComponentElement",
|
|
7102
8041
|
"members": [
|
|
7103
8042
|
{
|
|
@@ -7132,7 +8071,7 @@
|
|
|
7132
8071
|
"type": {
|
|
7133
8072
|
"text": "EntityBaseElement | null"
|
|
7134
8073
|
},
|
|
7135
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
8074
|
+
"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
8075
|
"return": {
|
|
7137
8076
|
"type": {
|
|
7138
8077
|
"text": ""
|
|
@@ -7307,6 +8246,7 @@
|
|
|
7307
8246
|
"name": "ComponentElement",
|
|
7308
8247
|
"module": "/src/components/component"
|
|
7309
8248
|
},
|
|
8249
|
+
"summary": "The `<pc-collision>` element gives its entity a collision shape — a box, sphere,\ncapsule, cone, cylinder or mesh — for the physics simulation to collide against. Pair it with a\n`<pc-rigid-body>`. Must be a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
7310
8250
|
"tagName": "pc-collision",
|
|
7311
8251
|
"customElement": true,
|
|
7312
8252
|
"events": [
|
|
@@ -7376,7 +8316,7 @@
|
|
|
7376
8316
|
"type": {
|
|
7377
8317
|
"text": "EntityBaseElement | null"
|
|
7378
8318
|
},
|
|
7379
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
8319
|
+
"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
8320
|
"return": {
|
|
7381
8321
|
"type": {
|
|
7382
8322
|
"text": ""
|
|
@@ -7394,7 +8334,7 @@
|
|
|
7394
8334
|
"type": {
|
|
7395
8335
|
"text": "Component | null"
|
|
7396
8336
|
},
|
|
7397
|
-
"description": "The PlayCanvas component instance. `null` until the element is ready, and also for an\nelement that is not a descendant of
|
|
8337
|
+
"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
8338
|
"return": {
|
|
7399
8339
|
"type": {
|
|
7400
8340
|
"text": ""
|
|
@@ -7480,7 +8420,7 @@
|
|
|
7480
8420
|
"declarations": [
|
|
7481
8421
|
{
|
|
7482
8422
|
"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",
|
|
8423
|
+
"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
8424
|
"name": "ElementComponentElement",
|
|
7485
8425
|
"members": [
|
|
7486
8426
|
{
|
|
@@ -7587,7 +8527,7 @@
|
|
|
7587
8527
|
"type": {
|
|
7588
8528
|
"text": "EntityBaseElement | null"
|
|
7589
8529
|
},
|
|
7590
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
8530
|
+
"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
8531
|
"return": {
|
|
7592
8532
|
"type": {
|
|
7593
8533
|
"text": ""
|
|
@@ -8238,6 +9178,7 @@
|
|
|
8238
9178
|
"name": "ComponentElement",
|
|
8239
9179
|
"module": "/src/components/component"
|
|
8240
9180
|
},
|
|
9181
|
+
"summary": "The `<pc-element>` element gives its entity a 2D UI rectangle inside a\n`<pc-screen>` hierarchy, drawing an image, a line of text or nothing (`type=\"image\"`, `\"text\"` or\n`\"group\"`). Must be a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
8241
9182
|
"tagName": "pc-element",
|
|
8242
9183
|
"customElement": true,
|
|
8243
9184
|
"events": [
|
|
@@ -8280,7 +9221,7 @@
|
|
|
8280
9221
|
"declarations": [
|
|
8281
9222
|
{
|
|
8282
9223
|
"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",
|
|
9224
|
+
"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
9225
|
"name": "GSplatComponentElement",
|
|
8285
9226
|
"members": [
|
|
8286
9227
|
{
|
|
@@ -8339,7 +9280,7 @@
|
|
|
8339
9280
|
"type": {
|
|
8340
9281
|
"text": "EntityBaseElement | null"
|
|
8341
9282
|
},
|
|
8342
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
9283
|
+
"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
9284
|
"return": {
|
|
8344
9285
|
"type": {
|
|
8345
9286
|
"text": ""
|
|
@@ -8540,6 +9481,7 @@
|
|
|
8540
9481
|
"name": "ComponentElement",
|
|
8541
9482
|
"module": "/src/components/component"
|
|
8542
9483
|
},
|
|
9484
|
+
"summary": "The `<pc-gsplat>` element renders the 3D Gaussian splats of a `gsplat` asset at\nits entity, with attributes for shadow casting and level of detail. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
8543
9485
|
"tagName": "pc-gsplat",
|
|
8544
9486
|
"customElement": true,
|
|
8545
9487
|
"events": [
|
|
@@ -8769,7 +9711,7 @@
|
|
|
8769
9711
|
"type": {
|
|
8770
9712
|
"text": "EntityBaseElement | null"
|
|
8771
9713
|
},
|
|
8772
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
9714
|
+
"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
9715
|
"return": {
|
|
8774
9716
|
"type": {
|
|
8775
9717
|
"text": ""
|
|
@@ -9160,7 +10102,7 @@
|
|
|
9160
10102
|
"type": {
|
|
9161
10103
|
"text": "CustomEvent"
|
|
9162
10104
|
},
|
|
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."
|
|
10105
|
+
"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
10106
|
},
|
|
9165
10107
|
{
|
|
9166
10108
|
"name": "ready",
|
|
@@ -9461,6 +10403,7 @@
|
|
|
9461
10403
|
"name": "ComponentElement",
|
|
9462
10404
|
"module": "/src/components/component"
|
|
9463
10405
|
},
|
|
10406
|
+
"summary": "The `<pc-joint>` element constrains two rigid bodies to each other — a hinged\ndoor, a swinging chain, a sliding drawer. Its entity's transform is the joint frame, and\n`entity-a` and `entity-b` name the bodies. Must be a child of a `<pc-entity>`, `<pc-model>` or\n`<pc-node>`.\n",
|
|
9464
10407
|
"tagName": "pc-joint",
|
|
9465
10408
|
"customElement": true
|
|
9466
10409
|
}
|
|
@@ -9486,11 +10429,11 @@
|
|
|
9486
10429
|
},
|
|
9487
10430
|
{
|
|
9488
10431
|
"kind": "javascript-module",
|
|
9489
|
-
"path": "src/components/
|
|
10432
|
+
"path": "src/components/layout-child-component.ts",
|
|
9490
10433
|
"declarations": [
|
|
9491
10434
|
{
|
|
9492
10435
|
"kind": "class",
|
|
9493
|
-
"description": "The LayoutChildComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
10436
|
+
"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
10437
|
"name": "LayoutChildComponentElement",
|
|
9495
10438
|
"members": [
|
|
9496
10439
|
{
|
|
@@ -9517,7 +10460,7 @@
|
|
|
9517
10460
|
"type": {
|
|
9518
10461
|
"text": "EntityBaseElement | null"
|
|
9519
10462
|
},
|
|
9520
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
10463
|
+
"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
10464
|
"return": {
|
|
9522
10465
|
"type": {
|
|
9523
10466
|
"text": ""
|
|
@@ -9774,7 +10717,8 @@
|
|
|
9774
10717
|
"name": "ComponentElement",
|
|
9775
10718
|
"module": "/src/components/component"
|
|
9776
10719
|
},
|
|
9777
|
-
"
|
|
10720
|
+
"summary": "The `<pc-layout-child>` element controls how its entity is sized by the\n`<pc-layout-group>` above it, through minimum and maximum sizes and fit proportions. Must be a\nchild of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
10721
|
+
"tagName": "pc-layout-child",
|
|
9778
10722
|
"customElement": true,
|
|
9779
10723
|
"events": [
|
|
9780
10724
|
{
|
|
@@ -9794,10 +10738,10 @@
|
|
|
9794
10738
|
"exports": [
|
|
9795
10739
|
{
|
|
9796
10740
|
"kind": "custom-element-definition",
|
|
9797
|
-
"name": "pc-
|
|
10741
|
+
"name": "pc-layout-child",
|
|
9798
10742
|
"declaration": {
|
|
9799
10743
|
"name": "LayoutChildComponentElement",
|
|
9800
|
-
"module": "src/components/
|
|
10744
|
+
"module": "src/components/layout-child-component.ts"
|
|
9801
10745
|
}
|
|
9802
10746
|
},
|
|
9803
10747
|
{
|
|
@@ -9805,18 +10749,18 @@
|
|
|
9805
10749
|
"name": "LayoutChildComponentElement",
|
|
9806
10750
|
"declaration": {
|
|
9807
10751
|
"name": "LayoutChildComponentElement",
|
|
9808
|
-
"module": "src/components/
|
|
10752
|
+
"module": "src/components/layout-child-component.ts"
|
|
9809
10753
|
}
|
|
9810
10754
|
}
|
|
9811
10755
|
]
|
|
9812
10756
|
},
|
|
9813
10757
|
{
|
|
9814
10758
|
"kind": "javascript-module",
|
|
9815
|
-
"path": "src/components/
|
|
10759
|
+
"path": "src/components/layout-group-component.ts",
|
|
9816
10760
|
"declarations": [
|
|
9817
10761
|
{
|
|
9818
10762
|
"kind": "class",
|
|
9819
|
-
"description": "The LayoutGroupComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
10763
|
+
"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
10764
|
"name": "LayoutGroupComponentElement",
|
|
9821
10765
|
"members": [
|
|
9822
10766
|
{
|
|
@@ -9859,7 +10803,7 @@
|
|
|
9859
10803
|
"type": {
|
|
9860
10804
|
"text": "EntityBaseElement | null"
|
|
9861
10805
|
},
|
|
9862
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
10806
|
+
"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
10807
|
"return": {
|
|
9864
10808
|
"type": {
|
|
9865
10809
|
"text": ""
|
|
@@ -10152,7 +11096,8 @@
|
|
|
10152
11096
|
"name": "ComponentElement",
|
|
10153
11097
|
"module": "/src/components/component"
|
|
10154
11098
|
},
|
|
10155
|
-
"
|
|
11099
|
+
"summary": "The `<pc-layout-group>` element arranges its entity's children in a row or\ncolumn, with spacing, padding, alignment and fitting. Must be a child of a `<pc-entity>`,\n`<pc-model>` or `<pc-node>`.\n",
|
|
11100
|
+
"tagName": "pc-layout-group",
|
|
10156
11101
|
"customElement": true,
|
|
10157
11102
|
"events": [
|
|
10158
11103
|
{
|
|
@@ -10172,10 +11117,10 @@
|
|
|
10172
11117
|
"exports": [
|
|
10173
11118
|
{
|
|
10174
11119
|
"kind": "custom-element-definition",
|
|
10175
|
-
"name": "pc-
|
|
11120
|
+
"name": "pc-layout-group",
|
|
10176
11121
|
"declaration": {
|
|
10177
11122
|
"name": "LayoutGroupComponentElement",
|
|
10178
|
-
"module": "src/components/
|
|
11123
|
+
"module": "src/components/layout-group-component.ts"
|
|
10179
11124
|
}
|
|
10180
11125
|
},
|
|
10181
11126
|
{
|
|
@@ -10183,7 +11128,7 @@
|
|
|
10183
11128
|
"name": "LayoutGroupComponentElement",
|
|
10184
11129
|
"declaration": {
|
|
10185
11130
|
"name": "LayoutGroupComponentElement",
|
|
10186
|
-
"module": "src/components/
|
|
11131
|
+
"module": "src/components/layout-group-component.ts"
|
|
10187
11132
|
}
|
|
10188
11133
|
}
|
|
10189
11134
|
]
|
|
@@ -10194,9 +11139,41 @@
|
|
|
10194
11139
|
"declarations": [
|
|
10195
11140
|
{
|
|
10196
11141
|
"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",
|
|
11142
|
+
"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
11143
|
"name": "LightComponentElement",
|
|
10199
11144
|
"members": [
|
|
11145
|
+
{
|
|
11146
|
+
"kind": "field",
|
|
11147
|
+
"name": "cascadeBlend",
|
|
11148
|
+
"description": "Gets the cascade blend factor of the light, from 0 (no blending) to 1, which applies only to\n`directional` lights with `num-cascades` greater than 1.",
|
|
11149
|
+
"parameters": [
|
|
11150
|
+
{
|
|
11151
|
+
"description": "The cascade blend factor.",
|
|
11152
|
+
"name": "value"
|
|
11153
|
+
}
|
|
11154
|
+
],
|
|
11155
|
+
"return": {
|
|
11156
|
+
"type": {
|
|
11157
|
+
"text": ""
|
|
11158
|
+
}
|
|
11159
|
+
}
|
|
11160
|
+
},
|
|
11161
|
+
{
|
|
11162
|
+
"kind": "field",
|
|
11163
|
+
"name": "cascadeDistribution",
|
|
11164
|
+
"description": "Gets the cascade distribution of the light, from 0 (linear split) to 1 (logarithmic split,\nconcentrating shadow resolution near the camera), which applies only to `directional` lights\nwith `num-cascades` greater than 1.",
|
|
11165
|
+
"parameters": [
|
|
11166
|
+
{
|
|
11167
|
+
"description": "The cascade distribution.",
|
|
11168
|
+
"name": "value"
|
|
11169
|
+
}
|
|
11170
|
+
],
|
|
11171
|
+
"return": {
|
|
11172
|
+
"type": {
|
|
11173
|
+
"text": ""
|
|
11174
|
+
}
|
|
11175
|
+
}
|
|
11176
|
+
},
|
|
10200
11177
|
{
|
|
10201
11178
|
"kind": "field",
|
|
10202
11179
|
"name": "castShadows",
|
|
@@ -10237,7 +11214,7 @@
|
|
|
10237
11214
|
"type": {
|
|
10238
11215
|
"text": "EntityBaseElement | null"
|
|
10239
11216
|
},
|
|
10240
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
11217
|
+
"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
11218
|
"return": {
|
|
10242
11219
|
"type": {
|
|
10243
11220
|
"text": ""
|
|
@@ -10351,6 +11328,22 @@
|
|
|
10351
11328
|
}
|
|
10352
11329
|
}
|
|
10353
11330
|
},
|
|
11331
|
+
{
|
|
11332
|
+
"kind": "field",
|
|
11333
|
+
"name": "numCascades",
|
|
11334
|
+
"description": "Gets the number of shadow cascades of the light, an integer from 1 (no cascades) to 4, which\napplies only to `directional` lights.",
|
|
11335
|
+
"parameters": [
|
|
11336
|
+
{
|
|
11337
|
+
"description": "The number of shadow cascades.",
|
|
11338
|
+
"name": "value"
|
|
11339
|
+
}
|
|
11340
|
+
],
|
|
11341
|
+
"return": {
|
|
11342
|
+
"type": {
|
|
11343
|
+
"text": ""
|
|
11344
|
+
}
|
|
11345
|
+
}
|
|
11346
|
+
},
|
|
10354
11347
|
{
|
|
10355
11348
|
"kind": "field",
|
|
10356
11349
|
"name": "outerConeAngle",
|
|
@@ -10591,6 +11584,24 @@
|
|
|
10591
11584
|
}
|
|
10592
11585
|
],
|
|
10593
11586
|
"attributes": [
|
|
11587
|
+
{
|
|
11588
|
+
"name": "cascade-blend",
|
|
11589
|
+
"type": {
|
|
11590
|
+
"text": "number"
|
|
11591
|
+
},
|
|
11592
|
+
"fieldName": "cascadeBlend",
|
|
11593
|
+
"default": "0",
|
|
11594
|
+
"description": "The cascade blend factor of the light, from 0 (no blending) to 1, which applies only to `directional` lights with `num-cascades` greater than 1."
|
|
11595
|
+
},
|
|
11596
|
+
{
|
|
11597
|
+
"name": "cascade-distribution",
|
|
11598
|
+
"type": {
|
|
11599
|
+
"text": "number"
|
|
11600
|
+
},
|
|
11601
|
+
"fieldName": "cascadeDistribution",
|
|
11602
|
+
"default": "0.5",
|
|
11603
|
+
"description": "The cascade distribution of the light, from 0 (linear split) to 1 (logarithmic split, concentrating shadow resolution near the camera), which applies only to `directional` lights with `num-cascades` greater than 1."
|
|
11604
|
+
},
|
|
10594
11605
|
{
|
|
10595
11606
|
"name": "cast-shadows",
|
|
10596
11607
|
"type": {
|
|
@@ -10646,9 +11657,18 @@
|
|
|
10646
11657
|
"text": "number"
|
|
10647
11658
|
},
|
|
10648
11659
|
"fieldName": "normalOffsetBias",
|
|
10649
|
-
"default": "0
|
|
11660
|
+
"default": "0",
|
|
10650
11661
|
"description": "The normal offset bias of the light."
|
|
10651
11662
|
},
|
|
11663
|
+
{
|
|
11664
|
+
"name": "num-cascades",
|
|
11665
|
+
"type": {
|
|
11666
|
+
"text": "number"
|
|
11667
|
+
},
|
|
11668
|
+
"fieldName": "numCascades",
|
|
11669
|
+
"default": "1",
|
|
11670
|
+
"description": "The number of shadow cascades of the light, an integer from 1 (no cascades) to 4, which applies only to `directional` lights."
|
|
11671
|
+
},
|
|
10652
11672
|
{
|
|
10653
11673
|
"name": "outer-cone-angle",
|
|
10654
11674
|
"type": {
|
|
@@ -10691,7 +11711,7 @@
|
|
|
10691
11711
|
"text": "number"
|
|
10692
11712
|
},
|
|
10693
11713
|
"fieldName": "shadowBias",
|
|
10694
|
-
"default": "0.
|
|
11714
|
+
"default": "0.05",
|
|
10695
11715
|
"description": "The shadow bias of the light."
|
|
10696
11716
|
},
|
|
10697
11717
|
{
|
|
@@ -10709,7 +11729,7 @@
|
|
|
10709
11729
|
"text": "number"
|
|
10710
11730
|
},
|
|
10711
11731
|
"fieldName": "shadowDistance",
|
|
10712
|
-
"default": "
|
|
11732
|
+
"default": "40",
|
|
10713
11733
|
"description": "The shadow distance of the light."
|
|
10714
11734
|
},
|
|
10715
11735
|
{
|
|
@@ -10763,7 +11783,7 @@
|
|
|
10763
11783
|
"text": "number"
|
|
10764
11784
|
},
|
|
10765
11785
|
"fieldName": "vsmBias",
|
|
10766
|
-
"default": "0.
|
|
11786
|
+
"default": "0.0025",
|
|
10767
11787
|
"description": "The VSM bias of the light."
|
|
10768
11788
|
},
|
|
10769
11789
|
{
|
|
@@ -10780,6 +11800,7 @@
|
|
|
10780
11800
|
"name": "ComponentElement",
|
|
10781
11801
|
"module": "/src/components/component"
|
|
10782
11802
|
},
|
|
11803
|
+
"summary": "The `<pc-light>` element lights the scene from its entity — as a directional,\nomni or spot light — with attributes for color, intensity, range and shadows. Must be a child of\na `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
10783
11804
|
"tagName": "pc-light",
|
|
10784
11805
|
"customElement": true,
|
|
10785
11806
|
"events": [
|
|
@@ -10803,179 +11824,26 @@
|
|
|
10803
11824
|
"name": "pc-light",
|
|
10804
11825
|
"declaration": {
|
|
10805
11826
|
"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"
|
|
11827
|
+
"module": "src/components/light-component.ts"
|
|
10960
11828
|
}
|
|
10961
11829
|
},
|
|
10962
11830
|
{
|
|
10963
11831
|
"kind": "js",
|
|
10964
|
-
"name": "
|
|
11832
|
+
"name": "LightComponentElement",
|
|
10965
11833
|
"declaration": {
|
|
10966
|
-
"name": "
|
|
10967
|
-
"module": "src/components/
|
|
11834
|
+
"name": "LightComponentElement",
|
|
11835
|
+
"module": "src/components/light-component.ts"
|
|
10968
11836
|
}
|
|
10969
11837
|
}
|
|
10970
11838
|
]
|
|
10971
11839
|
},
|
|
10972
11840
|
{
|
|
10973
11841
|
"kind": "javascript-module",
|
|
10974
|
-
"path": "src/components/
|
|
11842
|
+
"path": "src/components/particle-system-component.ts",
|
|
10975
11843
|
"declarations": [
|
|
10976
11844
|
{
|
|
10977
11845
|
"kind": "class",
|
|
10978
|
-
"description": "The ParticleSystemComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
11846
|
+
"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
11847
|
"name": "ParticleSystemComponentElement",
|
|
10980
11848
|
"members": [
|
|
10981
11849
|
{
|
|
@@ -11021,7 +11889,7 @@
|
|
|
11021
11889
|
"type": {
|
|
11022
11890
|
"text": "EntityBaseElement | null"
|
|
11023
11891
|
},
|
|
11024
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
11892
|
+
"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
11893
|
"return": {
|
|
11026
11894
|
"type": {
|
|
11027
11895
|
"text": ""
|
|
@@ -11133,7 +12001,8 @@
|
|
|
11133
12001
|
"name": "ComponentElement",
|
|
11134
12002
|
"module": "/src/components/component"
|
|
11135
12003
|
},
|
|
11136
|
-
"
|
|
12004
|
+
"summary": "The `<pc-particle-system>` element emits particles from its entity, with\nattributes for the emitter's shape, rate, lifetime, textures and blending. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
12005
|
+
"tagName": "pc-particle-system",
|
|
11137
12006
|
"customElement": true,
|
|
11138
12007
|
"events": [
|
|
11139
12008
|
{
|
|
@@ -11153,10 +12022,10 @@
|
|
|
11153
12022
|
"exports": [
|
|
11154
12023
|
{
|
|
11155
12024
|
"kind": "custom-element-definition",
|
|
11156
|
-
"name": "pc-
|
|
12025
|
+
"name": "pc-particle-system",
|
|
11157
12026
|
"declaration": {
|
|
11158
12027
|
"name": "ParticleSystemComponentElement",
|
|
11159
|
-
"module": "src/components/
|
|
12028
|
+
"module": "src/components/particle-system-component.ts"
|
|
11160
12029
|
}
|
|
11161
12030
|
},
|
|
11162
12031
|
{
|
|
@@ -11164,7 +12033,7 @@
|
|
|
11164
12033
|
"name": "ParticleSystemComponentElement",
|
|
11165
12034
|
"declaration": {
|
|
11166
12035
|
"name": "ParticleSystemComponentElement",
|
|
11167
|
-
"module": "src/components/
|
|
12036
|
+
"module": "src/components/particle-system-component.ts"
|
|
11168
12037
|
}
|
|
11169
12038
|
}
|
|
11170
12039
|
]
|
|
@@ -11175,7 +12044,7 @@
|
|
|
11175
12044
|
"declarations": [
|
|
11176
12045
|
{
|
|
11177
12046
|
"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",
|
|
12047
|
+
"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
12048
|
"name": "RenderComponentElement",
|
|
11180
12049
|
"members": [
|
|
11181
12050
|
{
|
|
@@ -11221,7 +12090,7 @@
|
|
|
11221
12090
|
"type": {
|
|
11222
12091
|
"text": "EntityBaseElement | null"
|
|
11223
12092
|
},
|
|
11224
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12093
|
+
"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
12094
|
"return": {
|
|
11226
12095
|
"type": {
|
|
11227
12096
|
"text": ""
|
|
@@ -11394,6 +12263,7 @@
|
|
|
11394
12263
|
"name": "ComponentElement",
|
|
11395
12264
|
"module": "/src/components/component"
|
|
11396
12265
|
},
|
|
12266
|
+
"summary": "The `<pc-render>` element renders one of the engine's built-in primitives at its\nentity — box, sphere, capsule, cone, cylinder or plane — shaded by the `<pc-material>` its\n`material` attribute names. For glTF content, use `<pc-model>` instead. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
11397
12267
|
"tagName": "pc-render",
|
|
11398
12268
|
"customElement": true,
|
|
11399
12269
|
"events": [
|
|
@@ -11432,11 +12302,11 @@
|
|
|
11432
12302
|
},
|
|
11433
12303
|
{
|
|
11434
12304
|
"kind": "javascript-module",
|
|
11435
|
-
"path": "src/components/
|
|
12305
|
+
"path": "src/components/rigid-body-component.ts",
|
|
11436
12306
|
"declarations": [
|
|
11437
12307
|
{
|
|
11438
12308
|
"kind": "class",
|
|
11439
|
-
"description": "The RigidBodyComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
12309
|
+
"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
12310
|
"name": "RigidBodyComponentElement",
|
|
11441
12311
|
"members": [
|
|
11442
12312
|
{
|
|
@@ -11471,7 +12341,7 @@
|
|
|
11471
12341
|
"type": {
|
|
11472
12342
|
"text": "EntityBaseElement | null"
|
|
11473
12343
|
},
|
|
11474
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12344
|
+
"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
12345
|
"return": {
|
|
11476
12346
|
"type": {
|
|
11477
12347
|
"text": ""
|
|
@@ -11657,7 +12527,8 @@
|
|
|
11657
12527
|
"name": "ComponentElement",
|
|
11658
12528
|
"module": "/src/components/component"
|
|
11659
12529
|
},
|
|
11660
|
-
"
|
|
12530
|
+
"summary": "The `<pc-rigid-body>` element hands its entity to the physics simulation, with\nattributes for its type, mass, friction and restitution. It needs a sibling `<pc-collision>` for\nits shape, and `Ammo` loaded through `<pc-wasm>`. Must be a child of a `<pc-entity>`,\n`<pc-model>` or `<pc-node>`.\n",
|
|
12531
|
+
"tagName": "pc-rigid-body",
|
|
11661
12532
|
"customElement": true,
|
|
11662
12533
|
"events": [
|
|
11663
12534
|
{
|
|
@@ -11677,10 +12548,10 @@
|
|
|
11677
12548
|
"exports": [
|
|
11678
12549
|
{
|
|
11679
12550
|
"kind": "custom-element-definition",
|
|
11680
|
-
"name": "pc-
|
|
12551
|
+
"name": "pc-rigid-body",
|
|
11681
12552
|
"declaration": {
|
|
11682
12553
|
"name": "RigidBodyComponentElement",
|
|
11683
|
-
"module": "src/components/
|
|
12554
|
+
"module": "src/components/rigid-body-component.ts"
|
|
11684
12555
|
}
|
|
11685
12556
|
},
|
|
11686
12557
|
{
|
|
@@ -11688,7 +12559,7 @@
|
|
|
11688
12559
|
"name": "RigidBodyComponentElement",
|
|
11689
12560
|
"declaration": {
|
|
11690
12561
|
"name": "RigidBodyComponentElement",
|
|
11691
|
-
"module": "src/components/
|
|
12562
|
+
"module": "src/components/rigid-body-component.ts"
|
|
11692
12563
|
}
|
|
11693
12564
|
}
|
|
11694
12565
|
]
|
|
@@ -11699,7 +12570,7 @@
|
|
|
11699
12570
|
"declarations": [
|
|
11700
12571
|
{
|
|
11701
12572
|
"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",
|
|
12573
|
+
"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
12574
|
"name": "ScreenComponentElement",
|
|
11704
12575
|
"members": [
|
|
11705
12576
|
{
|
|
@@ -11726,7 +12597,7 @@
|
|
|
11726
12597
|
"type": {
|
|
11727
12598
|
"text": "EntityBaseElement | null"
|
|
11728
12599
|
},
|
|
11729
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12600
|
+
"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
12601
|
"return": {
|
|
11731
12602
|
"type": {
|
|
11732
12603
|
"text": ""
|
|
@@ -11910,6 +12781,7 @@
|
|
|
11910
12781
|
"name": "ComponentElement",
|
|
11911
12782
|
"module": "/src/components/component"
|
|
11912
12783
|
},
|
|
12784
|
+
"summary": "The `<pc-screen>` element gives its entity a 2D space — in screen space or in the\nworld — that a hierarchy of `<pc-element>` descendants lays out inside. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
11913
12785
|
"tagName": "pc-screen",
|
|
11914
12786
|
"customElement": true,
|
|
11915
12787
|
"events": [
|
|
@@ -11952,7 +12824,7 @@
|
|
|
11952
12824
|
"declarations": [
|
|
11953
12825
|
{
|
|
11954
12826
|
"kind": "class",
|
|
11955
|
-
"description": "The ScriptComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
12827
|
+
"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
12828
|
"name": "ScriptComponentElement",
|
|
11957
12829
|
"members": [
|
|
11958
12830
|
{
|
|
@@ -11979,7 +12851,7 @@
|
|
|
11979
12851
|
"type": {
|
|
11980
12852
|
"text": "EntityBaseElement | null"
|
|
11981
12853
|
},
|
|
11982
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
12854
|
+
"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
12855
|
"return": {
|
|
11984
12856
|
"type": {
|
|
11985
12857
|
"text": ""
|
|
@@ -12048,7 +12920,8 @@
|
|
|
12048
12920
|
"name": "ComponentElement",
|
|
12049
12921
|
"module": "/src/components/component"
|
|
12050
12922
|
},
|
|
12051
|
-
"
|
|
12923
|
+
"summary": "The `<pc-script>` element holds the `<pc-script-instance>` children that attach\nscripts to its entity. Must be a child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
12924
|
+
"tagName": "pc-script",
|
|
12052
12925
|
"customElement": true,
|
|
12053
12926
|
"attributes": [
|
|
12054
12927
|
{
|
|
@@ -12083,7 +12956,7 @@
|
|
|
12083
12956
|
"exports": [
|
|
12084
12957
|
{
|
|
12085
12958
|
"kind": "custom-element-definition",
|
|
12086
|
-
"name": "pc-
|
|
12959
|
+
"name": "pc-script",
|
|
12087
12960
|
"declaration": {
|
|
12088
12961
|
"name": "ScriptComponentElement",
|
|
12089
12962
|
"module": "src/components/script-component.ts"
|
|
@@ -12101,12 +12974,12 @@
|
|
|
12101
12974
|
},
|
|
12102
12975
|
{
|
|
12103
12976
|
"kind": "javascript-module",
|
|
12104
|
-
"path": "src/components/script.ts",
|
|
12977
|
+
"path": "src/components/script-instance.ts",
|
|
12105
12978
|
"declarations": [
|
|
12106
12979
|
{
|
|
12107
12980
|
"kind": "class",
|
|
12108
|
-
"description": "The
|
|
12109
|
-
"name": "
|
|
12981
|
+
"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",
|
|
12982
|
+
"name": "ScriptInstanceElement",
|
|
12110
12983
|
"members": [
|
|
12111
12984
|
{
|
|
12112
12985
|
"kind": "field",
|
|
@@ -12132,7 +13005,7 @@
|
|
|
12132
13005
|
"type": {
|
|
12133
13006
|
"text": "EntityBaseElement | null"
|
|
12134
13007
|
},
|
|
12135
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
13008
|
+
"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
13009
|
"return": {
|
|
12137
13010
|
"type": {
|
|
12138
13011
|
"text": ""
|
|
@@ -12289,288 +13162,37 @@
|
|
|
12289
13162
|
"name": "AsyncElement",
|
|
12290
13163
|
"module": "/src/async-element"
|
|
12291
13164
|
},
|
|
12292
|
-
"
|
|
13165
|
+
"summary": "The `<pc-script-instance>` element attaches one script class, named by `name`, to\nthe entity of its parent `<pc-script>`. Its other attributes set script attributes of the same\nname, and `attributes` takes a JSON object instead. Must be a direct child of `<pc-script>`.\n",
|
|
13166
|
+
"tagName": "pc-script-instance",
|
|
12293
13167
|
"customElement": true
|
|
12294
13168
|
}
|
|
12295
13169
|
],
|
|
12296
13170
|
"exports": [
|
|
12297
13171
|
{
|
|
12298
13172
|
"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",
|
|
13173
|
+
"name": "pc-script-instance",
|
|
12552
13174
|
"declaration": {
|
|
12553
|
-
"name": "
|
|
12554
|
-
"module": "src/components/
|
|
13175
|
+
"name": "ScriptInstanceElement",
|
|
13176
|
+
"module": "src/components/script-instance.ts"
|
|
12555
13177
|
}
|
|
12556
13178
|
},
|
|
12557
13179
|
{
|
|
12558
13180
|
"kind": "js",
|
|
12559
|
-
"name": "
|
|
13181
|
+
"name": "ScriptInstanceElement",
|
|
12560
13182
|
"declaration": {
|
|
12561
|
-
"name": "
|
|
12562
|
-
"module": "src/components/
|
|
13183
|
+
"name": "ScriptInstanceElement",
|
|
13184
|
+
"module": "src/components/script-instance.ts"
|
|
12563
13185
|
}
|
|
12564
13186
|
}
|
|
12565
13187
|
]
|
|
12566
13188
|
},
|
|
12567
13189
|
{
|
|
12568
13190
|
"kind": "javascript-module",
|
|
12569
|
-
"path": "src/components/
|
|
13191
|
+
"path": "src/components/scroll-view-component.ts",
|
|
12570
13192
|
"declarations": [
|
|
12571
13193
|
{
|
|
12572
13194
|
"kind": "class",
|
|
12573
|
-
"description": "The ScrollViewComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
13195
|
+
"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
13196
|
"name": "ScrollViewComponentElement",
|
|
12575
13197
|
"members": [
|
|
12576
13198
|
{
|
|
@@ -12613,7 +13235,7 @@
|
|
|
12613
13235
|
"type": {
|
|
12614
13236
|
"text": "EntityBaseElement | null"
|
|
12615
13237
|
},
|
|
12616
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
13238
|
+
"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
13239
|
"return": {
|
|
12618
13240
|
"type": {
|
|
12619
13241
|
"text": ""
|
|
@@ -13002,7 +13624,8 @@
|
|
|
13002
13624
|
"name": "ComponentElement",
|
|
13003
13625
|
"module": "/src/components/component"
|
|
13004
13626
|
},
|
|
13005
|
-
"
|
|
13627
|
+
"summary": "The `<pc-scroll-view>` element scrolls a larger content entity within a clipped\nviewport at its entity, optionally driven by the `<pc-scrollbar>` elements it references. Must be\na child of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
13628
|
+
"tagName": "pc-scroll-view",
|
|
13006
13629
|
"customElement": true,
|
|
13007
13630
|
"events": [
|
|
13008
13631
|
{
|
|
@@ -13022,10 +13645,10 @@
|
|
|
13022
13645
|
"exports": [
|
|
13023
13646
|
{
|
|
13024
13647
|
"kind": "custom-element-definition",
|
|
13025
|
-
"name": "pc-
|
|
13648
|
+
"name": "pc-scroll-view",
|
|
13026
13649
|
"declaration": {
|
|
13027
13650
|
"name": "ScrollViewComponentElement",
|
|
13028
|
-
"module": "src/components/
|
|
13651
|
+
"module": "src/components/scroll-view-component.ts"
|
|
13029
13652
|
}
|
|
13030
13653
|
},
|
|
13031
13654
|
{
|
|
@@ -13033,7 +13656,260 @@
|
|
|
13033
13656
|
"name": "ScrollViewComponentElement",
|
|
13034
13657
|
"declaration": {
|
|
13035
13658
|
"name": "ScrollViewComponentElement",
|
|
13036
|
-
"module": "src/components/
|
|
13659
|
+
"module": "src/components/scroll-view-component.ts"
|
|
13660
|
+
}
|
|
13661
|
+
}
|
|
13662
|
+
]
|
|
13663
|
+
},
|
|
13664
|
+
{
|
|
13665
|
+
"kind": "javascript-module",
|
|
13666
|
+
"path": "src/components/scrollbar-component.ts",
|
|
13667
|
+
"declarations": [
|
|
13668
|
+
{
|
|
13669
|
+
"kind": "class",
|
|
13670
|
+
"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",
|
|
13671
|
+
"name": "ScrollbarComponentElement",
|
|
13672
|
+
"members": [
|
|
13673
|
+
{
|
|
13674
|
+
"kind": "field",
|
|
13675
|
+
"name": "closestApp",
|
|
13676
|
+
"type": {
|
|
13677
|
+
"text": "AppElement | null"
|
|
13678
|
+
},
|
|
13679
|
+
"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.",
|
|
13680
|
+
"return": {
|
|
13681
|
+
"type": {
|
|
13682
|
+
"text": ""
|
|
13683
|
+
}
|
|
13684
|
+
},
|
|
13685
|
+
"readonly": true,
|
|
13686
|
+
"inheritedFrom": {
|
|
13687
|
+
"name": "AsyncElement",
|
|
13688
|
+
"module": "src/async-element.ts"
|
|
13689
|
+
}
|
|
13690
|
+
},
|
|
13691
|
+
{
|
|
13692
|
+
"kind": "field",
|
|
13693
|
+
"name": "closestEntity",
|
|
13694
|
+
"type": {
|
|
13695
|
+
"text": "EntityBaseElement | null"
|
|
13696
|
+
},
|
|
13697
|
+
"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.",
|
|
13698
|
+
"return": {
|
|
13699
|
+
"type": {
|
|
13700
|
+
"text": ""
|
|
13701
|
+
}
|
|
13702
|
+
},
|
|
13703
|
+
"readonly": true,
|
|
13704
|
+
"inheritedFrom": {
|
|
13705
|
+
"name": "AsyncElement",
|
|
13706
|
+
"module": "src/async-element.ts"
|
|
13707
|
+
}
|
|
13708
|
+
},
|
|
13709
|
+
{
|
|
13710
|
+
"kind": "field",
|
|
13711
|
+
"name": "component",
|
|
13712
|
+
"type": {
|
|
13713
|
+
"text": "Component | null"
|
|
13714
|
+
},
|
|
13715
|
+
"description": "Gets the underlying PlayCanvas scrollbar component.",
|
|
13716
|
+
"return": {
|
|
13717
|
+
"type": {
|
|
13718
|
+
"text": ""
|
|
13719
|
+
}
|
|
13720
|
+
},
|
|
13721
|
+
"readonly": true,
|
|
13722
|
+
"inheritedFrom": {
|
|
13723
|
+
"name": "ComponentElement",
|
|
13724
|
+
"module": "src/components/component.ts"
|
|
13725
|
+
}
|
|
13726
|
+
},
|
|
13727
|
+
{
|
|
13728
|
+
"kind": "field",
|
|
13729
|
+
"name": "enabled",
|
|
13730
|
+
"description": "Gets the enabled state of the component.",
|
|
13731
|
+
"parameters": [
|
|
13732
|
+
{
|
|
13733
|
+
"description": "The enabled state of the component.",
|
|
13734
|
+
"name": "value"
|
|
13735
|
+
}
|
|
13736
|
+
],
|
|
13737
|
+
"return": {
|
|
13738
|
+
"type": {
|
|
13739
|
+
"text": ""
|
|
13740
|
+
}
|
|
13741
|
+
},
|
|
13742
|
+
"inheritedFrom": {
|
|
13743
|
+
"name": "ComponentElement",
|
|
13744
|
+
"module": "src/components/component.ts"
|
|
13745
|
+
}
|
|
13746
|
+
},
|
|
13747
|
+
{
|
|
13748
|
+
"kind": "field",
|
|
13749
|
+
"name": "handle",
|
|
13750
|
+
"description": "Gets the reference to the `<pc-entity>` used as the scrollbar handle.",
|
|
13751
|
+
"parameters": [
|
|
13752
|
+
{
|
|
13753
|
+
"description": "The handle entity reference.",
|
|
13754
|
+
"name": "value"
|
|
13755
|
+
}
|
|
13756
|
+
],
|
|
13757
|
+
"return": {
|
|
13758
|
+
"type": {
|
|
13759
|
+
"text": ""
|
|
13760
|
+
}
|
|
13761
|
+
}
|
|
13762
|
+
},
|
|
13763
|
+
{
|
|
13764
|
+
"kind": "field",
|
|
13765
|
+
"name": "handleSize",
|
|
13766
|
+
"description": "Gets the size of the handle relative to the size of the track.",
|
|
13767
|
+
"parameters": [
|
|
13768
|
+
{
|
|
13769
|
+
"description": "The handle size.",
|
|
13770
|
+
"name": "value"
|
|
13771
|
+
}
|
|
13772
|
+
],
|
|
13773
|
+
"return": {
|
|
13774
|
+
"type": {
|
|
13775
|
+
"text": ""
|
|
13776
|
+
}
|
|
13777
|
+
}
|
|
13778
|
+
},
|
|
13779
|
+
{
|
|
13780
|
+
"kind": "field",
|
|
13781
|
+
"name": "orientation",
|
|
13782
|
+
"description": "Gets the orientation of the scrollbar.",
|
|
13783
|
+
"parameters": [
|
|
13784
|
+
{
|
|
13785
|
+
"description": "The orientation.",
|
|
13786
|
+
"name": "value"
|
|
13787
|
+
}
|
|
13788
|
+
],
|
|
13789
|
+
"return": {
|
|
13790
|
+
"type": {
|
|
13791
|
+
"text": ""
|
|
13792
|
+
}
|
|
13793
|
+
}
|
|
13794
|
+
},
|
|
13795
|
+
{
|
|
13796
|
+
"kind": "method",
|
|
13797
|
+
"name": "ready",
|
|
13798
|
+
"return": {
|
|
13799
|
+
"type": {
|
|
13800
|
+
"text": ""
|
|
13801
|
+
}
|
|
13802
|
+
},
|
|
13803
|
+
"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.",
|
|
13804
|
+
"inheritedFrom": {
|
|
13805
|
+
"name": "AsyncElement",
|
|
13806
|
+
"module": "src/async-element.ts"
|
|
13807
|
+
}
|
|
13808
|
+
},
|
|
13809
|
+
{
|
|
13810
|
+
"kind": "field",
|
|
13811
|
+
"name": "value",
|
|
13812
|
+
"description": "Gets the current position value of the scrollbar.",
|
|
13813
|
+
"parameters": [
|
|
13814
|
+
{
|
|
13815
|
+
"description": "The scrollbar value.",
|
|
13816
|
+
"name": "value"
|
|
13817
|
+
}
|
|
13818
|
+
],
|
|
13819
|
+
"return": {
|
|
13820
|
+
"type": {
|
|
13821
|
+
"text": ""
|
|
13822
|
+
}
|
|
13823
|
+
}
|
|
13824
|
+
}
|
|
13825
|
+
],
|
|
13826
|
+
"attributes": [
|
|
13827
|
+
{
|
|
13828
|
+
"name": "enabled",
|
|
13829
|
+
"type": {
|
|
13830
|
+
"text": "boolean"
|
|
13831
|
+
},
|
|
13832
|
+
"fieldName": "enabled",
|
|
13833
|
+
"default": "true",
|
|
13834
|
+
"description": "The enabled state of the component.",
|
|
13835
|
+
"inheritedFrom": {
|
|
13836
|
+
"name": "ComponentElement",
|
|
13837
|
+
"module": "src/components/component.ts"
|
|
13838
|
+
}
|
|
13839
|
+
},
|
|
13840
|
+
{
|
|
13841
|
+
"name": "handle",
|
|
13842
|
+
"type": {
|
|
13843
|
+
"text": "string"
|
|
13844
|
+
},
|
|
13845
|
+
"fieldName": "handle",
|
|
13846
|
+
"description": "The reference to the `<pc-entity>` used as the scrollbar handle."
|
|
13847
|
+
},
|
|
13848
|
+
{
|
|
13849
|
+
"name": "handle-size",
|
|
13850
|
+
"type": {
|
|
13851
|
+
"text": "number"
|
|
13852
|
+
},
|
|
13853
|
+
"fieldName": "handleSize",
|
|
13854
|
+
"default": "0.5",
|
|
13855
|
+
"description": "The size of the handle relative to the size of the track."
|
|
13856
|
+
},
|
|
13857
|
+
{
|
|
13858
|
+
"name": "orientation",
|
|
13859
|
+
"type": {
|
|
13860
|
+
"text": "'horizontal' | 'vertical'"
|
|
13861
|
+
},
|
|
13862
|
+
"fieldName": "orientation",
|
|
13863
|
+
"default": "horizontal",
|
|
13864
|
+
"description": "The orientation of the scrollbar."
|
|
13865
|
+
},
|
|
13866
|
+
{
|
|
13867
|
+
"name": "value",
|
|
13868
|
+
"type": {
|
|
13869
|
+
"text": "number"
|
|
13870
|
+
},
|
|
13871
|
+
"fieldName": "value",
|
|
13872
|
+
"default": "0",
|
|
13873
|
+
"description": "The current position value of the scrollbar."
|
|
13874
|
+
}
|
|
13875
|
+
],
|
|
13876
|
+
"superclass": {
|
|
13877
|
+
"name": "ComponentElement",
|
|
13878
|
+
"module": "/src/components/component"
|
|
13879
|
+
},
|
|
13880
|
+
"summary": "The `<pc-scrollbar>` element gives its entity a draggable handle reporting a\nposition from 0 to 1, which a `<pc-scroll-view>` references to scroll its content. Must be a\nchild of a `<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
13881
|
+
"tagName": "pc-scrollbar",
|
|
13882
|
+
"customElement": true,
|
|
13883
|
+
"events": [
|
|
13884
|
+
{
|
|
13885
|
+
"name": "ready",
|
|
13886
|
+
"type": {
|
|
13887
|
+
"text": "CustomEvent"
|
|
13888
|
+
},
|
|
13889
|
+
"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.",
|
|
13890
|
+
"inheritedFrom": {
|
|
13891
|
+
"name": "AsyncElement",
|
|
13892
|
+
"module": "src/async-element.ts"
|
|
13893
|
+
}
|
|
13894
|
+
}
|
|
13895
|
+
]
|
|
13896
|
+
}
|
|
13897
|
+
],
|
|
13898
|
+
"exports": [
|
|
13899
|
+
{
|
|
13900
|
+
"kind": "custom-element-definition",
|
|
13901
|
+
"name": "pc-scrollbar",
|
|
13902
|
+
"declaration": {
|
|
13903
|
+
"name": "ScrollbarComponentElement",
|
|
13904
|
+
"module": "src/components/scrollbar-component.ts"
|
|
13905
|
+
}
|
|
13906
|
+
},
|
|
13907
|
+
{
|
|
13908
|
+
"kind": "js",
|
|
13909
|
+
"name": "ScrollbarComponentElement",
|
|
13910
|
+
"declaration": {
|
|
13911
|
+
"name": "ScrollbarComponentElement",
|
|
13912
|
+
"module": "src/components/scrollbar-component.ts"
|
|
13037
13913
|
}
|
|
13038
13914
|
}
|
|
13039
13915
|
]
|
|
@@ -13044,7 +13920,7 @@
|
|
|
13044
13920
|
"declarations": [
|
|
13045
13921
|
{
|
|
13046
13922
|
"kind": "class",
|
|
13047
|
-
"description": "The SoundComponentElement interface provides properties and methods for manipulating\n[`<pc-
|
|
13923
|
+
"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
13924
|
"name": "SoundComponentElement",
|
|
13049
13925
|
"members": [
|
|
13050
13926
|
{
|
|
@@ -13071,7 +13947,7 @@
|
|
|
13071
13947
|
"type": {
|
|
13072
13948
|
"text": "EntityBaseElement | null"
|
|
13073
13949
|
},
|
|
13074
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
13950
|
+
"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
13951
|
"return": {
|
|
13076
13952
|
"type": {
|
|
13077
13953
|
"text": ""
|
|
@@ -13333,7 +14209,8 @@
|
|
|
13333
14209
|
"name": "ComponentElement",
|
|
13334
14210
|
"module": "/src/components/component"
|
|
13335
14211
|
},
|
|
13336
|
-
"
|
|
14212
|
+
"summary": "The `<pc-sound>` element holds the `<pc-sound-slot>` children that play sounds at\nits entity, along with the positional audio settings they share. Must be a child of a\n`<pc-entity>`, `<pc-model>` or `<pc-node>`.\n",
|
|
14213
|
+
"tagName": "pc-sound",
|
|
13337
14214
|
"customElement": true,
|
|
13338
14215
|
"events": [
|
|
13339
14216
|
{
|
|
@@ -13353,7 +14230,7 @@
|
|
|
13353
14230
|
"exports": [
|
|
13354
14231
|
{
|
|
13355
14232
|
"kind": "custom-element-definition",
|
|
13356
|
-
"name": "pc-
|
|
14233
|
+
"name": "pc-sound",
|
|
13357
14234
|
"declaration": {
|
|
13358
14235
|
"name": "SoundComponentElement",
|
|
13359
14236
|
"module": "src/components/sound-component.ts"
|
|
@@ -13375,7 +14252,7 @@
|
|
|
13375
14252
|
"declarations": [
|
|
13376
14253
|
{
|
|
13377
14254
|
"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",
|
|
14255
|
+
"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
14256
|
"name": "SoundSlotElement",
|
|
13380
14257
|
"members": [
|
|
13381
14258
|
{
|
|
@@ -13434,7 +14311,7 @@
|
|
|
13434
14311
|
"type": {
|
|
13435
14312
|
"text": "EntityBaseElement | null"
|
|
13436
14313
|
},
|
|
13437
|
-
"description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or
|
|
14314
|
+
"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
14315
|
"return": {
|
|
13439
14316
|
"type": {
|
|
13440
14317
|
"text": ""
|
|
@@ -13669,7 +14546,8 @@
|
|
|
13669
14546
|
"name": "AsyncElement",
|
|
13670
14547
|
"module": "/src/async-element"
|
|
13671
14548
|
},
|
|
13672
|
-
"
|
|
14549
|
+
"summary": "The `<pc-sound-slot>` element declares one named sound on its parent `<pc-sound>`\n— its asset, volume, pitch, looping and autoplay. Must be a direct child of `<pc-sound>`.\n",
|
|
14550
|
+
"tagName": "pc-sound-slot",
|
|
13673
14551
|
"customElement": true,
|
|
13674
14552
|
"events": [
|
|
13675
14553
|
{
|
|
@@ -13689,7 +14567,7 @@
|
|
|
13689
14567
|
"exports": [
|
|
13690
14568
|
{
|
|
13691
14569
|
"kind": "custom-element-definition",
|
|
13692
|
-
"name": "pc-sound",
|
|
14570
|
+
"name": "pc-sound-slot",
|
|
13693
14571
|
"declaration": {
|
|
13694
14572
|
"name": "SoundSlotElement",
|
|
13695
14573
|
"module": "src/components/sound-slot.ts"
|