@playcanvas/web-components 0.11.1 → 0.13.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 +1 -1
- package/dist/app.d.cts +246 -0
- package/dist/app.d.ts +38 -13
- package/dist/asset.d.cts +218 -0
- package/dist/asset.d.ts +145 -6
- package/dist/async-element.d.cts +103 -0
- package/dist/async-element.d.ts +11 -8
- package/dist/colors.d.cts +1 -0
- package/dist/components/button-component.d.cts +186 -0
- package/dist/components/button-component.d.ts +1 -1
- package/dist/components/camera-component.d.cts +253 -0
- package/dist/components/camera-component.d.ts +1 -1
- package/dist/components/collision-component.d.cts +73 -0
- package/dist/components/collision-component.d.ts +17 -1
- package/dist/components/component.d.cts +82 -0
- package/dist/components/component.d.ts +20 -1
- package/dist/components/element-component.d.cts +316 -0
- package/dist/components/element-component.d.ts +1 -1
- package/dist/components/gsplat-component.d.cts +108 -0
- package/dist/components/gsplat-component.d.ts +1 -1
- package/dist/components/layoutchild-component.d.cts +110 -0
- package/dist/components/layoutchild-component.d.ts +1 -1
- package/dist/components/layoutgroup-component.d.cts +136 -0
- package/dist/components/layoutgroup-component.d.ts +1 -1
- package/dist/components/light-component.d.cts +264 -0
- package/dist/components/light-component.d.ts +1 -1
- package/dist/components/listener-component.d.cts +20 -0
- package/dist/components/listener-component.d.ts +1 -1
- package/dist/components/particlesystem-component.d.cts +52 -0
- package/dist/components/particlesystem-component.d.ts +1 -1
- package/dist/components/render-component.d.cts +76 -0
- package/dist/components/render-component.d.ts +1 -1
- package/dist/components/rigidbody-component.d.cts +88 -0
- package/dist/components/rigidbody-component.d.ts +1 -1
- package/dist/components/screen-component.d.cts +70 -0
- package/dist/components/screen-component.d.ts +1 -1
- package/dist/components/script-component.d.cts +163 -0
- package/dist/components/script-component.d.ts +1 -1
- package/dist/components/script.d.cts +94 -0
- package/dist/components/script.d.ts +1 -1
- package/dist/components/scrollbar-component.d.cts +69 -0
- package/dist/components/scrollbar-component.d.ts +1 -1
- package/dist/components/scrollview-component.d.cts +178 -0
- package/dist/components/scrollview-component.d.ts +1 -1
- package/dist/components/sound-component.d.cts +108 -0
- package/dist/components/sound-component.d.ts +1 -1
- package/dist/components/sound-slot.d.cts +134 -0
- package/dist/components/sound-slot.d.ts +2 -2
- package/dist/custom-elements.json +1127 -179
- package/dist/entity-base.d.cts +67 -0
- package/dist/entity-base.d.ts +67 -0
- package/dist/entity.d.cts +131 -0
- package/dist/entity.d.ts +3 -38
- package/dist/index.d.cts +79 -0
- package/dist/index.d.ts +35 -32
- package/dist/loading-bar.d.cts +35 -0
- package/dist/material.d.cts +1011 -0
- package/dist/material.d.ts +2 -1
- package/dist/model.d.cts +72 -0
- package/dist/model.d.ts +27 -5
- package/dist/module.d.cts +29 -0
- package/dist/module.d.ts +16 -10
- package/dist/node.d.cts +253 -0
- package/dist/node.d.ts +253 -0
- package/dist/parse.d.cts +147 -0
- package/dist/pwc.cjs +1496 -200
- package/dist/pwc.cjs.map +1 -1
- package/dist/pwc.js +1497 -201
- 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 +1496 -202
- package/dist/pwc.mjs.map +1 -1
- package/dist/scene.d.cts +117 -0
- package/dist/scene.d.ts +1 -1
- package/dist/sky.d.cts +121 -0
- package/dist/sky.d.ts +1 -1
- package/dist/vscode.html-custom-data.json +127 -5
- package/dist/web-types.json +399 -59
- package/package.json +16 -7
- package/src/app.ts +137 -45
- package/src/asset.ts +439 -9
- package/src/async-element.ts +11 -8
- package/src/components/collision-component.ts +35 -0
- package/src/components/component.ts +93 -3
- package/src/entity-base.ts +136 -0
- package/src/entity.ts +23 -117
- package/src/index.ts +5 -0
- package/src/loading-bar.ts +2 -2
- package/src/material.ts +2 -2
- package/src/model.ts +79 -11
- package/src/module.ts +39 -20
- package/src/node.ts +715 -0
- package/src/sky.ts +0 -1
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"declarations": [
|
|
9
9
|
{
|
|
10
10
|
"kind": "class",
|
|
11
|
-
"description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n",
|
|
11
|
+
"description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element is sized like a replaced element such as `<video>`: a block-level box that the\npage's CSS controls, 300x150 by default. The application's canvas always fills the element,\nand the drawing buffer resolution follows the element's size (capped by `max-pixel-ratio`),\ntracked live via a ResizeObserver — so the element can be embedded at any size, resized by\nits container, or made fullscreen with ordinary CSS such as `width: 100vw; height: 100dvh`.\n",
|
|
12
12
|
"name": "AppElement",
|
|
13
13
|
"members": [
|
|
14
14
|
{
|
|
@@ -95,9 +95,9 @@
|
|
|
95
95
|
"kind": "field",
|
|
96
96
|
"name": "closestEntity",
|
|
97
97
|
"type": {
|
|
98
|
-
"text": "
|
|
98
|
+
"text": "EntityBaseElement | null"
|
|
99
99
|
},
|
|
100
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
100
|
+
"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.",
|
|
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>` element whose backing entity is `entity`, or
|
|
145
|
+
"description": "Returns the `<pc-entity>` or `<pc-node>` element whose backing entity is `entity`, or\n`null` if the entity is not fronted by an element of this application - for example, an\nunbound node inside a model's instantiated hierarchy, or an entity created through the\nengine API."
|
|
146
146
|
},
|
|
147
147
|
{
|
|
148
148
|
"kind": "field",
|
|
@@ -222,6 +222,13 @@
|
|
|
222
222
|
}
|
|
223
223
|
],
|
|
224
224
|
"events": [
|
|
225
|
+
{
|
|
226
|
+
"name": "error",
|
|
227
|
+
"type": {
|
|
228
|
+
"text": "ErrorEvent"
|
|
229
|
+
},
|
|
230
|
+
"description": "Fired when the application cannot boot because no graphics device could be created (for example, a browser with WebGL disabled). `message` names the requested backends and `error` holds the underlying failure. The element never becomes ready and `app` stays `null` — listen for this event to show a fallback UI. Removing the element and re-inserting it retries the boot with its current attributes. Does not bubble."
|
|
231
|
+
},
|
|
225
232
|
{
|
|
226
233
|
"name": "progress",
|
|
227
234
|
"type": {
|
|
@@ -339,9 +346,66 @@
|
|
|
339
346
|
"declarations": [
|
|
340
347
|
{
|
|
341
348
|
"kind": "class",
|
|
342
|
-
"description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nApart from `lazy
|
|
349
|
+
"description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nFor `texture` and `textureatlas` assets, the texture options (`address-u`, `address-v`,\n`min-filter`, `mag-filter`, `anisotropy`, `mipmaps`, `srgb`, `flip-y`) apply when the texture is\ncreated and — like `lazy` — are observed: changing one updates a texture that has already\nloaded, and removing one restores the engine default. Changing `srgb` or `mipmaps` on a loaded\ntexture recreates the underlying GPU resource, so prefer declaring those up front. Each option\noverrides the matching key in the `data` JSON; options left unset write nothing, leaving the\nengine's per-format defaults in force.\n\nApart from `lazy` and the texture options, these attributes are read once when the asset is\ncreated, so changing them later has no effect.\n",
|
|
343
350
|
"name": "AssetElement",
|
|
344
351
|
"members": [
|
|
352
|
+
{
|
|
353
|
+
"kind": "field",
|
|
354
|
+
"name": "addressU",
|
|
355
|
+
"description": "Gets the texture's horizontal (U) address mode.",
|
|
356
|
+
"parameters": [
|
|
357
|
+
{
|
|
358
|
+
"description": "The address mode, or `null` to use the engine default of 'repeat'.",
|
|
359
|
+
"name": "value"
|
|
360
|
+
}
|
|
361
|
+
],
|
|
362
|
+
"type": {
|
|
363
|
+
"text": "AddressMode | null"
|
|
364
|
+
},
|
|
365
|
+
"return": {
|
|
366
|
+
"type": {
|
|
367
|
+
"text": ""
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"kind": "field",
|
|
373
|
+
"name": "addressV",
|
|
374
|
+
"description": "Gets the texture's vertical (V) address mode.",
|
|
375
|
+
"parameters": [
|
|
376
|
+
{
|
|
377
|
+
"description": "The address mode, or `null` to use the engine default of 'repeat'.",
|
|
378
|
+
"name": "value"
|
|
379
|
+
}
|
|
380
|
+
],
|
|
381
|
+
"type": {
|
|
382
|
+
"text": "AddressMode | null"
|
|
383
|
+
},
|
|
384
|
+
"return": {
|
|
385
|
+
"type": {
|
|
386
|
+
"text": ""
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"kind": "field",
|
|
392
|
+
"name": "anisotropy",
|
|
393
|
+
"description": "Gets the texture's maximum anisotropic filtering level.",
|
|
394
|
+
"parameters": [
|
|
395
|
+
{
|
|
396
|
+
"description": "The anisotropy level, or `null` to use the engine default of 1.",
|
|
397
|
+
"name": "value"
|
|
398
|
+
}
|
|
399
|
+
],
|
|
400
|
+
"type": {
|
|
401
|
+
"text": "number | null"
|
|
402
|
+
},
|
|
403
|
+
"return": {
|
|
404
|
+
"type": {
|
|
405
|
+
"text": ""
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
},
|
|
345
409
|
{
|
|
346
410
|
"kind": "field",
|
|
347
411
|
"name": "asset",
|
|
@@ -373,9 +437,9 @@
|
|
|
373
437
|
"kind": "field",
|
|
374
438
|
"name": "closestEntity",
|
|
375
439
|
"type": {
|
|
376
|
-
"text": "
|
|
440
|
+
"text": "EntityBaseElement | null"
|
|
377
441
|
},
|
|
378
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
442
|
+
"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.",
|
|
379
443
|
"return": {
|
|
380
444
|
"type": {
|
|
381
445
|
"text": ""
|
|
@@ -387,6 +451,25 @@
|
|
|
387
451
|
"module": "src/async-element.ts"
|
|
388
452
|
}
|
|
389
453
|
},
|
|
454
|
+
{
|
|
455
|
+
"kind": "field",
|
|
456
|
+
"name": "flipY",
|
|
457
|
+
"description": "Gets whether the texture's image data is flipped vertically at upload.",
|
|
458
|
+
"parameters": [
|
|
459
|
+
{
|
|
460
|
+
"description": "The flip flag, or `null` to use the engine default of `false`.",
|
|
461
|
+
"name": "value"
|
|
462
|
+
}
|
|
463
|
+
],
|
|
464
|
+
"type": {
|
|
465
|
+
"text": "boolean | null"
|
|
466
|
+
},
|
|
467
|
+
"return": {
|
|
468
|
+
"type": {
|
|
469
|
+
"text": ""
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
},
|
|
390
473
|
{
|
|
391
474
|
"kind": "method",
|
|
392
475
|
"name": "get",
|
|
@@ -423,6 +506,63 @@
|
|
|
423
506
|
}
|
|
424
507
|
}
|
|
425
508
|
},
|
|
509
|
+
{
|
|
510
|
+
"kind": "field",
|
|
511
|
+
"name": "magFilter",
|
|
512
|
+
"description": "Gets the texture's magnification filter.",
|
|
513
|
+
"parameters": [
|
|
514
|
+
{
|
|
515
|
+
"description": "The filter, or `null` to use the engine default of 'linear'.",
|
|
516
|
+
"name": "value"
|
|
517
|
+
}
|
|
518
|
+
],
|
|
519
|
+
"type": {
|
|
520
|
+
"text": "MagFilterMode | null"
|
|
521
|
+
},
|
|
522
|
+
"return": {
|
|
523
|
+
"type": {
|
|
524
|
+
"text": ""
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"kind": "field",
|
|
530
|
+
"name": "minFilter",
|
|
531
|
+
"description": "Gets the texture's minification filter.",
|
|
532
|
+
"parameters": [
|
|
533
|
+
{
|
|
534
|
+
"description": "The filter, or `null` to use the engine default of 'linear-mip-linear'.",
|
|
535
|
+
"name": "value"
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"type": {
|
|
539
|
+
"text": "MinFilterMode | null"
|
|
540
|
+
},
|
|
541
|
+
"return": {
|
|
542
|
+
"type": {
|
|
543
|
+
"text": ""
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"kind": "field",
|
|
549
|
+
"name": "mipmaps",
|
|
550
|
+
"description": "Gets whether the texture generates and uses mipmaps.",
|
|
551
|
+
"parameters": [
|
|
552
|
+
{
|
|
553
|
+
"description": "The mipmaps flag, or `null` to use the engine default of `true`.",
|
|
554
|
+
"name": "value"
|
|
555
|
+
}
|
|
556
|
+
],
|
|
557
|
+
"type": {
|
|
558
|
+
"text": "boolean | null"
|
|
559
|
+
},
|
|
560
|
+
"return": {
|
|
561
|
+
"type": {
|
|
562
|
+
"text": ""
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
},
|
|
426
566
|
{
|
|
427
567
|
"kind": "method",
|
|
428
568
|
"name": "ready",
|
|
@@ -436,6 +576,25 @@
|
|
|
436
576
|
"name": "AsyncElement",
|
|
437
577
|
"module": "src/async-element.ts"
|
|
438
578
|
}
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"kind": "field",
|
|
582
|
+
"name": "srgb",
|
|
583
|
+
"description": "Gets whether the texture holds sRGB (gamma-encoded) color data.",
|
|
584
|
+
"parameters": [
|
|
585
|
+
{
|
|
586
|
+
"description": "The sRGB flag, or `null` to use the engine default of `false`.",
|
|
587
|
+
"name": "value"
|
|
588
|
+
}
|
|
589
|
+
],
|
|
590
|
+
"type": {
|
|
591
|
+
"text": "boolean | null"
|
|
592
|
+
},
|
|
593
|
+
"return": {
|
|
594
|
+
"type": {
|
|
595
|
+
"text": ""
|
|
596
|
+
}
|
|
597
|
+
}
|
|
439
598
|
}
|
|
440
599
|
],
|
|
441
600
|
"events": [
|
|
@@ -466,6 +625,33 @@
|
|
|
466
625
|
}
|
|
467
626
|
],
|
|
468
627
|
"attributes": [
|
|
628
|
+
{
|
|
629
|
+
"name": "address-u",
|
|
630
|
+
"type": {
|
|
631
|
+
"text": "'repeat' | 'clamp' | 'mirror'"
|
|
632
|
+
},
|
|
633
|
+
"fieldName": "addressU",
|
|
634
|
+
"default": "repeat",
|
|
635
|
+
"description": "The texture's horizontal (U) address mode."
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "address-v",
|
|
639
|
+
"type": {
|
|
640
|
+
"text": "'repeat' | 'clamp' | 'mirror'"
|
|
641
|
+
},
|
|
642
|
+
"fieldName": "addressV",
|
|
643
|
+
"default": "repeat",
|
|
644
|
+
"description": "The texture's vertical (V) address mode."
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"name": "anisotropy",
|
|
648
|
+
"type": {
|
|
649
|
+
"text": "number"
|
|
650
|
+
},
|
|
651
|
+
"fieldName": "anisotropy",
|
|
652
|
+
"default": "1",
|
|
653
|
+
"description": "The texture's maximum anisotropic filtering level."
|
|
654
|
+
},
|
|
469
655
|
{
|
|
470
656
|
"type": {
|
|
471
657
|
"text": "string"
|
|
@@ -480,6 +666,15 @@
|
|
|
480
666
|
"description": "Additional asset data, as a JSON object.",
|
|
481
667
|
"name": "data"
|
|
482
668
|
},
|
|
669
|
+
{
|
|
670
|
+
"name": "flip-y",
|
|
671
|
+
"type": {
|
|
672
|
+
"text": "boolean"
|
|
673
|
+
},
|
|
674
|
+
"fieldName": "flipY",
|
|
675
|
+
"default": "false",
|
|
676
|
+
"description": "Whether the texture's image data is flipped vertically at upload."
|
|
677
|
+
},
|
|
483
678
|
{
|
|
484
679
|
"type": {
|
|
485
680
|
"text": "string"
|
|
@@ -503,6 +698,33 @@
|
|
|
503
698
|
"default": "false",
|
|
504
699
|
"description": "Whether the asset should be loaded lazily."
|
|
505
700
|
},
|
|
701
|
+
{
|
|
702
|
+
"name": "mag-filter",
|
|
703
|
+
"type": {
|
|
704
|
+
"text": "'nearest' | 'linear'"
|
|
705
|
+
},
|
|
706
|
+
"fieldName": "magFilter",
|
|
707
|
+
"default": "linear",
|
|
708
|
+
"description": "The texture's magnification filter."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "min-filter",
|
|
712
|
+
"type": {
|
|
713
|
+
"text": "'nearest' | 'linear' | 'nearest-mip-nearest' | 'linear-mip-nearest' | 'nearest-mip-linear' | 'linear-mip-linear'"
|
|
714
|
+
},
|
|
715
|
+
"fieldName": "minFilter",
|
|
716
|
+
"default": "linear-mip-linear",
|
|
717
|
+
"description": "The texture's minification filter."
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
"name": "mipmaps",
|
|
721
|
+
"type": {
|
|
722
|
+
"text": "boolean"
|
|
723
|
+
},
|
|
724
|
+
"fieldName": "mipmaps",
|
|
725
|
+
"default": "true",
|
|
726
|
+
"description": "Whether the texture generates and uses mipmaps."
|
|
727
|
+
},
|
|
506
728
|
{
|
|
507
729
|
"type": {
|
|
508
730
|
"text": "number"
|
|
@@ -524,6 +746,15 @@
|
|
|
524
746
|
"description": "The URL of the asset to load.",
|
|
525
747
|
"name": "src"
|
|
526
748
|
},
|
|
749
|
+
{
|
|
750
|
+
"name": "srgb",
|
|
751
|
+
"type": {
|
|
752
|
+
"text": "boolean"
|
|
753
|
+
},
|
|
754
|
+
"fieldName": "srgb",
|
|
755
|
+
"default": "false",
|
|
756
|
+
"description": "Whether the texture holds sRGB (gamma-encoded) color data."
|
|
757
|
+
},
|
|
527
758
|
{
|
|
528
759
|
"type": {
|
|
529
760
|
"text": "string"
|
|
@@ -586,9 +817,9 @@
|
|
|
586
817
|
"kind": "field",
|
|
587
818
|
"name": "closestEntity",
|
|
588
819
|
"type": {
|
|
589
|
-
"text": "
|
|
820
|
+
"text": "EntityBaseElement | null"
|
|
590
821
|
},
|
|
591
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
822
|
+
"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.",
|
|
592
823
|
"return": {
|
|
593
824
|
"type": {
|
|
594
825
|
"text": ""
|
|
@@ -638,7 +869,7 @@
|
|
|
638
869
|
"description": "The tag name of the element to wait for (e.g. `'pc-app'`)."
|
|
639
870
|
}
|
|
640
871
|
],
|
|
641
|
-
"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-scripts>`). A component element outside a `<pc-entity>` is\nthe exception: it still becomes ready, but its `component` is `null`. Either way, a misplaced\nelement logs a warning naming the parent it requires."
|
|
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-scripts>`, or a `<pc-app>` that could not create a graphics\ndevice — listen for its `error` event instead). A component element outside a `<pc-entity>` is\nthe exception: it still becomes ready, but its `component` is `null`. Either way, a misplaced\nelement logs a warning naming the parent it requires."
|
|
642
873
|
},
|
|
643
874
|
{
|
|
644
875
|
"kind": "function",
|
|
@@ -676,7 +907,7 @@
|
|
|
676
907
|
"description": "A CSS selector matching the element to wait for (e.g. `'#my-app'`)."
|
|
677
908
|
}
|
|
678
909
|
],
|
|
679
|
-
"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-scripts>`). A component element outside a `<pc-entity>` is\nthe exception: it still becomes ready, but its `component` is `null`. Either way, a misplaced\nelement logs a warning naming the parent it requires."
|
|
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-scripts>`, or a `<pc-app>` that could not create a graphics\ndevice — listen for its `error` event instead). A component element outside a `<pc-entity>` is\nthe exception: it still becomes ready, but its `component` is `null`. Either way, a misplaced\nelement logs a warning naming the parent it requires."
|
|
680
911
|
},
|
|
681
912
|
{
|
|
682
913
|
"kind": "function",
|
|
@@ -725,12 +956,12 @@
|
|
|
725
956
|
},
|
|
726
957
|
{
|
|
727
958
|
"kind": "javascript-module",
|
|
728
|
-
"path": "src/entity.ts",
|
|
959
|
+
"path": "src/entity-base.ts",
|
|
729
960
|
"declarations": [
|
|
730
961
|
{
|
|
731
962
|
"kind": "class",
|
|
732
|
-
"description": "The
|
|
733
|
-
"name": "
|
|
963
|
+
"description": "The base class for elements that front an engine Entity: `<pc-entity>`, which creates\none, and `<pc-node>`, which binds to one inside a model's instantiated hierarchy. It carries\nwhat both need — the `entity` contract, registration with the owning application (which joins\npicked scene nodes back to elements by identity, never by name), and the pointer listener\nbookkeeping that lets the application lazily attach its canvas handlers.",
|
|
964
|
+
"name": "EntityBaseElement",
|
|
734
965
|
"members": [
|
|
735
966
|
{
|
|
736
967
|
"kind": "method",
|
|
@@ -779,9 +1010,9 @@
|
|
|
779
1010
|
"kind": "field",
|
|
780
1011
|
"name": "closestEntity",
|
|
781
1012
|
"type": {
|
|
782
|
-
"text": "
|
|
1013
|
+
"text": "EntityBaseElement | null"
|
|
783
1014
|
},
|
|
784
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
1015
|
+
"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.",
|
|
785
1016
|
"return": {
|
|
786
1017
|
"type": {
|
|
787
1018
|
"text": ""
|
|
@@ -793,29 +1024,13 @@
|
|
|
793
1024
|
"module": "src/async-element.ts"
|
|
794
1025
|
}
|
|
795
1026
|
},
|
|
796
|
-
{
|
|
797
|
-
"kind": "field",
|
|
798
|
-
"name": "enabled",
|
|
799
|
-
"description": "Gets the enabled state of the entity.",
|
|
800
|
-
"parameters": [
|
|
801
|
-
{
|
|
802
|
-
"description": "Whether the entity is enabled.",
|
|
803
|
-
"name": "value"
|
|
804
|
-
}
|
|
805
|
-
],
|
|
806
|
-
"return": {
|
|
807
|
-
"type": {
|
|
808
|
-
"text": ""
|
|
809
|
-
}
|
|
810
|
-
}
|
|
811
|
-
},
|
|
812
1027
|
{
|
|
813
1028
|
"kind": "field",
|
|
814
1029
|
"name": "entity",
|
|
815
1030
|
"type": {
|
|
816
1031
|
"text": "Entity | null"
|
|
817
1032
|
},
|
|
818
|
-
"description": "The PlayCanvas entity instance. `null` until the element is ready, and again once
|
|
1033
|
+
"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.",
|
|
819
1034
|
"return": {
|
|
820
1035
|
"type": {
|
|
821
1036
|
"text": ""
|
|
@@ -823,38 +1038,6 @@
|
|
|
823
1038
|
},
|
|
824
1039
|
"readonly": true
|
|
825
1040
|
},
|
|
826
|
-
{
|
|
827
|
-
"kind": "field",
|
|
828
|
-
"name": "name",
|
|
829
|
-
"description": "Gets the name of the entity.",
|
|
830
|
-
"parameters": [
|
|
831
|
-
{
|
|
832
|
-
"description": "The name of the entity.",
|
|
833
|
-
"name": "value"
|
|
834
|
-
}
|
|
835
|
-
],
|
|
836
|
-
"return": {
|
|
837
|
-
"type": {
|
|
838
|
-
"text": ""
|
|
839
|
-
}
|
|
840
|
-
}
|
|
841
|
-
},
|
|
842
|
-
{
|
|
843
|
-
"kind": "field",
|
|
844
|
-
"name": "position",
|
|
845
|
-
"description": "Gets the position of the entity.",
|
|
846
|
-
"parameters": [
|
|
847
|
-
{
|
|
848
|
-
"description": "The position of the entity.",
|
|
849
|
-
"name": "value"
|
|
850
|
-
}
|
|
851
|
-
],
|
|
852
|
-
"return": {
|
|
853
|
-
"type": {
|
|
854
|
-
"text": ""
|
|
855
|
-
}
|
|
856
|
-
}
|
|
857
|
-
},
|
|
858
1041
|
{
|
|
859
1042
|
"kind": "method",
|
|
860
1043
|
"name": "ready",
|
|
@@ -893,34 +1076,248 @@
|
|
|
893
1076
|
}
|
|
894
1077
|
}
|
|
895
1078
|
]
|
|
896
|
-
}
|
|
1079
|
+
}
|
|
1080
|
+
],
|
|
1081
|
+
"events": [
|
|
897
1082
|
{
|
|
898
|
-
"
|
|
899
|
-
"
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
],
|
|
907
|
-
"return": {
|
|
908
|
-
"type": {
|
|
909
|
-
"text": ""
|
|
910
|
-
}
|
|
1083
|
+
"name": "ready",
|
|
1084
|
+
"type": {
|
|
1085
|
+
"text": "CustomEvent"
|
|
1086
|
+
},
|
|
1087
|
+
"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.",
|
|
1088
|
+
"inheritedFrom": {
|
|
1089
|
+
"name": "AsyncElement",
|
|
1090
|
+
"module": "src/async-element.ts"
|
|
911
1091
|
}
|
|
912
|
-
}
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
1092
|
+
}
|
|
1093
|
+
],
|
|
1094
|
+
"superclass": {
|
|
1095
|
+
"name": "AsyncElement",
|
|
1096
|
+
"module": "/src/async-element"
|
|
1097
|
+
}
|
|
1098
|
+
}
|
|
1099
|
+
],
|
|
1100
|
+
"exports": [
|
|
1101
|
+
{
|
|
1102
|
+
"kind": "js",
|
|
1103
|
+
"name": "EntityBaseElement",
|
|
1104
|
+
"declaration": {
|
|
1105
|
+
"name": "EntityBaseElement",
|
|
1106
|
+
"module": "src/entity-base.ts"
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
]
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"kind": "javascript-module",
|
|
1113
|
+
"path": "src/entity.ts",
|
|
1114
|
+
"declarations": [
|
|
1115
|
+
{
|
|
1116
|
+
"kind": "class",
|
|
1117
|
+
"description": "The EntityElement interface provides properties and methods for manipulating\n[`<pc-entity>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-entity/) elements.\nThe EntityElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe pointer events below are dispatched by the containing `<pc-app>` element when the pointer\nintersects this entity's geometry. They are only generated while the entity has a listener for\nthem, registered either with addEventListener or with the matching inline `onpointer*`\nattribute.\n",
|
|
1118
|
+
"name": "EntityElement",
|
|
1119
|
+
"members": [
|
|
1120
|
+
{
|
|
1121
|
+
"kind": "method",
|
|
1122
|
+
"name": "addEventListener",
|
|
1123
|
+
"parameters": [
|
|
1124
|
+
{
|
|
1125
|
+
"name": "type",
|
|
1126
|
+
"type": {
|
|
1127
|
+
"text": "string"
|
|
1128
|
+
}
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "listener",
|
|
1132
|
+
"type": {
|
|
1133
|
+
"text": "EventListener"
|
|
1134
|
+
}
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "options",
|
|
1138
|
+
"optional": true,
|
|
1139
|
+
"type": {
|
|
1140
|
+
"text": "boolean | AddEventListenerOptions"
|
|
1141
|
+
}
|
|
1142
|
+
}
|
|
1143
|
+
],
|
|
1144
|
+
"inheritedFrom": {
|
|
1145
|
+
"name": "EntityBaseElement",
|
|
1146
|
+
"module": "src/entity-base.ts"
|
|
1147
|
+
}
|
|
1148
|
+
},
|
|
1149
|
+
{
|
|
1150
|
+
"kind": "field",
|
|
1151
|
+
"name": "closestApp",
|
|
1152
|
+
"type": {
|
|
1153
|
+
"text": "AppElement | null"
|
|
1154
|
+
},
|
|
1155
|
+
"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.",
|
|
1156
|
+
"return": {
|
|
1157
|
+
"type": {
|
|
1158
|
+
"text": ""
|
|
1159
|
+
}
|
|
1160
|
+
},
|
|
1161
|
+
"readonly": true,
|
|
1162
|
+
"inheritedFrom": {
|
|
1163
|
+
"name": "AsyncElement",
|
|
1164
|
+
"module": "src/async-element.ts"
|
|
1165
|
+
}
|
|
1166
|
+
},
|
|
1167
|
+
{
|
|
1168
|
+
"kind": "field",
|
|
1169
|
+
"name": "closestEntity",
|
|
1170
|
+
"type": {
|
|
1171
|
+
"text": "EntityBaseElement | null"
|
|
1172
|
+
},
|
|
1173
|
+
"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.",
|
|
1174
|
+
"return": {
|
|
1175
|
+
"type": {
|
|
1176
|
+
"text": ""
|
|
1177
|
+
}
|
|
1178
|
+
},
|
|
1179
|
+
"readonly": true,
|
|
1180
|
+
"inheritedFrom": {
|
|
1181
|
+
"name": "AsyncElement",
|
|
1182
|
+
"module": "src/async-element.ts"
|
|
1183
|
+
}
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"kind": "field",
|
|
1187
|
+
"name": "enabled",
|
|
1188
|
+
"description": "Gets the enabled state of the entity.",
|
|
1189
|
+
"parameters": [
|
|
1190
|
+
{
|
|
1191
|
+
"description": "Whether the entity is enabled.",
|
|
1192
|
+
"name": "value"
|
|
1193
|
+
}
|
|
1194
|
+
],
|
|
1195
|
+
"return": {
|
|
1196
|
+
"type": {
|
|
1197
|
+
"text": ""
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
},
|
|
1201
|
+
{
|
|
1202
|
+
"kind": "field",
|
|
1203
|
+
"name": "entity",
|
|
1204
|
+
"type": {
|
|
1205
|
+
"text": "Entity | null"
|
|
1206
|
+
},
|
|
1207
|
+
"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.",
|
|
1208
|
+
"return": {
|
|
1209
|
+
"type": {
|
|
1210
|
+
"text": ""
|
|
1211
|
+
}
|
|
1212
|
+
},
|
|
1213
|
+
"readonly": true,
|
|
1214
|
+
"inheritedFrom": {
|
|
1215
|
+
"name": "EntityBaseElement",
|
|
1216
|
+
"module": "src/entity-base.ts"
|
|
1217
|
+
}
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
"kind": "field",
|
|
1221
|
+
"name": "name",
|
|
1222
|
+
"description": "Gets the name of the entity.",
|
|
1223
|
+
"parameters": [
|
|
1224
|
+
{
|
|
1225
|
+
"description": "The name of the entity.",
|
|
1226
|
+
"name": "value"
|
|
1227
|
+
}
|
|
1228
|
+
],
|
|
1229
|
+
"return": {
|
|
1230
|
+
"type": {
|
|
1231
|
+
"text": ""
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"kind": "field",
|
|
1237
|
+
"name": "position",
|
|
1238
|
+
"description": "Gets the position of the entity.",
|
|
1239
|
+
"parameters": [
|
|
1240
|
+
{
|
|
1241
|
+
"description": "The position of the entity.",
|
|
1242
|
+
"name": "value"
|
|
1243
|
+
}
|
|
1244
|
+
],
|
|
1245
|
+
"return": {
|
|
1246
|
+
"type": {
|
|
1247
|
+
"text": ""
|
|
1248
|
+
}
|
|
1249
|
+
}
|
|
1250
|
+
},
|
|
1251
|
+
{
|
|
1252
|
+
"kind": "method",
|
|
1253
|
+
"name": "ready",
|
|
1254
|
+
"return": {
|
|
1255
|
+
"type": {
|
|
1256
|
+
"text": ""
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
"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.",
|
|
1260
|
+
"inheritedFrom": {
|
|
1261
|
+
"name": "AsyncElement",
|
|
1262
|
+
"module": "src/async-element.ts"
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"kind": "method",
|
|
1267
|
+
"name": "removeEventListener",
|
|
1268
|
+
"parameters": [
|
|
1269
|
+
{
|
|
1270
|
+
"name": "type",
|
|
1271
|
+
"type": {
|
|
1272
|
+
"text": "string"
|
|
1273
|
+
}
|
|
1274
|
+
},
|
|
1275
|
+
{
|
|
1276
|
+
"name": "listener",
|
|
1277
|
+
"type": {
|
|
1278
|
+
"text": "EventListener"
|
|
1279
|
+
}
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"name": "options",
|
|
1283
|
+
"optional": true,
|
|
1284
|
+
"type": {
|
|
1285
|
+
"text": "boolean | EventListenerOptions"
|
|
1286
|
+
}
|
|
1287
|
+
}
|
|
1288
|
+
],
|
|
1289
|
+
"inheritedFrom": {
|
|
1290
|
+
"name": "EntityBaseElement",
|
|
1291
|
+
"module": "src/entity-base.ts"
|
|
1292
|
+
}
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"kind": "field",
|
|
1296
|
+
"name": "rotation",
|
|
1297
|
+
"description": "Gets the rotation of the entity.",
|
|
1298
|
+
"parameters": [
|
|
1299
|
+
{
|
|
1300
|
+
"description": "The rotation of the entity.",
|
|
1301
|
+
"name": "value"
|
|
1302
|
+
}
|
|
1303
|
+
],
|
|
1304
|
+
"return": {
|
|
1305
|
+
"type": {
|
|
1306
|
+
"text": ""
|
|
1307
|
+
}
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"kind": "field",
|
|
1312
|
+
"name": "scale",
|
|
1313
|
+
"description": "Gets the scale of the entity.",
|
|
1314
|
+
"parameters": [
|
|
1315
|
+
{
|
|
1316
|
+
"description": "The scale of the entity.",
|
|
1317
|
+
"name": "value"
|
|
1318
|
+
}
|
|
1319
|
+
],
|
|
1320
|
+
"return": {
|
|
924
1321
|
"type": {
|
|
925
1322
|
"text": ""
|
|
926
1323
|
}
|
|
@@ -1010,43 +1407,43 @@
|
|
|
1010
1407
|
"description": "The name of the entity."
|
|
1011
1408
|
},
|
|
1012
1409
|
{
|
|
1013
|
-
"name": "onpointerdown",
|
|
1014
1410
|
"type": {
|
|
1015
1411
|
"text": "string"
|
|
1016
1412
|
},
|
|
1017
1413
|
"description": "Script to run when a pointer button is pressed over the entity.",
|
|
1414
|
+
"name": "onpointerdown",
|
|
1018
1415
|
"fieldName": "onpointerdown"
|
|
1019
1416
|
},
|
|
1020
1417
|
{
|
|
1021
|
-
"name": "onpointerenter",
|
|
1022
1418
|
"type": {
|
|
1023
1419
|
"text": "string"
|
|
1024
1420
|
},
|
|
1025
1421
|
"description": "Script to run when the pointer moves onto the entity.",
|
|
1422
|
+
"name": "onpointerenter",
|
|
1026
1423
|
"fieldName": "onpointerenter"
|
|
1027
1424
|
},
|
|
1028
1425
|
{
|
|
1029
|
-
"name": "onpointerleave",
|
|
1030
1426
|
"type": {
|
|
1031
1427
|
"text": "string"
|
|
1032
1428
|
},
|
|
1033
1429
|
"description": "Script to run when the pointer moves off the entity.",
|
|
1430
|
+
"name": "onpointerleave",
|
|
1034
1431
|
"fieldName": "onpointerleave"
|
|
1035
1432
|
},
|
|
1036
1433
|
{
|
|
1037
|
-
"name": "onpointermove",
|
|
1038
1434
|
"type": {
|
|
1039
1435
|
"text": "string"
|
|
1040
1436
|
},
|
|
1041
1437
|
"description": "Script to run when the pointer moves over the entity.",
|
|
1438
|
+
"name": "onpointermove",
|
|
1042
1439
|
"fieldName": "onpointermove"
|
|
1043
1440
|
},
|
|
1044
1441
|
{
|
|
1045
|
-
"name": "onpointerup",
|
|
1046
1442
|
"type": {
|
|
1047
1443
|
"text": "string"
|
|
1048
1444
|
},
|
|
1049
1445
|
"description": "Script to run when a pointer button is released over the entity.",
|
|
1446
|
+
"name": "onpointerup",
|
|
1050
1447
|
"fieldName": "onpointerup"
|
|
1051
1448
|
},
|
|
1052
1449
|
{
|
|
@@ -1086,8 +1483,8 @@
|
|
|
1086
1483
|
}
|
|
1087
1484
|
],
|
|
1088
1485
|
"superclass": {
|
|
1089
|
-
"name": "
|
|
1090
|
-
"module": "/src/
|
|
1486
|
+
"name": "EntityBaseElement",
|
|
1487
|
+
"module": "/src/entity-base"
|
|
1091
1488
|
},
|
|
1092
1489
|
"tagName": "pc-entity",
|
|
1093
1490
|
"customElement": true
|
|
@@ -1317,6 +1714,14 @@
|
|
|
1317
1714
|
"module": "src/index.ts"
|
|
1318
1715
|
}
|
|
1319
1716
|
},
|
|
1717
|
+
{
|
|
1718
|
+
"kind": "js",
|
|
1719
|
+
"name": "EntityBaseElement",
|
|
1720
|
+
"declaration": {
|
|
1721
|
+
"name": "EntityBaseElement",
|
|
1722
|
+
"module": "src/index.ts"
|
|
1723
|
+
}
|
|
1724
|
+
},
|
|
1320
1725
|
{
|
|
1321
1726
|
"kind": "js",
|
|
1322
1727
|
"name": "MaterialElement",
|
|
@@ -1333,6 +1738,14 @@
|
|
|
1333
1738
|
"module": "src/index.ts"
|
|
1334
1739
|
}
|
|
1335
1740
|
},
|
|
1741
|
+
{
|
|
1742
|
+
"kind": "js",
|
|
1743
|
+
"name": "NodeElement",
|
|
1744
|
+
"declaration": {
|
|
1745
|
+
"name": "NodeElement",
|
|
1746
|
+
"module": "src/index.ts"
|
|
1747
|
+
}
|
|
1748
|
+
},
|
|
1336
1749
|
{
|
|
1337
1750
|
"kind": "js",
|
|
1338
1751
|
"name": "SceneElement",
|
|
@@ -3526,7 +3939,7 @@
|
|
|
3526
3939
|
"declarations": [
|
|
3527
3940
|
{
|
|
3528
3941
|
"kind": "class",
|
|
3529
|
-
"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",
|
|
3942
|
+
"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 becomes ready once its container asset has loaded and the instantiated hierarchy has\nbeen added to the scene — `entity` is non-null by then. A failed load also settles readiness,\nwith `entity` remaining `null`: readiness means the load settled, not that it succeeded — listen\nfor `error`, or check `entity`, to tell the outcomes apart. Changing `asset` re-arms readiness\nand instantiates anew, so a `ready()` obtained after the change resolves against the new\nhierarchy. A `pc-model` outside a `pc-app`, or referencing an unknown asset id, warns and never\nbecomes ready.\n",
|
|
3530
3943
|
"name": "ModelElement",
|
|
3531
3944
|
"members": [
|
|
3532
3945
|
{
|
|
@@ -3570,9 +3983,9 @@
|
|
|
3570
3983
|
"kind": "field",
|
|
3571
3984
|
"name": "closestEntity",
|
|
3572
3985
|
"type": {
|
|
3573
|
-
"text": "
|
|
3986
|
+
"text": "EntityBaseElement | null"
|
|
3574
3987
|
},
|
|
3575
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
3988
|
+
"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.",
|
|
3576
3989
|
"return": {
|
|
3577
3990
|
"type": {
|
|
3578
3991
|
"text": ""
|
|
@@ -3613,23 +4026,21 @@
|
|
|
3613
4026
|
}
|
|
3614
4027
|
}
|
|
3615
4028
|
],
|
|
3616
|
-
"
|
|
4029
|
+
"events": [
|
|
3617
4030
|
{
|
|
3618
|
-
"name": "
|
|
4031
|
+
"name": "error",
|
|
3619
4032
|
"type": {
|
|
3620
|
-
"text": "
|
|
4033
|
+
"text": "ErrorEvent"
|
|
3621
4034
|
},
|
|
3622
|
-
"
|
|
3623
|
-
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
"customElement": true,
|
|
3632
|
-
"events": [
|
|
4035
|
+
"description": "Fired when the container asset fails to load, with the engine's error in `message`. Does not bubble. The element still becomes ready — readiness means the load settled, not that it succeeded."
|
|
4036
|
+
},
|
|
4037
|
+
{
|
|
4038
|
+
"name": "load",
|
|
4039
|
+
"type": {
|
|
4040
|
+
"text": "Event"
|
|
4041
|
+
},
|
|
4042
|
+
"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."
|
|
4043
|
+
},
|
|
3633
4044
|
{
|
|
3634
4045
|
"name": "ready",
|
|
3635
4046
|
"type": {
|
|
@@ -3641,7 +4052,23 @@
|
|
|
3641
4052
|
"module": "src/async-element.ts"
|
|
3642
4053
|
}
|
|
3643
4054
|
}
|
|
3644
|
-
]
|
|
4055
|
+
],
|
|
4056
|
+
"attributes": [
|
|
4057
|
+
{
|
|
4058
|
+
"name": "asset",
|
|
4059
|
+
"type": {
|
|
4060
|
+
"text": "string"
|
|
4061
|
+
},
|
|
4062
|
+
"fieldName": "asset",
|
|
4063
|
+
"description": "The id of the `pc-asset` to use for the model."
|
|
4064
|
+
}
|
|
4065
|
+
],
|
|
4066
|
+
"superclass": {
|
|
4067
|
+
"name": "AsyncElement",
|
|
4068
|
+
"module": "/src/async-element"
|
|
4069
|
+
},
|
|
4070
|
+
"tagName": "pc-model",
|
|
4071
|
+
"customElement": true
|
|
3645
4072
|
}
|
|
3646
4073
|
],
|
|
3647
4074
|
"exports": [
|
|
@@ -3669,8 +4096,60 @@
|
|
|
3669
4096
|
"declarations": [
|
|
3670
4097
|
{
|
|
3671
4098
|
"kind": "class",
|
|
3672
|
-
"description": "The ModuleElement interface provides properties and methods for manipulating\n[`<pc-module>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-module/)
|
|
4099
|
+
"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",
|
|
3673
4100
|
"name": "ModuleElement",
|
|
4101
|
+
"members": [
|
|
4102
|
+
{
|
|
4103
|
+
"kind": "field",
|
|
4104
|
+
"name": "closestApp",
|
|
4105
|
+
"type": {
|
|
4106
|
+
"text": "AppElement | null"
|
|
4107
|
+
},
|
|
4108
|
+
"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.",
|
|
4109
|
+
"return": {
|
|
4110
|
+
"type": {
|
|
4111
|
+
"text": ""
|
|
4112
|
+
}
|
|
4113
|
+
},
|
|
4114
|
+
"readonly": true,
|
|
4115
|
+
"inheritedFrom": {
|
|
4116
|
+
"name": "AsyncElement",
|
|
4117
|
+
"module": "src/async-element.ts"
|
|
4118
|
+
}
|
|
4119
|
+
},
|
|
4120
|
+
{
|
|
4121
|
+
"kind": "field",
|
|
4122
|
+
"name": "closestEntity",
|
|
4123
|
+
"type": {
|
|
4124
|
+
"text": "EntityBaseElement | null"
|
|
4125
|
+
},
|
|
4126
|
+
"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.",
|
|
4127
|
+
"return": {
|
|
4128
|
+
"type": {
|
|
4129
|
+
"text": ""
|
|
4130
|
+
}
|
|
4131
|
+
},
|
|
4132
|
+
"readonly": true,
|
|
4133
|
+
"inheritedFrom": {
|
|
4134
|
+
"name": "AsyncElement",
|
|
4135
|
+
"module": "src/async-element.ts"
|
|
4136
|
+
}
|
|
4137
|
+
},
|
|
4138
|
+
{
|
|
4139
|
+
"kind": "method",
|
|
4140
|
+
"name": "ready",
|
|
4141
|
+
"return": {
|
|
4142
|
+
"type": {
|
|
4143
|
+
"text": ""
|
|
4144
|
+
}
|
|
4145
|
+
},
|
|
4146
|
+
"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.",
|
|
4147
|
+
"inheritedFrom": {
|
|
4148
|
+
"name": "AsyncElement",
|
|
4149
|
+
"module": "src/async-element.ts"
|
|
4150
|
+
}
|
|
4151
|
+
}
|
|
4152
|
+
],
|
|
3674
4153
|
"attributes": [
|
|
3675
4154
|
{
|
|
3676
4155
|
"type": {
|
|
@@ -3702,25 +4181,24 @@
|
|
|
3702
4181
|
}
|
|
3703
4182
|
],
|
|
3704
4183
|
"superclass": {
|
|
3705
|
-
"name": "
|
|
4184
|
+
"name": "AsyncElement",
|
|
4185
|
+
"module": "/src/async-element"
|
|
3706
4186
|
},
|
|
3707
4187
|
"tagName": "pc-module",
|
|
3708
|
-
"customElement": true
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
|
|
3719
|
-
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
"name": "fallbackUrl",
|
|
3723
|
-
"default": "this.getAttribute('fallback')!"
|
|
4188
|
+
"customElement": true,
|
|
4189
|
+
"events": [
|
|
4190
|
+
{
|
|
4191
|
+
"name": "ready",
|
|
4192
|
+
"type": {
|
|
4193
|
+
"text": "CustomEvent"
|
|
4194
|
+
},
|
|
4195
|
+
"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.",
|
|
4196
|
+
"inheritedFrom": {
|
|
4197
|
+
"name": "AsyncElement",
|
|
4198
|
+
"module": "src/async-element.ts"
|
|
4199
|
+
}
|
|
4200
|
+
}
|
|
4201
|
+
]
|
|
3724
4202
|
}
|
|
3725
4203
|
],
|
|
3726
4204
|
"exports": [
|
|
@@ -3742,6 +4220,476 @@
|
|
|
3742
4220
|
}
|
|
3743
4221
|
]
|
|
3744
4222
|
},
|
|
4223
|
+
{
|
|
4224
|
+
"kind": "javascript-module",
|
|
4225
|
+
"path": "src/node.ts",
|
|
4226
|
+
"declarations": [
|
|
4227
|
+
{
|
|
4228
|
+
"kind": "class",
|
|
4229
|
+
"description": "The NodeElement interface provides properties and methods for manipulating\n[`<pc-node>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-node/)\nelements. The NodeElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA `pc-node` is an override element: where `pc-entity` creates an entity, `pc-node` binds to a\nnode a `pc-model` loaded and declares overrides against the authored asset — components to\nadd, properties to change, content to attach. Attributes present apply as overrides; attributes\nabsent leave authored values untouched, and removing an attribute (or assigning `null` to the\nmatching property) restores the authored value.\n\n`name` selects among the host model's nodes (first match in depth-first order), nesting a\n`pc-node` inside another scopes the search to that subtree, and `index` picks among identically\nnamed matches. When `name` matches more than one node and no `index` is given, the element\nwarns and binds nothing.\n\nThe element becomes ready once bound, and never while unresolved — a missing or ambiguous\nname warns and records the failure in `state`, readiness stays unresolved, and descendants\nwait with it.\n\nThe pointer events below are dispatched by the containing `<pc-app>` element when the pointer\nintersects the bound node's geometry, exactly as for `<pc-entity>`.\n",
|
|
4230
|
+
"name": "NodeElement",
|
|
4231
|
+
"members": [
|
|
4232
|
+
{
|
|
4233
|
+
"kind": "method",
|
|
4234
|
+
"name": "addEventListener",
|
|
4235
|
+
"parameters": [
|
|
4236
|
+
{
|
|
4237
|
+
"name": "type",
|
|
4238
|
+
"type": {
|
|
4239
|
+
"text": "string"
|
|
4240
|
+
}
|
|
4241
|
+
},
|
|
4242
|
+
{
|
|
4243
|
+
"name": "listener",
|
|
4244
|
+
"type": {
|
|
4245
|
+
"text": "EventListener"
|
|
4246
|
+
}
|
|
4247
|
+
},
|
|
4248
|
+
{
|
|
4249
|
+
"name": "options",
|
|
4250
|
+
"optional": true,
|
|
4251
|
+
"type": {
|
|
4252
|
+
"text": "boolean | AddEventListenerOptions"
|
|
4253
|
+
}
|
|
4254
|
+
}
|
|
4255
|
+
],
|
|
4256
|
+
"inheritedFrom": {
|
|
4257
|
+
"name": "EntityBaseElement",
|
|
4258
|
+
"module": "src/entity-base.ts"
|
|
4259
|
+
}
|
|
4260
|
+
},
|
|
4261
|
+
{
|
|
4262
|
+
"kind": "field",
|
|
4263
|
+
"name": "closestApp",
|
|
4264
|
+
"type": {
|
|
4265
|
+
"text": "AppElement | null"
|
|
4266
|
+
},
|
|
4267
|
+
"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.",
|
|
4268
|
+
"return": {
|
|
4269
|
+
"type": {
|
|
4270
|
+
"text": ""
|
|
4271
|
+
}
|
|
4272
|
+
},
|
|
4273
|
+
"readonly": true,
|
|
4274
|
+
"inheritedFrom": {
|
|
4275
|
+
"name": "AsyncElement",
|
|
4276
|
+
"module": "src/async-element.ts"
|
|
4277
|
+
}
|
|
4278
|
+
},
|
|
4279
|
+
{
|
|
4280
|
+
"kind": "field",
|
|
4281
|
+
"name": "closestEntity",
|
|
4282
|
+
"type": {
|
|
4283
|
+
"text": "EntityBaseElement | null"
|
|
4284
|
+
},
|
|
4285
|
+
"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.",
|
|
4286
|
+
"return": {
|
|
4287
|
+
"type": {
|
|
4288
|
+
"text": ""
|
|
4289
|
+
}
|
|
4290
|
+
},
|
|
4291
|
+
"readonly": true,
|
|
4292
|
+
"inheritedFrom": {
|
|
4293
|
+
"name": "AsyncElement",
|
|
4294
|
+
"module": "src/async-element.ts"
|
|
4295
|
+
}
|
|
4296
|
+
},
|
|
4297
|
+
{
|
|
4298
|
+
"kind": "field",
|
|
4299
|
+
"name": "enabled",
|
|
4300
|
+
"description": "Gets the enabled override.",
|
|
4301
|
+
"parameters": [
|
|
4302
|
+
{
|
|
4303
|
+
"description": "The enabled state, or `null`.",
|
|
4304
|
+
"name": "value"
|
|
4305
|
+
}
|
|
4306
|
+
],
|
|
4307
|
+
"type": {
|
|
4308
|
+
"text": "boolean | null"
|
|
4309
|
+
},
|
|
4310
|
+
"return": {
|
|
4311
|
+
"type": {
|
|
4312
|
+
"text": ""
|
|
4313
|
+
}
|
|
4314
|
+
}
|
|
4315
|
+
},
|
|
4316
|
+
{
|
|
4317
|
+
"kind": "field",
|
|
4318
|
+
"name": "entity",
|
|
4319
|
+
"type": {
|
|
4320
|
+
"text": "Entity | null"
|
|
4321
|
+
},
|
|
4322
|
+
"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.",
|
|
4323
|
+
"return": {
|
|
4324
|
+
"type": {
|
|
4325
|
+
"text": ""
|
|
4326
|
+
}
|
|
4327
|
+
},
|
|
4328
|
+
"readonly": true,
|
|
4329
|
+
"inheritedFrom": {
|
|
4330
|
+
"name": "EntityBaseElement",
|
|
4331
|
+
"module": "src/entity-base.ts"
|
|
4332
|
+
}
|
|
4333
|
+
},
|
|
4334
|
+
{
|
|
4335
|
+
"kind": "field",
|
|
4336
|
+
"name": "index",
|
|
4337
|
+
"description": "Gets which match to bind.",
|
|
4338
|
+
"parameters": [
|
|
4339
|
+
{
|
|
4340
|
+
"description": "The match index, or `null`.",
|
|
4341
|
+
"name": "value"
|
|
4342
|
+
}
|
|
4343
|
+
],
|
|
4344
|
+
"type": {
|
|
4345
|
+
"text": "number | null"
|
|
4346
|
+
},
|
|
4347
|
+
"return": {
|
|
4348
|
+
"type": {
|
|
4349
|
+
"text": ""
|
|
4350
|
+
}
|
|
4351
|
+
}
|
|
4352
|
+
},
|
|
4353
|
+
{
|
|
4354
|
+
"kind": "field",
|
|
4355
|
+
"name": "name",
|
|
4356
|
+
"description": "Gets the name of the node to bind.",
|
|
4357
|
+
"parameters": [
|
|
4358
|
+
{
|
|
4359
|
+
"description": "The node name.",
|
|
4360
|
+
"name": "value"
|
|
4361
|
+
}
|
|
4362
|
+
],
|
|
4363
|
+
"type": {
|
|
4364
|
+
"text": "string"
|
|
4365
|
+
},
|
|
4366
|
+
"return": {
|
|
4367
|
+
"type": {
|
|
4368
|
+
"text": ""
|
|
4369
|
+
}
|
|
4370
|
+
}
|
|
4371
|
+
},
|
|
4372
|
+
{
|
|
4373
|
+
"kind": "field",
|
|
4374
|
+
"name": "path",
|
|
4375
|
+
"type": {
|
|
4376
|
+
"text": "string | null"
|
|
4377
|
+
},
|
|
4378
|
+
"description": "The path of the bound node below the search root, `/`-separated, or `null` while not\nbound.",
|
|
4379
|
+
"return": {
|
|
4380
|
+
"type": {
|
|
4381
|
+
"text": ""
|
|
4382
|
+
}
|
|
4383
|
+
},
|
|
4384
|
+
"readonly": true
|
|
4385
|
+
},
|
|
4386
|
+
{
|
|
4387
|
+
"kind": "field",
|
|
4388
|
+
"name": "position",
|
|
4389
|
+
"description": "Gets the local position override.",
|
|
4390
|
+
"parameters": [
|
|
4391
|
+
{
|
|
4392
|
+
"description": "The position, or `null`.",
|
|
4393
|
+
"name": "value"
|
|
4394
|
+
}
|
|
4395
|
+
],
|
|
4396
|
+
"type": {
|
|
4397
|
+
"text": "Vec3 | null"
|
|
4398
|
+
},
|
|
4399
|
+
"return": {
|
|
4400
|
+
"type": {
|
|
4401
|
+
"text": ""
|
|
4402
|
+
}
|
|
4403
|
+
}
|
|
4404
|
+
},
|
|
4405
|
+
{
|
|
4406
|
+
"kind": "method",
|
|
4407
|
+
"name": "ready",
|
|
4408
|
+
"return": {
|
|
4409
|
+
"type": {
|
|
4410
|
+
"text": ""
|
|
4411
|
+
}
|
|
4412
|
+
},
|
|
4413
|
+
"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.",
|
|
4414
|
+
"inheritedFrom": {
|
|
4415
|
+
"name": "AsyncElement",
|
|
4416
|
+
"module": "src/async-element.ts"
|
|
4417
|
+
}
|
|
4418
|
+
},
|
|
4419
|
+
{
|
|
4420
|
+
"kind": "method",
|
|
4421
|
+
"name": "removeEventListener",
|
|
4422
|
+
"parameters": [
|
|
4423
|
+
{
|
|
4424
|
+
"name": "type",
|
|
4425
|
+
"type": {
|
|
4426
|
+
"text": "string"
|
|
4427
|
+
}
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
"name": "listener",
|
|
4431
|
+
"type": {
|
|
4432
|
+
"text": "EventListener"
|
|
4433
|
+
}
|
|
4434
|
+
},
|
|
4435
|
+
{
|
|
4436
|
+
"name": "options",
|
|
4437
|
+
"optional": true,
|
|
4438
|
+
"type": {
|
|
4439
|
+
"text": "boolean | EventListenerOptions"
|
|
4440
|
+
}
|
|
4441
|
+
}
|
|
4442
|
+
],
|
|
4443
|
+
"inheritedFrom": {
|
|
4444
|
+
"name": "EntityBaseElement",
|
|
4445
|
+
"module": "src/entity-base.ts"
|
|
4446
|
+
}
|
|
4447
|
+
},
|
|
4448
|
+
{
|
|
4449
|
+
"kind": "field",
|
|
4450
|
+
"name": "rotation",
|
|
4451
|
+
"description": "Gets the local rotation override.",
|
|
4452
|
+
"parameters": [
|
|
4453
|
+
{
|
|
4454
|
+
"description": "The rotation, or `null`.",
|
|
4455
|
+
"name": "value"
|
|
4456
|
+
}
|
|
4457
|
+
],
|
|
4458
|
+
"type": {
|
|
4459
|
+
"text": "Vec3 | null"
|
|
4460
|
+
},
|
|
4461
|
+
"return": {
|
|
4462
|
+
"type": {
|
|
4463
|
+
"text": ""
|
|
4464
|
+
}
|
|
4465
|
+
}
|
|
4466
|
+
},
|
|
4467
|
+
{
|
|
4468
|
+
"kind": "field",
|
|
4469
|
+
"name": "scale",
|
|
4470
|
+
"description": "Gets the local scale override.",
|
|
4471
|
+
"parameters": [
|
|
4472
|
+
{
|
|
4473
|
+
"description": "The scale, or `null`.",
|
|
4474
|
+
"name": "value"
|
|
4475
|
+
}
|
|
4476
|
+
],
|
|
4477
|
+
"type": {
|
|
4478
|
+
"text": "Vec3 | null"
|
|
4479
|
+
},
|
|
4480
|
+
"return": {
|
|
4481
|
+
"type": {
|
|
4482
|
+
"text": ""
|
|
4483
|
+
}
|
|
4484
|
+
}
|
|
4485
|
+
},
|
|
4486
|
+
{
|
|
4487
|
+
"kind": "field",
|
|
4488
|
+
"name": "state",
|
|
4489
|
+
"type": {
|
|
4490
|
+
"text": "NodeBindingState"
|
|
4491
|
+
},
|
|
4492
|
+
"description": "The binding state: `pending` until the host instantiates and `name` resolves, `bound`\nonce decorated, `missing`/`ambiguous`/`duplicate` when resolution failed (each also\nwarns). Useful for asserting a document's bindings programmatically.",
|
|
4493
|
+
"return": {
|
|
4494
|
+
"type": {
|
|
4495
|
+
"text": ""
|
|
4496
|
+
}
|
|
4497
|
+
},
|
|
4498
|
+
"readonly": true
|
|
4499
|
+
},
|
|
4500
|
+
{
|
|
4501
|
+
"kind": "field",
|
|
4502
|
+
"name": "tags",
|
|
4503
|
+
"description": "Gets the tags override.",
|
|
4504
|
+
"parameters": [
|
|
4505
|
+
{
|
|
4506
|
+
"description": "The tags, or `null`.",
|
|
4507
|
+
"name": "value"
|
|
4508
|
+
}
|
|
4509
|
+
],
|
|
4510
|
+
"type": {
|
|
4511
|
+
"text": "string[] | null"
|
|
4512
|
+
},
|
|
4513
|
+
"return": {
|
|
4514
|
+
"type": {
|
|
4515
|
+
"text": ""
|
|
4516
|
+
}
|
|
4517
|
+
}
|
|
4518
|
+
}
|
|
4519
|
+
],
|
|
4520
|
+
"events": [
|
|
4521
|
+
{
|
|
4522
|
+
"type": {
|
|
4523
|
+
"text": "PointerEvent"
|
|
4524
|
+
},
|
|
4525
|
+
"description": "Fired when a pointer button is pressed over the node.",
|
|
4526
|
+
"name": "pointerdown"
|
|
4527
|
+
},
|
|
4528
|
+
{
|
|
4529
|
+
"type": {
|
|
4530
|
+
"text": "PointerEvent"
|
|
4531
|
+
},
|
|
4532
|
+
"description": "Fired when the pointer moves onto the node.",
|
|
4533
|
+
"name": "pointerenter"
|
|
4534
|
+
},
|
|
4535
|
+
{
|
|
4536
|
+
"type": {
|
|
4537
|
+
"text": "PointerEvent"
|
|
4538
|
+
},
|
|
4539
|
+
"description": "Fired when the pointer moves off the node.",
|
|
4540
|
+
"name": "pointerleave"
|
|
4541
|
+
},
|
|
4542
|
+
{
|
|
4543
|
+
"type": {
|
|
4544
|
+
"text": "PointerEvent"
|
|
4545
|
+
},
|
|
4546
|
+
"description": "Fired when the pointer moves over the node.",
|
|
4547
|
+
"name": "pointermove"
|
|
4548
|
+
},
|
|
4549
|
+
{
|
|
4550
|
+
"type": {
|
|
4551
|
+
"text": "PointerEvent"
|
|
4552
|
+
},
|
|
4553
|
+
"description": "Fired when a pointer button is released over the node.",
|
|
4554
|
+
"name": "pointerup"
|
|
4555
|
+
},
|
|
4556
|
+
{
|
|
4557
|
+
"name": "ready",
|
|
4558
|
+
"type": {
|
|
4559
|
+
"text": "CustomEvent"
|
|
4560
|
+
},
|
|
4561
|
+
"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.",
|
|
4562
|
+
"inheritedFrom": {
|
|
4563
|
+
"name": "AsyncElement",
|
|
4564
|
+
"module": "src/async-element.ts"
|
|
4565
|
+
}
|
|
4566
|
+
}
|
|
4567
|
+
],
|
|
4568
|
+
"attributes": [
|
|
4569
|
+
{
|
|
4570
|
+
"name": "enabled",
|
|
4571
|
+
"type": {
|
|
4572
|
+
"text": "string"
|
|
4573
|
+
},
|
|
4574
|
+
"description": "Overrides the node's enabled state.",
|
|
4575
|
+
"fieldName": "enabled"
|
|
4576
|
+
},
|
|
4577
|
+
{
|
|
4578
|
+
"name": "index",
|
|
4579
|
+
"type": {
|
|
4580
|
+
"text": "string"
|
|
4581
|
+
},
|
|
4582
|
+
"description": "Which match to bind when `name` matches more than one node, 0-based in depth-first order. Optional for a unique match; required for an ambiguous one.",
|
|
4583
|
+
"fieldName": "index"
|
|
4584
|
+
},
|
|
4585
|
+
{
|
|
4586
|
+
"name": "name",
|
|
4587
|
+
"type": {
|
|
4588
|
+
"text": "string"
|
|
4589
|
+
},
|
|
4590
|
+
"description": "The name of the node to bind, resolved within the nearest ancestor `pc-model` (or `pc-node`) once it has instantiated.",
|
|
4591
|
+
"fieldName": "name"
|
|
4592
|
+
},
|
|
4593
|
+
{
|
|
4594
|
+
"type": {
|
|
4595
|
+
"text": "string"
|
|
4596
|
+
},
|
|
4597
|
+
"description": "Script to run when a pointer button is pressed over the node.",
|
|
4598
|
+
"name": "onpointerdown",
|
|
4599
|
+
"fieldName": "onpointerdown"
|
|
4600
|
+
},
|
|
4601
|
+
{
|
|
4602
|
+
"type": {
|
|
4603
|
+
"text": "string"
|
|
4604
|
+
},
|
|
4605
|
+
"description": "Script to run when the pointer moves onto the node.",
|
|
4606
|
+
"name": "onpointerenter",
|
|
4607
|
+
"fieldName": "onpointerenter"
|
|
4608
|
+
},
|
|
4609
|
+
{
|
|
4610
|
+
"type": {
|
|
4611
|
+
"text": "string"
|
|
4612
|
+
},
|
|
4613
|
+
"description": "Script to run when the pointer moves off the node.",
|
|
4614
|
+
"name": "onpointerleave",
|
|
4615
|
+
"fieldName": "onpointerleave"
|
|
4616
|
+
},
|
|
4617
|
+
{
|
|
4618
|
+
"type": {
|
|
4619
|
+
"text": "string"
|
|
4620
|
+
},
|
|
4621
|
+
"description": "Script to run when the pointer moves over the node.",
|
|
4622
|
+
"name": "onpointermove",
|
|
4623
|
+
"fieldName": "onpointermove"
|
|
4624
|
+
},
|
|
4625
|
+
{
|
|
4626
|
+
"type": {
|
|
4627
|
+
"text": "string"
|
|
4628
|
+
},
|
|
4629
|
+
"description": "Script to run when a pointer button is released over the node.",
|
|
4630
|
+
"name": "onpointerup",
|
|
4631
|
+
"fieldName": "onpointerup"
|
|
4632
|
+
},
|
|
4633
|
+
{
|
|
4634
|
+
"name": "position",
|
|
4635
|
+
"type": {
|
|
4636
|
+
"text": "string"
|
|
4637
|
+
},
|
|
4638
|
+
"description": "Overrides the node's local position, as an \"x y z\" triple.",
|
|
4639
|
+
"fieldName": "position"
|
|
4640
|
+
},
|
|
4641
|
+
{
|
|
4642
|
+
"name": "rotation",
|
|
4643
|
+
"type": {
|
|
4644
|
+
"text": "string"
|
|
4645
|
+
},
|
|
4646
|
+
"description": "Overrides the node's local rotation (Euler angles), as an \"x y z\" triple.",
|
|
4647
|
+
"fieldName": "rotation"
|
|
4648
|
+
},
|
|
4649
|
+
{
|
|
4650
|
+
"name": "scale",
|
|
4651
|
+
"type": {
|
|
4652
|
+
"text": "string"
|
|
4653
|
+
},
|
|
4654
|
+
"description": "Overrides the node's local scale, as an \"x y z\" triple.",
|
|
4655
|
+
"fieldName": "scale"
|
|
4656
|
+
},
|
|
4657
|
+
{
|
|
4658
|
+
"name": "tags",
|
|
4659
|
+
"type": {
|
|
4660
|
+
"text": "string"
|
|
4661
|
+
},
|
|
4662
|
+
"description": "Overrides the node's tags, separated by spaces or commas.",
|
|
4663
|
+
"fieldName": "tags"
|
|
4664
|
+
}
|
|
4665
|
+
],
|
|
4666
|
+
"superclass": {
|
|
4667
|
+
"name": "EntityBaseElement",
|
|
4668
|
+
"module": "/src/entity-base"
|
|
4669
|
+
},
|
|
4670
|
+
"tagName": "pc-node",
|
|
4671
|
+
"customElement": true
|
|
4672
|
+
}
|
|
4673
|
+
],
|
|
4674
|
+
"exports": [
|
|
4675
|
+
{
|
|
4676
|
+
"kind": "custom-element-definition",
|
|
4677
|
+
"name": "pc-node",
|
|
4678
|
+
"declaration": {
|
|
4679
|
+
"name": "NodeElement",
|
|
4680
|
+
"module": "src/node.ts"
|
|
4681
|
+
}
|
|
4682
|
+
},
|
|
4683
|
+
{
|
|
4684
|
+
"kind": "js",
|
|
4685
|
+
"name": "NodeElement",
|
|
4686
|
+
"declaration": {
|
|
4687
|
+
"name": "NodeElement",
|
|
4688
|
+
"module": "src/node.ts"
|
|
4689
|
+
}
|
|
4690
|
+
}
|
|
4691
|
+
]
|
|
4692
|
+
},
|
|
3745
4693
|
{
|
|
3746
4694
|
"kind": "javascript-module",
|
|
3747
4695
|
"path": "src/scene.ts",
|
|
@@ -3773,9 +4721,9 @@
|
|
|
3773
4721
|
"kind": "field",
|
|
3774
4722
|
"name": "closestEntity",
|
|
3775
4723
|
"type": {
|
|
3776
|
-
"text": "
|
|
4724
|
+
"text": "EntityBaseElement | null"
|
|
3777
4725
|
},
|
|
3778
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
4726
|
+
"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.",
|
|
3779
4727
|
"return": {
|
|
3780
4728
|
"type": {
|
|
3781
4729
|
"text": ""
|
|
@@ -4071,9 +5019,9 @@
|
|
|
4071
5019
|
"kind": "field",
|
|
4072
5020
|
"name": "closestEntity",
|
|
4073
5021
|
"type": {
|
|
4074
|
-
"text": "
|
|
5022
|
+
"text": "EntityBaseElement | null"
|
|
4075
5023
|
},
|
|
4076
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
5024
|
+
"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.",
|
|
4077
5025
|
"return": {
|
|
4078
5026
|
"type": {
|
|
4079
5027
|
"text": ""
|
|
@@ -4356,9 +5304,9 @@
|
|
|
4356
5304
|
"kind": "field",
|
|
4357
5305
|
"name": "closestEntity",
|
|
4358
5306
|
"type": {
|
|
4359
|
-
"text": "
|
|
5307
|
+
"text": "EntityBaseElement | null"
|
|
4360
5308
|
},
|
|
4361
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
5309
|
+
"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.",
|
|
4362
5310
|
"return": {
|
|
4363
5311
|
"type": {
|
|
4364
5312
|
"text": ""
|
|
@@ -4915,9 +5863,9 @@
|
|
|
4915
5863
|
"kind": "field",
|
|
4916
5864
|
"name": "closestEntity",
|
|
4917
5865
|
"type": {
|
|
4918
|
-
"text": "
|
|
5866
|
+
"text": "EntityBaseElement | null"
|
|
4919
5867
|
},
|
|
4920
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
5868
|
+
"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.",
|
|
4921
5869
|
"return": {
|
|
4922
5870
|
"type": {
|
|
4923
5871
|
"text": ""
|
|
@@ -5496,7 +6444,7 @@
|
|
|
5496
6444
|
"declarations": [
|
|
5497
6445
|
{
|
|
5498
6446
|
"kind": "class",
|
|
5499
|
-
"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",
|
|
6447
|
+
"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",
|
|
5500
6448
|
"name": "CollisionComponentElement",
|
|
5501
6449
|
"members": [
|
|
5502
6450
|
{
|
|
@@ -5529,9 +6477,9 @@
|
|
|
5529
6477
|
"kind": "field",
|
|
5530
6478
|
"name": "closestEntity",
|
|
5531
6479
|
"type": {
|
|
5532
|
-
"text": "
|
|
6480
|
+
"text": "EntityBaseElement | null"
|
|
5533
6481
|
},
|
|
5534
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
6482
|
+
"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.",
|
|
5535
6483
|
"return": {
|
|
5536
6484
|
"type": {
|
|
5537
6485
|
"text": ""
|
|
@@ -5773,9 +6721,9 @@
|
|
|
5773
6721
|
"kind": "field",
|
|
5774
6722
|
"name": "closestEntity",
|
|
5775
6723
|
"type": {
|
|
5776
|
-
"text": "
|
|
6724
|
+
"text": "EntityBaseElement | null"
|
|
5777
6725
|
},
|
|
5778
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
6726
|
+
"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.",
|
|
5779
6727
|
"return": {
|
|
5780
6728
|
"type": {
|
|
5781
6729
|
"text": ""
|
|
@@ -5984,9 +6932,9 @@
|
|
|
5984
6932
|
"kind": "field",
|
|
5985
6933
|
"name": "closestEntity",
|
|
5986
6934
|
"type": {
|
|
5987
|
-
"text": "
|
|
6935
|
+
"text": "EntityBaseElement | null"
|
|
5988
6936
|
},
|
|
5989
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
6937
|
+
"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.",
|
|
5990
6938
|
"return": {
|
|
5991
6939
|
"type": {
|
|
5992
6940
|
"text": ""
|
|
@@ -6736,9 +7684,9 @@
|
|
|
6736
7684
|
"kind": "field",
|
|
6737
7685
|
"name": "closestEntity",
|
|
6738
7686
|
"type": {
|
|
6739
|
-
"text": "
|
|
7687
|
+
"text": "EntityBaseElement | null"
|
|
6740
7688
|
},
|
|
6741
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
7689
|
+
"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.",
|
|
6742
7690
|
"return": {
|
|
6743
7691
|
"type": {
|
|
6744
7692
|
"text": ""
|
|
@@ -7006,9 +7954,9 @@
|
|
|
7006
7954
|
"kind": "field",
|
|
7007
7955
|
"name": "closestEntity",
|
|
7008
7956
|
"type": {
|
|
7009
|
-
"text": "
|
|
7957
|
+
"text": "EntityBaseElement | null"
|
|
7010
7958
|
},
|
|
7011
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
7959
|
+
"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.",
|
|
7012
7960
|
"return": {
|
|
7013
7961
|
"type": {
|
|
7014
7962
|
"text": ""
|
|
@@ -7348,9 +8296,9 @@
|
|
|
7348
8296
|
"kind": "field",
|
|
7349
8297
|
"name": "closestEntity",
|
|
7350
8298
|
"type": {
|
|
7351
|
-
"text": "
|
|
8299
|
+
"text": "EntityBaseElement | null"
|
|
7352
8300
|
},
|
|
7353
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
8301
|
+
"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.",
|
|
7354
8302
|
"return": {
|
|
7355
8303
|
"type": {
|
|
7356
8304
|
"text": ""
|
|
@@ -7726,9 +8674,9 @@
|
|
|
7726
8674
|
"kind": "field",
|
|
7727
8675
|
"name": "closestEntity",
|
|
7728
8676
|
"type": {
|
|
7729
|
-
"text": "
|
|
8677
|
+
"text": "EntityBaseElement | null"
|
|
7730
8678
|
},
|
|
7731
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
8679
|
+
"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.",
|
|
7732
8680
|
"return": {
|
|
7733
8681
|
"type": {
|
|
7734
8682
|
"text": ""
|
|
@@ -8338,9 +9286,9 @@
|
|
|
8338
9286
|
"kind": "field",
|
|
8339
9287
|
"name": "closestEntity",
|
|
8340
9288
|
"type": {
|
|
8341
|
-
"text": "
|
|
9289
|
+
"text": "EntityBaseElement | null"
|
|
8342
9290
|
},
|
|
8343
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
9291
|
+
"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.",
|
|
8344
9292
|
"return": {
|
|
8345
9293
|
"type": {
|
|
8346
9294
|
"text": ""
|
|
@@ -8510,9 +9458,9 @@
|
|
|
8510
9458
|
"kind": "field",
|
|
8511
9459
|
"name": "closestEntity",
|
|
8512
9460
|
"type": {
|
|
8513
|
-
"text": "
|
|
9461
|
+
"text": "EntityBaseElement | null"
|
|
8514
9462
|
},
|
|
8515
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
9463
|
+
"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.",
|
|
8516
9464
|
"return": {
|
|
8517
9465
|
"type": {
|
|
8518
9466
|
"text": ""
|
|
@@ -8710,9 +9658,9 @@
|
|
|
8710
9658
|
"kind": "field",
|
|
8711
9659
|
"name": "closestEntity",
|
|
8712
9660
|
"type": {
|
|
8713
|
-
"text": "
|
|
9661
|
+
"text": "EntityBaseElement | null"
|
|
8714
9662
|
},
|
|
8715
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
9663
|
+
"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.",
|
|
8716
9664
|
"return": {
|
|
8717
9665
|
"type": {
|
|
8718
9666
|
"text": ""
|
|
@@ -8960,9 +9908,9 @@
|
|
|
8960
9908
|
"kind": "field",
|
|
8961
9909
|
"name": "closestEntity",
|
|
8962
9910
|
"type": {
|
|
8963
|
-
"text": "
|
|
9911
|
+
"text": "EntityBaseElement | null"
|
|
8964
9912
|
},
|
|
8965
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
9913
|
+
"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.",
|
|
8966
9914
|
"return": {
|
|
8967
9915
|
"type": {
|
|
8968
9916
|
"text": ""
|
|
@@ -9215,9 +10163,9 @@
|
|
|
9215
10163
|
"kind": "field",
|
|
9216
10164
|
"name": "closestEntity",
|
|
9217
10165
|
"type": {
|
|
9218
|
-
"text": "
|
|
10166
|
+
"text": "EntityBaseElement | null"
|
|
9219
10167
|
},
|
|
9220
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
10168
|
+
"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.",
|
|
9221
10169
|
"return": {
|
|
9222
10170
|
"type": {
|
|
9223
10171
|
"text": ""
|
|
@@ -9468,9 +10416,9 @@
|
|
|
9468
10416
|
"kind": "field",
|
|
9469
10417
|
"name": "closestEntity",
|
|
9470
10418
|
"type": {
|
|
9471
|
-
"text": "
|
|
10419
|
+
"text": "EntityBaseElement | null"
|
|
9472
10420
|
},
|
|
9473
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
10421
|
+
"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.",
|
|
9474
10422
|
"return": {
|
|
9475
10423
|
"type": {
|
|
9476
10424
|
"text": ""
|
|
@@ -9621,9 +10569,9 @@
|
|
|
9621
10569
|
"kind": "field",
|
|
9622
10570
|
"name": "closestEntity",
|
|
9623
10571
|
"type": {
|
|
9624
|
-
"text": "
|
|
10572
|
+
"text": "EntityBaseElement | null"
|
|
9625
10573
|
},
|
|
9626
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
10574
|
+
"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.",
|
|
9627
10575
|
"return": {
|
|
9628
10576
|
"type": {
|
|
9629
10577
|
"text": ""
|
|
@@ -9834,9 +10782,9 @@
|
|
|
9834
10782
|
"kind": "field",
|
|
9835
10783
|
"name": "closestEntity",
|
|
9836
10784
|
"type": {
|
|
9837
|
-
"text": "
|
|
10785
|
+
"text": "EntityBaseElement | null"
|
|
9838
10786
|
},
|
|
9839
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
10787
|
+
"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.",
|
|
9840
10788
|
"return": {
|
|
9841
10789
|
"type": {
|
|
9842
10790
|
"text": ""
|
|
@@ -10102,9 +11050,9 @@
|
|
|
10102
11050
|
"kind": "field",
|
|
10103
11051
|
"name": "closestEntity",
|
|
10104
11052
|
"type": {
|
|
10105
|
-
"text": "
|
|
11053
|
+
"text": "EntityBaseElement | null"
|
|
10106
11054
|
},
|
|
10107
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
11055
|
+
"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.",
|
|
10108
11056
|
"return": {
|
|
10109
11057
|
"type": {
|
|
10110
11058
|
"text": ""
|
|
@@ -10560,9 +11508,9 @@
|
|
|
10560
11508
|
"kind": "field",
|
|
10561
11509
|
"name": "closestEntity",
|
|
10562
11510
|
"type": {
|
|
10563
|
-
"text": "
|
|
11511
|
+
"text": "EntityBaseElement | null"
|
|
10564
11512
|
},
|
|
10565
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
11513
|
+
"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.",
|
|
10566
11514
|
"return": {
|
|
10567
11515
|
"type": {
|
|
10568
11516
|
"text": ""
|
|
@@ -10923,9 +11871,9 @@
|
|
|
10923
11871
|
"kind": "field",
|
|
10924
11872
|
"name": "closestEntity",
|
|
10925
11873
|
"type": {
|
|
10926
|
-
"text": "
|
|
11874
|
+
"text": "EntityBaseElement | null"
|
|
10927
11875
|
},
|
|
10928
|
-
"description": "The nearest ancestor `<pc-entity>`
|
|
11876
|
+
"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.",
|
|
10929
11877
|
"return": {
|
|
10930
11878
|
"type": {
|
|
10931
11879
|
"text": ""
|