@playcanvas/web-components 0.10.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app.d.ts +151 -35
- package/dist/asset.d.ts +9 -0
- package/dist/async-element.d.ts +12 -2
- package/dist/components/camera-component.d.ts +13 -13
- package/dist/components/component.d.ts +5 -4
- package/dist/components/screen-component.d.ts +25 -4
- package/dist/components/scrollview-component.d.ts +6 -4
- package/dist/custom-elements.json +812 -196
- package/dist/entity.d.ts +18 -4
- package/dist/loading-bar.d.ts +35 -0
- package/dist/material.d.ts +8 -2
- package/dist/parse.d.ts +4 -2
- package/dist/pwc.cjs +661 -229
- package/dist/pwc.cjs.map +1 -1
- package/dist/pwc.js +661 -229
- 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 +662 -230
- package/dist/pwc.mjs.map +1 -1
- package/dist/scene.d.ts +11 -3
- package/dist/sky.d.ts +12 -11
- package/dist/vscode.html-custom-data.json +47 -22
- package/dist/web-types.json +384 -121
- package/package.json +1 -1
- package/src/app.ts +333 -124
- package/src/asset.ts +25 -0
- package/src/async-element.ts +14 -4
- package/src/components/camera-component.ts +31 -26
- package/src/components/component.ts +6 -5
- package/src/components/screen-component.ts +42 -12
- package/src/components/scrollview-component.ts +6 -4
- package/src/entity.ts +61 -27
- package/src/loading-bar.ts +122 -0
- package/src/material.ts +10 -4
- package/src/parse.ts +5 -3
- package/src/scene.ts +49 -19
- package/src/sky.ts +26 -25
package/dist/web-types.json
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@playcanvas/web-components",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.11.0",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "pc-app",
|
|
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\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
|
|
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\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n - **elementFromEntity(entity: _Entity_): __** - Returns the `<pc-entity>` element whose backing entity is `entity`, or `null` if the\nentity was not created by an element of this application - for example, a node inside a\nmodel's instantiated hierarchy, or an entity created through the engine API.\n\n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
|
|
12
12
|
"doc-url": "",
|
|
13
13
|
"attributes": [
|
|
14
14
|
{
|
|
15
15
|
"name": "alpha",
|
|
16
|
-
"description": "
|
|
16
|
+
"description": "Whether the frame buffer has an alpha channel.",
|
|
17
17
|
"value": { "type": "boolean", "default": "true" }
|
|
18
18
|
},
|
|
19
19
|
{
|
|
20
20
|
"name": "antialias",
|
|
21
|
-
"description": "
|
|
21
|
+
"description": "Whether the frame buffer is anti-aliased.",
|
|
22
22
|
"value": { "type": "boolean", "default": "true" }
|
|
23
23
|
},
|
|
24
24
|
{
|
|
@@ -30,22 +30,32 @@
|
|
|
30
30
|
}
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
|
-
"name": "depth",
|
|
34
|
-
"description": "
|
|
33
|
+
"name": "depth-buffer",
|
|
34
|
+
"description": "Whether the frame buffer has a depth buffer.",
|
|
35
35
|
"value": { "type": "boolean", "default": "true" }
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
|
-
"name": "
|
|
39
|
-
"description": "
|
|
38
|
+
"name": "loading-bar",
|
|
39
|
+
"description": "Whether the application shows its built-in loading bar while it boots and preloads its assets.",
|
|
40
40
|
"value": { "type": "boolean", "default": "true" }
|
|
41
41
|
},
|
|
42
42
|
{
|
|
43
|
-
"name": "
|
|
44
|
-
"description": "The
|
|
43
|
+
"name": "max-pixel-ratio",
|
|
44
|
+
"description": "The cap on the pixel ratio the application renders at.",
|
|
45
|
+
"value": { "type": "number", "default": "Infinity" }
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "stencil-buffer",
|
|
49
|
+
"description": "Whether the frame buffer has a stencil buffer.",
|
|
45
50
|
"value": { "type": "boolean", "default": "true" }
|
|
46
51
|
}
|
|
47
52
|
],
|
|
48
53
|
"events": [
|
|
54
|
+
{
|
|
55
|
+
"name": "progress",
|
|
56
|
+
"type": "ProgressEvent",
|
|
57
|
+
"description": "Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble."
|
|
58
|
+
},
|
|
49
59
|
{
|
|
50
60
|
"name": "ready",
|
|
51
61
|
"type": "CustomEvent",
|
|
@@ -56,28 +66,59 @@
|
|
|
56
66
|
"properties": [
|
|
57
67
|
{
|
|
58
68
|
"name": "app",
|
|
59
|
-
"description": "The PlayCanvas application instance.
|
|
60
|
-
"type": "AppBase"
|
|
69
|
+
"description": "The PlayCanvas application instance. `null` until the element is ready, and again once it\nhas been removed from the document — await whenReady or the element's `ready()`\npromise before accessing it.",
|
|
70
|
+
"type": "AppBase | null"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "loadProgress",
|
|
74
|
+
"description": "The asset preload progress of the application, as a fraction from 0 to 1. It is 0 until\npreloading begins (and again once the element has been removed from the document), and 1\nonce preloading has finished — including when there was nothing to preload. Read this to\ninitialize a loading UI; subsequent updates arrive via the `progress` event.",
|
|
75
|
+
"type": "number"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "alpha",
|
|
79
|
+
"description": "Gets whether the frame buffer has an alpha channel."
|
|
61
80
|
},
|
|
62
|
-
{ "name": "alpha", "description": "Gets the alpha flag." },
|
|
63
81
|
{
|
|
64
82
|
"name": "antialias",
|
|
65
|
-
"description": "Gets the
|
|
83
|
+
"description": "Gets whether the frame buffer is anti-aliased."
|
|
66
84
|
},
|
|
67
85
|
{
|
|
68
86
|
"name": "backend",
|
|
69
87
|
"description": "Gets the graphics backend."
|
|
70
88
|
},
|
|
71
|
-
{ "name": "depth", "description": "Gets the depth flag." },
|
|
72
89
|
{
|
|
73
|
-
"name": "
|
|
74
|
-
"description": "Gets the
|
|
90
|
+
"name": "depthBuffer",
|
|
91
|
+
"description": "Gets whether the frame buffer has a depth buffer."
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "loadingBar",
|
|
95
|
+
"description": "Gets whether the application shows its built-in loading bar while it boots and preloads\nits assets."
|
|
75
96
|
},
|
|
76
|
-
{
|
|
77
|
-
|
|
78
|
-
|
|
97
|
+
{
|
|
98
|
+
"name": "maxPixelRatio",
|
|
99
|
+
"description": "Gets the cap on the pixel ratio the application renders at."
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "stencilBuffer",
|
|
103
|
+
"description": "Gets whether the frame buffer has a stencil buffer."
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "closestApp",
|
|
107
|
+
"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.",
|
|
108
|
+
"type": "AppElement | null"
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "closestEntity",
|
|
112
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
113
|
+
"type": "EntityElement | null"
|
|
114
|
+
}
|
|
79
115
|
],
|
|
80
116
|
"events": [
|
|
117
|
+
{
|
|
118
|
+
"name": "progress",
|
|
119
|
+
"type": "ProgressEvent",
|
|
120
|
+
"description": "Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble."
|
|
121
|
+
},
|
|
81
122
|
{
|
|
82
123
|
"name": "ready",
|
|
83
124
|
"type": "CustomEvent",
|
|
@@ -88,7 +129,7 @@
|
|
|
88
129
|
},
|
|
89
130
|
{
|
|
90
131
|
"name": "pc-asset",
|
|
91
|
-
"description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nApart from `lazy`, these attributes are read once when the asset is created, so changing them\nlater has no effect.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
|
|
132
|
+
"description": "The AssetElement interface provides properties and methods for manipulating\n[`<pc-asset>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/) elements.\nThe AssetElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element becomes ready once the containing application has started and the asset is in the\nstate declared by the markup: loaded for preloaded assets (even if loading failed — check the\nasset's `resource`), or registered and awaiting a load for `lazy` assets. Elements inserted\nwhile the application is running are created and registered on insertion, and begin loading\nimmediately unless `lazy`. A `pc-asset` must be a direct child of `pc-app` — elements placed\nelsewhere, or with an unsupported asset type, never become ready.\n\nApart from `lazy`, these attributes are read once when the asset is created, so changing them\nlater has no effect.\n\n---\n\n\n### **Events:**\n - **error** - Fired when the asset fails to load, with the engine's error in `message`. Does not bubble. The element still becomes ready — readiness means the load settled, not that it succeeded.\n- **load** - Fired each time the asset finishes loading, including a `lazy` asset loaded later and any subsequent reloads. Does not bubble — listen on this element, or use a capture-phase listener on an ancestor to observe every asset.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
|
|
92
133
|
"doc-url": "",
|
|
93
134
|
"attributes": [
|
|
94
135
|
{
|
|
@@ -138,6 +179,16 @@
|
|
|
138
179
|
}
|
|
139
180
|
],
|
|
140
181
|
"events": [
|
|
182
|
+
{
|
|
183
|
+
"name": "error",
|
|
184
|
+
"type": "ErrorEvent",
|
|
185
|
+
"description": "Fired when the asset fails to load, with the engine's error in `message`. Does not bubble. The element still becomes ready — readiness means the load settled, not that it succeeded."
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"name": "load",
|
|
189
|
+
"type": "Event",
|
|
190
|
+
"description": "Fired each time the asset finishes loading, including a `lazy` asset loaded later and any subsequent reloads. Does not bubble — listen on this element, or use a capture-phase listener on an ancestor to observe every asset."
|
|
191
|
+
},
|
|
141
192
|
{
|
|
142
193
|
"name": "ready",
|
|
143
194
|
"type": "CustomEvent",
|
|
@@ -155,10 +206,28 @@
|
|
|
155
206
|
"name": "lazy",
|
|
156
207
|
"description": "Gets whether the asset should be loaded lazily."
|
|
157
208
|
},
|
|
158
|
-
{
|
|
159
|
-
|
|
209
|
+
{
|
|
210
|
+
"name": "closestApp",
|
|
211
|
+
"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.",
|
|
212
|
+
"type": "AppElement | null"
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "closestEntity",
|
|
216
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
217
|
+
"type": "EntityElement | null"
|
|
218
|
+
}
|
|
160
219
|
],
|
|
161
220
|
"events": [
|
|
221
|
+
{
|
|
222
|
+
"name": "error",
|
|
223
|
+
"type": "ErrorEvent",
|
|
224
|
+
"description": "Fired when the asset fails to load, with the engine's error in `message`. Does not bubble. The element still becomes ready — readiness means the load settled, not that it succeeded."
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "load",
|
|
228
|
+
"type": "Event",
|
|
229
|
+
"description": "Fired each time the asset finishes loading, including a `lazy` asset loaded later and any subsequent reloads. Does not bubble — listen on this element, or use a capture-phase listener on an ancestor to observe every asset."
|
|
230
|
+
},
|
|
162
231
|
{
|
|
163
232
|
"name": "ready",
|
|
164
233
|
"type": "CustomEvent",
|
|
@@ -264,8 +333,8 @@
|
|
|
264
333
|
"properties": [
|
|
265
334
|
{
|
|
266
335
|
"name": "entity",
|
|
267
|
-
"description": "The PlayCanvas entity instance.
|
|
268
|
-
"type": "Entity"
|
|
336
|
+
"description": "The PlayCanvas entity instance. `null` until the element is ready, and again once it has\nbeen removed from the document — await whenReady or the element's `ready()`\npromise before accessing it.",
|
|
337
|
+
"type": "Entity | null"
|
|
269
338
|
},
|
|
270
339
|
{
|
|
271
340
|
"name": "enabled",
|
|
@@ -285,8 +354,16 @@
|
|
|
285
354
|
"description": "Gets the scale of the entity."
|
|
286
355
|
},
|
|
287
356
|
{ "name": "tags", "description": "Gets the tags of the entity." },
|
|
288
|
-
{
|
|
289
|
-
|
|
357
|
+
{
|
|
358
|
+
"name": "closestApp",
|
|
359
|
+
"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.",
|
|
360
|
+
"type": "AppElement | null"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "closestEntity",
|
|
364
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
365
|
+
"type": "EntityElement | null"
|
|
366
|
+
}
|
|
290
367
|
],
|
|
291
368
|
"events": [
|
|
292
369
|
{
|
|
@@ -324,7 +401,7 @@
|
|
|
324
401
|
},
|
|
325
402
|
{
|
|
326
403
|
"name": "pc-material",
|
|
327
|
-
"description": "The MaterialElement interface provides properties and methods for manipulating\n[`<pc-material>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-material/) elements.\nThe MaterialElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA `pc-material` must be a direct child of `pc-app` — elements placed elsewhere log a warning\nand never create a material. Elements inserted while the application is already running are\ncreated on insertion.\n\nThe element is metal/rough by default: unlike a bare `StandardMaterial` it enables the metalness\nworkflow, which is what the `metalness-*` attributes assume and what glTF means by PBR.
|
|
404
|
+
"description": "The MaterialElement interface provides properties and methods for manipulating\n[`<pc-material>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-material/) elements.\nThe MaterialElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA `pc-material` must be a direct child of `pc-app` — elements placed elsewhere log a warning\nand never create a material. Elements inserted while the application is already running are\ncreated on insertion.\n\nThe element is metal/rough by default: unlike a bare `StandardMaterial` it enables the metalness\nworkflow, which is what the `metalness-*` attributes assume and what glTF means by PBR. It also\ndefaults `metalness` to 0 rather than the engine's 1, because those two defaults have to be\nchosen together - the engine's 1 is unreachable under its own `useMetalness` of false, and with\nthe workflow on it would make every material fully metallic, so `<pc-material diffuse=\"crimson\">`\nwould render as dark tinted reflections of an environment that may not exist rather than as a\ncrimson surface. `metalness=\"1\"` remains one attribute away.\n\nThe `roughness` and `roughness-map` attributes are aliases for `gloss` and `gloss-map` that\nadditionally invert the gloss channel; do not mix the two families on one element.\n\nThe two aliases are documented here rather than on an accessor, because they resolve to the\n`gloss` properties and would otherwise inherit gloss's description - which reads inverted.\n\n---\n\n\n### **Methods:**\n - **setMap(id: _string_, slot: _TextureSlot_)** - Points a texture slot at the resource of a `pc-asset`, waiting for the asset to load when it\nhas not already. An empty id clears the slot.",
|
|
328
405
|
"doc-url": "",
|
|
329
406
|
"attributes": [
|
|
330
407
|
{
|
|
@@ -577,7 +654,7 @@
|
|
|
577
654
|
{
|
|
578
655
|
"name": "metalness",
|
|
579
656
|
"description": "How metallic the surface is.",
|
|
580
|
-
"value": { "type": "number", "default": "
|
|
657
|
+
"value": { "type": "number", "default": "0" }
|
|
581
658
|
},
|
|
582
659
|
{
|
|
583
660
|
"name": "metalness-map",
|
|
@@ -1127,8 +1204,16 @@
|
|
|
1127
1204
|
"description": "Gets the id of the `pc-asset` to use for the model.",
|
|
1128
1205
|
"type": "string"
|
|
1129
1206
|
},
|
|
1130
|
-
{
|
|
1131
|
-
|
|
1207
|
+
{
|
|
1208
|
+
"name": "closestApp",
|
|
1209
|
+
"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.",
|
|
1210
|
+
"type": "AppElement | null"
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"name": "closestEntity",
|
|
1214
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1215
|
+
"type": "EntityElement | null"
|
|
1216
|
+
}
|
|
1132
1217
|
],
|
|
1133
1218
|
"events": [
|
|
1134
1219
|
{
|
|
@@ -1218,8 +1303,8 @@
|
|
|
1218
1303
|
"properties": [
|
|
1219
1304
|
{
|
|
1220
1305
|
"name": "scene",
|
|
1221
|
-
"description": "The PlayCanvas scene instance.
|
|
1222
|
-
"type": "Scene"
|
|
1306
|
+
"description": "The PlayCanvas scene instance. `null` until the element is ready — await\nwhenReady or the element's `ready()` promise before accessing it.",
|
|
1307
|
+
"type": "Scene | null"
|
|
1223
1308
|
},
|
|
1224
1309
|
{
|
|
1225
1310
|
"name": "fog",
|
|
@@ -1245,8 +1330,16 @@
|
|
|
1245
1330
|
"name": "gravity",
|
|
1246
1331
|
"description": "Gets the gravity of the scene."
|
|
1247
1332
|
},
|
|
1248
|
-
{
|
|
1249
|
-
|
|
1333
|
+
{
|
|
1334
|
+
"name": "closestApp",
|
|
1335
|
+
"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.",
|
|
1336
|
+
"type": "AppElement | null"
|
|
1337
|
+
},
|
|
1338
|
+
{
|
|
1339
|
+
"name": "closestEntity",
|
|
1340
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1341
|
+
"type": "EntityElement | null"
|
|
1342
|
+
}
|
|
1250
1343
|
],
|
|
1251
1344
|
"events": [
|
|
1252
1345
|
{
|
|
@@ -1277,16 +1370,16 @@
|
|
|
1277
1370
|
"description": "The intensity of the skybox.",
|
|
1278
1371
|
"value": { "type": "number", "default": "1" }
|
|
1279
1372
|
},
|
|
1280
|
-
{
|
|
1281
|
-
"name": "level",
|
|
1282
|
-
"description": "The mip level of the skybox.",
|
|
1283
|
-
"value": { "type": "number", "default": "0" }
|
|
1284
|
-
},
|
|
1285
1373
|
{
|
|
1286
1374
|
"name": "lighting",
|
|
1287
1375
|
"description": "Whether the skybox is used as a light source.",
|
|
1288
1376
|
"value": { "type": "boolean", "default": "false" }
|
|
1289
1377
|
},
|
|
1378
|
+
{
|
|
1379
|
+
"name": "mip-level",
|
|
1380
|
+
"description": "The mip level of the skybox.",
|
|
1381
|
+
"value": { "type": "number", "default": "0" }
|
|
1382
|
+
},
|
|
1290
1383
|
{
|
|
1291
1384
|
"name": "rotation",
|
|
1292
1385
|
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers.",
|
|
@@ -1327,14 +1420,14 @@
|
|
|
1327
1420
|
"name": "intensity",
|
|
1328
1421
|
"description": "Gets the intensity of the skybox."
|
|
1329
1422
|
},
|
|
1330
|
-
{
|
|
1331
|
-
"name": "level",
|
|
1332
|
-
"description": "Gets the mip level of the skybox."
|
|
1333
|
-
},
|
|
1334
1423
|
{
|
|
1335
1424
|
"name": "lighting",
|
|
1336
1425
|
"description": "Gets whether the skybox is used as a light source."
|
|
1337
1426
|
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "mipLevel",
|
|
1429
|
+
"description": "Gets the mip level of the skybox."
|
|
1430
|
+
},
|
|
1338
1431
|
{
|
|
1339
1432
|
"name": "rotation",
|
|
1340
1433
|
"description": "Gets the Euler rotation of the skybox."
|
|
@@ -1344,8 +1437,16 @@
|
|
|
1344
1437
|
"description": "Gets the scale of the skybox."
|
|
1345
1438
|
},
|
|
1346
1439
|
{ "name": "type", "description": "Gets the type of the skybox." },
|
|
1347
|
-
{
|
|
1348
|
-
|
|
1440
|
+
{
|
|
1441
|
+
"name": "closestApp",
|
|
1442
|
+
"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.",
|
|
1443
|
+
"type": "AppElement | null"
|
|
1444
|
+
},
|
|
1445
|
+
{
|
|
1446
|
+
"name": "closestEntity",
|
|
1447
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1448
|
+
"type": "EntityElement | null"
|
|
1449
|
+
}
|
|
1349
1450
|
],
|
|
1350
1451
|
"events": [
|
|
1351
1452
|
{
|
|
@@ -1449,7 +1550,7 @@
|
|
|
1449
1550
|
{
|
|
1450
1551
|
"name": "component",
|
|
1451
1552
|
"description": "Gets the underlying PlayCanvas button component.",
|
|
1452
|
-
"type": "Component"
|
|
1553
|
+
"type": "Component | null"
|
|
1453
1554
|
},
|
|
1454
1555
|
{
|
|
1455
1556
|
"name": "active",
|
|
@@ -1511,8 +1612,16 @@
|
|
|
1511
1612
|
"name": "enabled",
|
|
1512
1613
|
"description": "Gets the enabled state of the component."
|
|
1513
1614
|
},
|
|
1514
|
-
{
|
|
1515
|
-
|
|
1615
|
+
{
|
|
1616
|
+
"name": "closestApp",
|
|
1617
|
+
"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.",
|
|
1618
|
+
"type": "AppElement | null"
|
|
1619
|
+
},
|
|
1620
|
+
{
|
|
1621
|
+
"name": "closestEntity",
|
|
1622
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1623
|
+
"type": "EntityElement | null"
|
|
1624
|
+
}
|
|
1516
1625
|
],
|
|
1517
1626
|
"events": [
|
|
1518
1627
|
{
|
|
@@ -1598,16 +1707,19 @@
|
|
|
1598
1707
|
"description": "The orthographic height of the camera.",
|
|
1599
1708
|
"value": { "type": "number", "default": "10" }
|
|
1600
1709
|
},
|
|
1601
|
-
{
|
|
1602
|
-
"name": "orthographic",
|
|
1603
|
-
"description": "The orthographic projection of the camera.",
|
|
1604
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1605
|
-
},
|
|
1606
1710
|
{
|
|
1607
1711
|
"name": "priority",
|
|
1608
1712
|
"description": "The priority of the camera.",
|
|
1609
1713
|
"value": { "type": "number", "default": "0" }
|
|
1610
1714
|
},
|
|
1715
|
+
{
|
|
1716
|
+
"name": "projection",
|
|
1717
|
+
"description": "The projection of the camera.",
|
|
1718
|
+
"value": {
|
|
1719
|
+
"type": "'perspective' | 'orthographic'",
|
|
1720
|
+
"default": "perspective"
|
|
1721
|
+
}
|
|
1722
|
+
},
|
|
1611
1723
|
{
|
|
1612
1724
|
"name": "rect",
|
|
1613
1725
|
"description": "The rect of the camera. Accepts 4 space-separated numbers.",
|
|
@@ -1640,7 +1752,7 @@
|
|
|
1640
1752
|
{
|
|
1641
1753
|
"name": "component",
|
|
1642
1754
|
"description": "Gets the underlying PlayCanvas camera component.",
|
|
1643
|
-
"type": "Component"
|
|
1755
|
+
"type": "Component | null"
|
|
1644
1756
|
},
|
|
1645
1757
|
{
|
|
1646
1758
|
"name": "clearColor",
|
|
@@ -1702,11 +1814,6 @@
|
|
|
1702
1814
|
"description": "Gets the near clip distance of the camera.",
|
|
1703
1815
|
"type": "number"
|
|
1704
1816
|
},
|
|
1705
|
-
{
|
|
1706
|
-
"name": "orthographic",
|
|
1707
|
-
"description": "Gets the orthographic projection of the camera.",
|
|
1708
|
-
"type": "boolean"
|
|
1709
|
-
},
|
|
1710
1817
|
{
|
|
1711
1818
|
"name": "orthoHeight",
|
|
1712
1819
|
"description": "Gets the orthographic height of the camera."
|
|
@@ -1716,6 +1823,10 @@
|
|
|
1716
1823
|
"description": "Gets the priority of the camera.",
|
|
1717
1824
|
"type": "number"
|
|
1718
1825
|
},
|
|
1826
|
+
{
|
|
1827
|
+
"name": "projection",
|
|
1828
|
+
"description": "Gets the projection of the camera."
|
|
1829
|
+
},
|
|
1719
1830
|
{
|
|
1720
1831
|
"name": "rect",
|
|
1721
1832
|
"description": "Gets the rect of the camera.",
|
|
@@ -1735,8 +1846,16 @@
|
|
|
1735
1846
|
"name": "enabled",
|
|
1736
1847
|
"description": "Gets the enabled state of the component."
|
|
1737
1848
|
},
|
|
1738
|
-
{
|
|
1739
|
-
|
|
1849
|
+
{
|
|
1850
|
+
"name": "closestApp",
|
|
1851
|
+
"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.",
|
|
1852
|
+
"type": "AppElement | null"
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "closestEntity",
|
|
1856
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1857
|
+
"type": "EntityElement | null"
|
|
1858
|
+
}
|
|
1740
1859
|
],
|
|
1741
1860
|
"events": [
|
|
1742
1861
|
{
|
|
@@ -1802,7 +1921,7 @@
|
|
|
1802
1921
|
{
|
|
1803
1922
|
"name": "component",
|
|
1804
1923
|
"description": "Gets the underlying PlayCanvas collision component.",
|
|
1805
|
-
"type": "Component"
|
|
1924
|
+
"type": "Component | null"
|
|
1806
1925
|
},
|
|
1807
1926
|
{ "name": "angularOffset" },
|
|
1808
1927
|
{ "name": "axis" },
|
|
@@ -1816,8 +1935,16 @@
|
|
|
1816
1935
|
"name": "enabled",
|
|
1817
1936
|
"description": "Gets the enabled state of the component."
|
|
1818
1937
|
},
|
|
1819
|
-
{
|
|
1820
|
-
|
|
1938
|
+
{
|
|
1939
|
+
"name": "closestApp",
|
|
1940
|
+
"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.",
|
|
1941
|
+
"type": "AppElement | null"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "closestEntity",
|
|
1945
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
1946
|
+
"type": "EntityElement | null"
|
|
1947
|
+
}
|
|
1821
1948
|
],
|
|
1822
1949
|
"events": [
|
|
1823
1950
|
{
|
|
@@ -1984,7 +2111,7 @@
|
|
|
1984
2111
|
{
|
|
1985
2112
|
"name": "component",
|
|
1986
2113
|
"description": "Gets the underlying PlayCanvas element component.",
|
|
1987
|
-
"type": "Component"
|
|
2114
|
+
"type": "Component | null"
|
|
1988
2115
|
},
|
|
1989
2116
|
{
|
|
1990
2117
|
"name": "anchor",
|
|
@@ -2095,8 +2222,16 @@
|
|
|
2095
2222
|
"name": "enabled",
|
|
2096
2223
|
"description": "Gets the enabled state of the component."
|
|
2097
2224
|
},
|
|
2098
|
-
{
|
|
2099
|
-
|
|
2225
|
+
{
|
|
2226
|
+
"name": "closestApp",
|
|
2227
|
+
"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.",
|
|
2228
|
+
"type": "AppElement | null"
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"name": "closestEntity",
|
|
2232
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2233
|
+
"type": "EntityElement | null"
|
|
2234
|
+
}
|
|
2100
2235
|
],
|
|
2101
2236
|
"events": [
|
|
2102
2237
|
{
|
|
@@ -2160,7 +2295,7 @@
|
|
|
2160
2295
|
{
|
|
2161
2296
|
"name": "component",
|
|
2162
2297
|
"description": "Gets the underlying PlayCanvas gsplat component.",
|
|
2163
|
-
"type": "Component"
|
|
2298
|
+
"type": "Component | null"
|
|
2164
2299
|
},
|
|
2165
2300
|
{
|
|
2166
2301
|
"name": "asset",
|
|
@@ -2190,8 +2325,16 @@
|
|
|
2190
2325
|
"name": "enabled",
|
|
2191
2326
|
"description": "Gets the enabled state of the component."
|
|
2192
2327
|
},
|
|
2193
|
-
{
|
|
2194
|
-
|
|
2328
|
+
{
|
|
2329
|
+
"name": "closestApp",
|
|
2330
|
+
"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.",
|
|
2331
|
+
"type": "AppElement | null"
|
|
2332
|
+
},
|
|
2333
|
+
{
|
|
2334
|
+
"name": "closestEntity",
|
|
2335
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2336
|
+
"type": "EntityElement | null"
|
|
2337
|
+
}
|
|
2195
2338
|
],
|
|
2196
2339
|
"events": [
|
|
2197
2340
|
{
|
|
@@ -2260,7 +2403,7 @@
|
|
|
2260
2403
|
{
|
|
2261
2404
|
"name": "component",
|
|
2262
2405
|
"description": "Gets the underlying PlayCanvas layout child component.",
|
|
2263
|
-
"type": "Component"
|
|
2406
|
+
"type": "Component | null"
|
|
2264
2407
|
},
|
|
2265
2408
|
{
|
|
2266
2409
|
"name": "minWidth",
|
|
@@ -2294,8 +2437,16 @@
|
|
|
2294
2437
|
"name": "enabled",
|
|
2295
2438
|
"description": "Gets the enabled state of the component."
|
|
2296
2439
|
},
|
|
2297
|
-
{
|
|
2298
|
-
|
|
2440
|
+
{
|
|
2441
|
+
"name": "closestApp",
|
|
2442
|
+
"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.",
|
|
2443
|
+
"type": "AppElement | null"
|
|
2444
|
+
},
|
|
2445
|
+
{
|
|
2446
|
+
"name": "closestEntity",
|
|
2447
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2448
|
+
"type": "EntityElement | null"
|
|
2449
|
+
}
|
|
2299
2450
|
],
|
|
2300
2451
|
"events": [
|
|
2301
2452
|
{
|
|
@@ -2383,7 +2534,7 @@
|
|
|
2383
2534
|
{
|
|
2384
2535
|
"name": "component",
|
|
2385
2536
|
"description": "Gets the underlying PlayCanvas layout group component.",
|
|
2386
|
-
"type": "Component"
|
|
2537
|
+
"type": "Component | null"
|
|
2387
2538
|
},
|
|
2388
2539
|
{
|
|
2389
2540
|
"name": "orientation",
|
|
@@ -2425,8 +2576,16 @@
|
|
|
2425
2576
|
"name": "enabled",
|
|
2426
2577
|
"description": "Gets the enabled state of the component."
|
|
2427
2578
|
},
|
|
2428
|
-
{
|
|
2429
|
-
|
|
2579
|
+
{
|
|
2580
|
+
"name": "closestApp",
|
|
2581
|
+
"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.",
|
|
2582
|
+
"type": "AppElement | null"
|
|
2583
|
+
},
|
|
2584
|
+
{
|
|
2585
|
+
"name": "closestEntity",
|
|
2586
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2587
|
+
"type": "EntityElement | null"
|
|
2588
|
+
}
|
|
2430
2589
|
],
|
|
2431
2590
|
"events": [
|
|
2432
2591
|
{
|
|
@@ -2561,7 +2720,7 @@
|
|
|
2561
2720
|
{
|
|
2562
2721
|
"name": "component",
|
|
2563
2722
|
"description": "Gets the underlying PlayCanvas light component.",
|
|
2564
|
-
"type": "Component"
|
|
2723
|
+
"type": "Component | null"
|
|
2565
2724
|
},
|
|
2566
2725
|
{
|
|
2567
2726
|
"name": "castShadows",
|
|
@@ -2640,8 +2799,16 @@
|
|
|
2640
2799
|
"name": "enabled",
|
|
2641
2800
|
"description": "Gets the enabled state of the component."
|
|
2642
2801
|
},
|
|
2643
|
-
{
|
|
2644
|
-
|
|
2802
|
+
{
|
|
2803
|
+
"name": "closestApp",
|
|
2804
|
+
"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.",
|
|
2805
|
+
"type": "AppElement | null"
|
|
2806
|
+
},
|
|
2807
|
+
{
|
|
2808
|
+
"name": "closestEntity",
|
|
2809
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2810
|
+
"type": "EntityElement | null"
|
|
2811
|
+
}
|
|
2645
2812
|
],
|
|
2646
2813
|
"events": [
|
|
2647
2814
|
{
|
|
@@ -2675,14 +2842,22 @@
|
|
|
2675
2842
|
{
|
|
2676
2843
|
"name": "component",
|
|
2677
2844
|
"description": "Gets the underlying PlayCanvas audio listener component.",
|
|
2678
|
-
"type": "Component"
|
|
2845
|
+
"type": "Component | null"
|
|
2679
2846
|
},
|
|
2680
2847
|
{
|
|
2681
2848
|
"name": "enabled",
|
|
2682
2849
|
"description": "Gets the enabled state of the component."
|
|
2683
2850
|
},
|
|
2684
|
-
{
|
|
2685
|
-
|
|
2851
|
+
{
|
|
2852
|
+
"name": "closestApp",
|
|
2853
|
+
"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.",
|
|
2854
|
+
"type": "AppElement | null"
|
|
2855
|
+
},
|
|
2856
|
+
{
|
|
2857
|
+
"name": "closestEntity",
|
|
2858
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2859
|
+
"type": "EntityElement | null"
|
|
2860
|
+
}
|
|
2686
2861
|
],
|
|
2687
2862
|
"events": [
|
|
2688
2863
|
{
|
|
@@ -2721,7 +2896,7 @@
|
|
|
2721
2896
|
{
|
|
2722
2897
|
"name": "component",
|
|
2723
2898
|
"description": "Gets the underlying PlayCanvas particle system component.",
|
|
2724
|
-
"type": "Component"
|
|
2899
|
+
"type": "Component | null"
|
|
2725
2900
|
},
|
|
2726
2901
|
{
|
|
2727
2902
|
"name": "asset",
|
|
@@ -2732,8 +2907,16 @@
|
|
|
2732
2907
|
"name": "enabled",
|
|
2733
2908
|
"description": "Gets the enabled state of the component."
|
|
2734
2909
|
},
|
|
2735
|
-
{
|
|
2736
|
-
|
|
2910
|
+
{
|
|
2911
|
+
"name": "closestApp",
|
|
2912
|
+
"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.",
|
|
2913
|
+
"type": "AppElement | null"
|
|
2914
|
+
},
|
|
2915
|
+
{
|
|
2916
|
+
"name": "closestEntity",
|
|
2917
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
2918
|
+
"type": "EntityElement | null"
|
|
2919
|
+
}
|
|
2737
2920
|
],
|
|
2738
2921
|
"events": [
|
|
2739
2922
|
{
|
|
@@ -2790,7 +2973,7 @@
|
|
|
2790
2973
|
{
|
|
2791
2974
|
"name": "component",
|
|
2792
2975
|
"description": "Gets the underlying PlayCanvas render component.",
|
|
2793
|
-
"type": "Component"
|
|
2976
|
+
"type": "Component | null"
|
|
2794
2977
|
},
|
|
2795
2978
|
{
|
|
2796
2979
|
"name": "type",
|
|
@@ -2815,8 +2998,16 @@
|
|
|
2815
2998
|
"name": "enabled",
|
|
2816
2999
|
"description": "Gets the enabled state of the component."
|
|
2817
3000
|
},
|
|
2818
|
-
{
|
|
2819
|
-
|
|
3001
|
+
{
|
|
3002
|
+
"name": "closestApp",
|
|
3003
|
+
"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.",
|
|
3004
|
+
"type": "AppElement | null"
|
|
3005
|
+
},
|
|
3006
|
+
{
|
|
3007
|
+
"name": "closestEntity",
|
|
3008
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3009
|
+
"type": "EntityElement | null"
|
|
3010
|
+
}
|
|
2820
3011
|
],
|
|
2821
3012
|
"events": [
|
|
2822
3013
|
{
|
|
@@ -2888,7 +3079,7 @@
|
|
|
2888
3079
|
{
|
|
2889
3080
|
"name": "component",
|
|
2890
3081
|
"description": "Gets the underlying PlayCanvas rigidbody component.",
|
|
2891
|
-
"type": "Component"
|
|
3082
|
+
"type": "Component | null"
|
|
2892
3083
|
},
|
|
2893
3084
|
{ "name": "angularDamping" },
|
|
2894
3085
|
{ "name": "angularFactor" },
|
|
@@ -2903,8 +3094,16 @@
|
|
|
2903
3094
|
"name": "enabled",
|
|
2904
3095
|
"description": "Gets the enabled state of the component."
|
|
2905
3096
|
},
|
|
2906
|
-
{
|
|
2907
|
-
|
|
3097
|
+
{
|
|
3098
|
+
"name": "closestApp",
|
|
3099
|
+
"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.",
|
|
3100
|
+
"type": "AppElement | null"
|
|
3101
|
+
},
|
|
3102
|
+
{
|
|
3103
|
+
"name": "closestEntity",
|
|
3104
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3105
|
+
"type": "EntityElement | null"
|
|
3106
|
+
}
|
|
2908
3107
|
],
|
|
2909
3108
|
"events": [
|
|
2910
3109
|
{
|
|
@@ -2920,10 +3119,6 @@
|
|
|
2920
3119
|
"description": "The ScreenComponentElement interface provides properties and methods for manipulating\n[`<pc-screen>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/) elements.\nThe ScreenComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
|
|
2921
3120
|
"doc-url": "",
|
|
2922
3121
|
"attributes": [
|
|
2923
|
-
{
|
|
2924
|
-
"name": "blend",
|
|
2925
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2926
|
-
},
|
|
2927
3122
|
{
|
|
2928
3123
|
"name": "enabled",
|
|
2929
3124
|
"description": "The enabled state of the component.",
|
|
@@ -2945,8 +3140,14 @@
|
|
|
2945
3140
|
},
|
|
2946
3141
|
{
|
|
2947
3142
|
"name": "scale-blend",
|
|
3143
|
+
"description": "How the screen's resolutions are weighted against each other.",
|
|
2948
3144
|
"value": { "type": "number", "default": "0.5" }
|
|
2949
3145
|
},
|
|
3146
|
+
{
|
|
3147
|
+
"name": "scale-mode",
|
|
3148
|
+
"description": "How the screen scales its contents.",
|
|
3149
|
+
"value": { "type": "'none' | 'blend'", "default": "none" }
|
|
3150
|
+
},
|
|
2950
3151
|
{
|
|
2951
3152
|
"name": "screen-space",
|
|
2952
3153
|
"value": { "type": "boolean", "default": "false" }
|
|
@@ -2964,20 +3165,34 @@
|
|
|
2964
3165
|
{
|
|
2965
3166
|
"name": "component",
|
|
2966
3167
|
"description": "Gets the underlying PlayCanvas screen component.",
|
|
2967
|
-
"type": "Component"
|
|
3168
|
+
"type": "Component | null"
|
|
2968
3169
|
},
|
|
2969
3170
|
{ "name": "priority" },
|
|
2970
3171
|
{ "name": "referenceResolution" },
|
|
2971
3172
|
{ "name": "resolution" },
|
|
2972
|
-
{
|
|
2973
|
-
|
|
3173
|
+
{
|
|
3174
|
+
"name": "scaleBlend",
|
|
3175
|
+
"description": "Gets how the screen's resolutions are weighted against each other."
|
|
3176
|
+
},
|
|
3177
|
+
{
|
|
3178
|
+
"name": "scaleMode",
|
|
3179
|
+
"description": "Gets how the screen scales its contents."
|
|
3180
|
+
},
|
|
2974
3181
|
{ "name": "screenSpace" },
|
|
2975
3182
|
{
|
|
2976
3183
|
"name": "enabled",
|
|
2977
3184
|
"description": "Gets the enabled state of the component."
|
|
2978
3185
|
},
|
|
2979
|
-
{
|
|
2980
|
-
|
|
3186
|
+
{
|
|
3187
|
+
"name": "closestApp",
|
|
3188
|
+
"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.",
|
|
3189
|
+
"type": "AppElement | null"
|
|
3190
|
+
},
|
|
3191
|
+
{
|
|
3192
|
+
"name": "closestEntity",
|
|
3193
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3194
|
+
"type": "EntityElement | null"
|
|
3195
|
+
}
|
|
2981
3196
|
],
|
|
2982
3197
|
"events": [
|
|
2983
3198
|
{
|
|
@@ -3011,14 +3226,22 @@
|
|
|
3011
3226
|
{
|
|
3012
3227
|
"name": "component",
|
|
3013
3228
|
"description": "Gets the underlying PlayCanvas script component.",
|
|
3014
|
-
"type": "Component"
|
|
3229
|
+
"type": "Component | null"
|
|
3015
3230
|
},
|
|
3016
3231
|
{
|
|
3017
3232
|
"name": "enabled",
|
|
3018
3233
|
"description": "Gets the enabled state of the component."
|
|
3019
3234
|
},
|
|
3020
|
-
{
|
|
3021
|
-
|
|
3235
|
+
{
|
|
3236
|
+
"name": "closestApp",
|
|
3237
|
+
"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.",
|
|
3238
|
+
"type": "AppElement | null"
|
|
3239
|
+
},
|
|
3240
|
+
{
|
|
3241
|
+
"name": "closestEntity",
|
|
3242
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3243
|
+
"type": "EntityElement | null"
|
|
3244
|
+
}
|
|
3022
3245
|
],
|
|
3023
3246
|
"events": [
|
|
3024
3247
|
{
|
|
@@ -3089,8 +3312,16 @@
|
|
|
3089
3312
|
"description": "Gets the Script instance created for this element. Returns `null` until the\ninstance exists — await whenReady or the element's `ready()` promise before\naccessing it.",
|
|
3090
3313
|
"type": "Script | null"
|
|
3091
3314
|
},
|
|
3092
|
-
{
|
|
3093
|
-
|
|
3315
|
+
{
|
|
3316
|
+
"name": "closestApp",
|
|
3317
|
+
"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.",
|
|
3318
|
+
"type": "AppElement | null"
|
|
3319
|
+
},
|
|
3320
|
+
{
|
|
3321
|
+
"name": "closestEntity",
|
|
3322
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3323
|
+
"type": "EntityElement | null"
|
|
3324
|
+
}
|
|
3094
3325
|
],
|
|
3095
3326
|
"events": [
|
|
3096
3327
|
{
|
|
@@ -3162,7 +3393,7 @@
|
|
|
3162
3393
|
{
|
|
3163
3394
|
"name": "component",
|
|
3164
3395
|
"description": "Gets the underlying PlayCanvas scrollbar component.",
|
|
3165
|
-
"type": "Component"
|
|
3396
|
+
"type": "Component | null"
|
|
3166
3397
|
},
|
|
3167
3398
|
{
|
|
3168
3399
|
"name": "orientation",
|
|
@@ -3184,8 +3415,16 @@
|
|
|
3184
3415
|
"name": "enabled",
|
|
3185
3416
|
"description": "Gets the enabled state of the component."
|
|
3186
3417
|
},
|
|
3187
|
-
{
|
|
3188
|
-
|
|
3418
|
+
{
|
|
3419
|
+
"name": "closestApp",
|
|
3420
|
+
"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.",
|
|
3421
|
+
"type": "AppElement | null"
|
|
3422
|
+
},
|
|
3423
|
+
{
|
|
3424
|
+
"name": "closestEntity",
|
|
3425
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3426
|
+
"type": "EntityElement | null"
|
|
3427
|
+
}
|
|
3189
3428
|
],
|
|
3190
3429
|
"events": [
|
|
3191
3430
|
{
|
|
@@ -3223,7 +3462,7 @@
|
|
|
3223
3462
|
},
|
|
3224
3463
|
{
|
|
3225
3464
|
"name": "horizontal",
|
|
3226
|
-
"description": "Whether horizontal
|
|
3465
|
+
"description": "Whether scrolling along the horizontal axis is enabled.",
|
|
3227
3466
|
"value": { "type": "boolean", "default": "true" }
|
|
3228
3467
|
},
|
|
3229
3468
|
{
|
|
@@ -3259,7 +3498,7 @@
|
|
|
3259
3498
|
},
|
|
3260
3499
|
{
|
|
3261
3500
|
"name": "vertical",
|
|
3262
|
-
"description": "Whether vertical
|
|
3501
|
+
"description": "Whether scrolling along the vertical axis is enabled.",
|
|
3263
3502
|
"value": { "type": "boolean", "default": "true" }
|
|
3264
3503
|
},
|
|
3265
3504
|
{
|
|
@@ -3293,15 +3532,15 @@
|
|
|
3293
3532
|
{
|
|
3294
3533
|
"name": "component",
|
|
3295
3534
|
"description": "Gets the underlying PlayCanvas scroll view component.",
|
|
3296
|
-
"type": "Component"
|
|
3535
|
+
"type": "Component | null"
|
|
3297
3536
|
},
|
|
3298
3537
|
{
|
|
3299
3538
|
"name": "horizontal",
|
|
3300
|
-
"description": "Gets whether horizontal
|
|
3539
|
+
"description": "Gets whether scrolling along the horizontal axis is enabled."
|
|
3301
3540
|
},
|
|
3302
3541
|
{
|
|
3303
3542
|
"name": "vertical",
|
|
3304
|
-
"description": "Gets whether vertical
|
|
3543
|
+
"description": "Gets whether scrolling along the vertical axis is enabled."
|
|
3305
3544
|
},
|
|
3306
3545
|
{
|
|
3307
3546
|
"name": "scrollMode",
|
|
@@ -3348,8 +3587,16 @@
|
|
|
3348
3587
|
"name": "enabled",
|
|
3349
3588
|
"description": "Gets the enabled state of the component."
|
|
3350
3589
|
},
|
|
3351
|
-
{
|
|
3352
|
-
|
|
3590
|
+
{
|
|
3591
|
+
"name": "closestApp",
|
|
3592
|
+
"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.",
|
|
3593
|
+
"type": "AppElement | null"
|
|
3594
|
+
},
|
|
3595
|
+
{
|
|
3596
|
+
"name": "closestEntity",
|
|
3597
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3598
|
+
"type": "EntityElement | null"
|
|
3599
|
+
}
|
|
3353
3600
|
],
|
|
3354
3601
|
"events": [
|
|
3355
3602
|
{
|
|
@@ -3421,7 +3668,7 @@
|
|
|
3421
3668
|
{
|
|
3422
3669
|
"name": "component",
|
|
3423
3670
|
"description": "Gets the underlying PlayCanvas sound component.",
|
|
3424
|
-
"type": "Component"
|
|
3671
|
+
"type": "Component | null"
|
|
3425
3672
|
},
|
|
3426
3673
|
{
|
|
3427
3674
|
"name": "distanceModel",
|
|
@@ -3456,8 +3703,16 @@
|
|
|
3456
3703
|
"name": "enabled",
|
|
3457
3704
|
"description": "Gets the enabled state of the component."
|
|
3458
3705
|
},
|
|
3459
|
-
{
|
|
3460
|
-
|
|
3706
|
+
{
|
|
3707
|
+
"name": "closestApp",
|
|
3708
|
+
"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.",
|
|
3709
|
+
"type": "AppElement | null"
|
|
3710
|
+
},
|
|
3711
|
+
{
|
|
3712
|
+
"name": "closestEntity",
|
|
3713
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3714
|
+
"type": "EntityElement | null"
|
|
3715
|
+
}
|
|
3461
3716
|
],
|
|
3462
3717
|
"events": [
|
|
3463
3718
|
{
|
|
@@ -3570,8 +3825,16 @@
|
|
|
3570
3825
|
"name": "volume",
|
|
3571
3826
|
"description": "Gets the volume of the sound slot."
|
|
3572
3827
|
},
|
|
3573
|
-
{
|
|
3574
|
-
|
|
3828
|
+
{
|
|
3829
|
+
"name": "closestApp",
|
|
3830
|
+
"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.",
|
|
3831
|
+
"type": "AppElement | null"
|
|
3832
|
+
},
|
|
3833
|
+
{
|
|
3834
|
+
"name": "closestEntity",
|
|
3835
|
+
"description": "The nearest ancestor `<pc-entity>` element, or `null` if this element has no `<pc-entity>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
|
|
3836
|
+
"type": "EntityElement | null"
|
|
3837
|
+
}
|
|
3575
3838
|
],
|
|
3576
3839
|
"events": [
|
|
3577
3840
|
{
|