@playcanvas/web-components 0.9.0 → 0.10.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 +18 -0
- package/dist/app.d.ts +3 -2
- package/dist/asset.d.ts +16 -1
- package/dist/async-element.d.ts +3 -0
- package/dist/components/button-component.d.ts +1 -1
- package/dist/components/camera-component.d.ts +1 -1
- package/dist/components/collision-component.d.ts +1 -1
- package/dist/components/component.d.ts +1 -1
- package/dist/components/element-component.d.ts +1 -1
- package/dist/components/gsplat-component.d.ts +1 -1
- package/dist/components/layoutchild-component.d.ts +1 -1
- package/dist/components/layoutgroup-component.d.ts +1 -1
- package/dist/components/light-component.d.ts +1 -1
- package/dist/components/particlesystem-component.d.ts +1 -1
- package/dist/components/render-component.d.ts +1 -1
- package/dist/components/rigidbody-component.d.ts +1 -1
- package/dist/components/screen-component.d.ts +1 -1
- package/dist/components/script.d.ts +8 -1
- package/dist/components/scrollbar-component.d.ts +1 -1
- package/dist/components/scrollview-component.d.ts +1 -1
- package/dist/components/sound-component.d.ts +1 -1
- package/dist/components/sound-slot.d.ts +9 -1
- package/dist/custom-elements.json +16231 -0
- package/dist/entity.d.ts +19 -1
- package/dist/material.d.ts +966 -4
- package/dist/model.d.ts +1 -1
- package/dist/module.d.ts +10 -0
- package/dist/{utils.d.ts → parse.d.ts} +63 -33
- package/dist/pwc.cjs +2677 -586
- package/dist/pwc.cjs.map +1 -1
- package/dist/pwc.js +2677 -586
- 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 +2 -0
- package/dist/pwc.min.mjs.map +1 -0
- package/dist/pwc.mjs +2678 -587
- package/dist/pwc.mjs.map +1 -1
- package/dist/scene.d.ts +1 -1
- package/dist/sky.d.ts +1 -1
- package/dist/vscode.html-custom-data.json +1795 -0
- package/dist/web-types.json +3592 -0
- package/package.json +29 -11
- package/src/app.ts +6 -5
- package/src/asset.ts +19 -2
- package/src/async-element.ts +3 -0
- package/src/components/button-component.ts +6 -6
- package/src/components/camera-component.ts +2 -2
- package/src/components/collision-component.ts +2 -2
- package/src/components/component.ts +2 -2
- package/src/components/element-component.ts +6 -6
- package/src/components/gsplat-component.ts +3 -3
- package/src/components/layoutchild-component.ts +2 -2
- package/src/components/layoutgroup-component.ts +2 -2
- package/src/components/light-component.ts +2 -2
- package/src/components/particlesystem-component.ts +2 -2
- package/src/components/render-component.ts +10 -5
- package/src/components/rigidbody-component.ts +2 -2
- package/src/components/screen-component.ts +2 -2
- package/src/components/script-component.ts +4 -4
- package/src/components/script.ts +9 -2
- package/src/components/scrollbar-component.ts +3 -3
- package/src/components/scrollview-component.ts +6 -6
- package/src/components/sound-component.ts +2 -2
- package/src/components/sound-slot.ts +31 -9
- package/src/entity.ts +25 -7
- package/src/material.ts +2396 -59
- package/src/model.ts +2 -2
- package/src/module.ts +10 -0
- package/src/{utils.ts → parse.ts} +104 -65
- package/src/scene.ts +2 -2
- package/src/sky.ts +3 -3
|
@@ -0,0 +1,1795 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
|
|
3
|
+
"version": 1.1,
|
|
4
|
+
"tags": [
|
|
5
|
+
{
|
|
6
|
+
"name": "pc-app",
|
|
7
|
+
"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.",
|
|
8
|
+
"attributes": [
|
|
9
|
+
{ "name": "alpha", "description": "The alpha flag.", "values": [] },
|
|
10
|
+
{
|
|
11
|
+
"name": "antialias",
|
|
12
|
+
"description": "The antialias flag.",
|
|
13
|
+
"values": []
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "backend",
|
|
17
|
+
"description": "The graphics backend.",
|
|
18
|
+
"values": [
|
|
19
|
+
{ "name": "webgpu" },
|
|
20
|
+
{ "name": "webgl2" },
|
|
21
|
+
{ "name": "null" }
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
{ "name": "depth", "description": "The depth flag.", "values": [] },
|
|
25
|
+
{
|
|
26
|
+
"name": "high-resolution",
|
|
27
|
+
"description": "The high resolution flag.",
|
|
28
|
+
"values": []
|
|
29
|
+
},
|
|
30
|
+
{ "name": "stencil", "description": "The stencil flag.", "values": [] }
|
|
31
|
+
],
|
|
32
|
+
"references": []
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "pc-asset",
|
|
36
|
+
"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.",
|
|
37
|
+
"attributes": [
|
|
38
|
+
{
|
|
39
|
+
"name": "atlas",
|
|
40
|
+
"description": "For a `sprite` asset, the `id` of the texture atlas asset it uses. The atlas must be declared before the sprite.",
|
|
41
|
+
"values": []
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "data",
|
|
45
|
+
"description": "Additional asset data, as a JSON object.",
|
|
46
|
+
"values": []
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"name": "frame-keys",
|
|
50
|
+
"description": "For a `sprite` asset, the atlas frame keys it uses, separated by spaces or commas.",
|
|
51
|
+
"values": []
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "id",
|
|
55
|
+
"description": "The identifier used to reference the asset from other elements.",
|
|
56
|
+
"values": []
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "lazy",
|
|
60
|
+
"description": "Whether the asset should be loaded lazily.",
|
|
61
|
+
"values": []
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "pixels-per-unit",
|
|
65
|
+
"description": "For a `sprite` asset, the number of pixels per world unit.",
|
|
66
|
+
"values": []
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "render-mode",
|
|
70
|
+
"description": "For a `sprite` asset, how the sprite is rendered when resized.",
|
|
71
|
+
"values": [
|
|
72
|
+
{ "name": "simple" },
|
|
73
|
+
{ "name": "sliced" },
|
|
74
|
+
{ "name": "tiled" }
|
|
75
|
+
]
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "src",
|
|
79
|
+
"description": "The URL of the asset to load.",
|
|
80
|
+
"values": []
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "type",
|
|
84
|
+
"description": "The asset type. Inferred from the `src` file extension when omitted.",
|
|
85
|
+
"values": []
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"references": []
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"name": "pc-entity",
|
|
92
|
+
"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\n---\n\n\n### **Events:**\n - **pointerdown** - Fired when a pointer button is pressed over the entity.\n- **pointerenter** - Fired when the pointer moves onto the entity.\n- **pointerleave** - Fired when the pointer moves off the entity.\n- **pointermove** - Fired when the pointer moves over the entity.\n- **pointerup** - Fired when a pointer button is released over the entity.\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.",
|
|
93
|
+
"attributes": [
|
|
94
|
+
{
|
|
95
|
+
"name": "enabled",
|
|
96
|
+
"description": "The enabled state of the entity.",
|
|
97
|
+
"values": []
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "name",
|
|
101
|
+
"description": "The name of the entity.",
|
|
102
|
+
"values": []
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "onpointerdown",
|
|
106
|
+
"description": "Script to run when a pointer button is pressed over the entity.",
|
|
107
|
+
"values": []
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"name": "onpointerenter",
|
|
111
|
+
"description": "Script to run when the pointer moves onto the entity.",
|
|
112
|
+
"values": []
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "onpointerleave",
|
|
116
|
+
"description": "Script to run when the pointer moves off the entity.",
|
|
117
|
+
"values": []
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "onpointermove",
|
|
121
|
+
"description": "Script to run when the pointer moves over the entity.",
|
|
122
|
+
"values": []
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"name": "onpointerup",
|
|
126
|
+
"description": "Script to run when a pointer button is released over the entity.",
|
|
127
|
+
"values": []
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "position",
|
|
131
|
+
"description": "The position of the entity. Accepts 3 space-separated numbers.",
|
|
132
|
+
"values": []
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "rotation",
|
|
136
|
+
"description": "The rotation of the entity. Accepts 3 space-separated numbers.",
|
|
137
|
+
"values": []
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"name": "scale",
|
|
141
|
+
"description": "The scale of the entity. Accepts 3 space-separated numbers.",
|
|
142
|
+
"values": []
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "tags",
|
|
146
|
+
"description": "The tags of the entity.",
|
|
147
|
+
"values": []
|
|
148
|
+
}
|
|
149
|
+
],
|
|
150
|
+
"references": []
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"name": "pc-material",
|
|
154
|
+
"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. The\n`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.",
|
|
155
|
+
"attributes": [
|
|
156
|
+
{
|
|
157
|
+
"name": "alpha-test",
|
|
158
|
+
"description": "The alpha test reference value.",
|
|
159
|
+
"values": []
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"name": "alpha-to-coverage",
|
|
163
|
+
"description": "Whether to use alpha to coverage.",
|
|
164
|
+
"values": []
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "ao-intensity",
|
|
168
|
+
"description": "The strength of the ambient occlusion map.",
|
|
169
|
+
"values": []
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "ao-map",
|
|
173
|
+
"description": "The id of the `pc-asset` used as the ambient occlusion map.",
|
|
174
|
+
"values": []
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "ao-map-channel",
|
|
178
|
+
"description": "The color channel of the ambient occlusion map to sample.",
|
|
179
|
+
"values": [
|
|
180
|
+
{ "name": "r" },
|
|
181
|
+
{ "name": "g" },
|
|
182
|
+
{ "name": "b" },
|
|
183
|
+
{ "name": "a" }
|
|
184
|
+
]
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"name": "ao-map-offset",
|
|
188
|
+
"description": "The 2D offset of the ambient occlusion map. Accepts 2 space-separated numbers.",
|
|
189
|
+
"values": []
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"name": "ao-map-rotation",
|
|
193
|
+
"description": "The 2D rotation of the ambient occlusion map.",
|
|
194
|
+
"values": []
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "ao-map-tiling",
|
|
198
|
+
"description": "The 2D tiling of the ambient occlusion map. Accepts 2 space-separated numbers.",
|
|
199
|
+
"values": []
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"name": "ao-map-uv",
|
|
203
|
+
"description": "The UV channel the ambient occlusion map samples.",
|
|
204
|
+
"values": []
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "blend-type",
|
|
208
|
+
"description": "How the material is blended with the scene behind it.",
|
|
209
|
+
"values": [
|
|
210
|
+
{ "name": "none" },
|
|
211
|
+
{ "name": "normal" },
|
|
212
|
+
{ "name": "additive" },
|
|
213
|
+
{ "name": "additive-alpha" },
|
|
214
|
+
{ "name": "premultiplied" },
|
|
215
|
+
{ "name": "multiplicative" },
|
|
216
|
+
{ "name": "multiplicative-2x" },
|
|
217
|
+
{ "name": "screen" },
|
|
218
|
+
{ "name": "min" },
|
|
219
|
+
{ "name": "max" },
|
|
220
|
+
{ "name": "subtractive" }
|
|
221
|
+
]
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"name": "bumpiness",
|
|
225
|
+
"description": "The strength of the normal map.",
|
|
226
|
+
"values": []
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "cull",
|
|
230
|
+
"description": "Which faces of a mesh are culled.",
|
|
231
|
+
"values": [
|
|
232
|
+
{ "name": "none" },
|
|
233
|
+
{ "name": "back" },
|
|
234
|
+
{ "name": "front" },
|
|
235
|
+
{ "name": "front-and-back" }
|
|
236
|
+
]
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "depth-bias",
|
|
240
|
+
"description": "The offset applied to the depth of a fragment.",
|
|
241
|
+
"values": []
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "depth-test",
|
|
245
|
+
"description": "Whether fragments are tested against the depth buffer.",
|
|
246
|
+
"values": []
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "depth-write",
|
|
250
|
+
"description": "Whether fragments write to the depth buffer.",
|
|
251
|
+
"values": []
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"name": "diffuse",
|
|
255
|
+
"description": "The diffuse color of the material. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
256
|
+
"values": []
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "diffuse-map",
|
|
260
|
+
"description": "The id of the `pc-asset` used as the diffuse map.",
|
|
261
|
+
"values": []
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"name": "diffuse-map-channel",
|
|
265
|
+
"description": "The color channels of the diffuse map to sample.",
|
|
266
|
+
"values": [
|
|
267
|
+
{ "name": "r" },
|
|
268
|
+
{ "name": "g" },
|
|
269
|
+
{ "name": "b" },
|
|
270
|
+
{ "name": "a" },
|
|
271
|
+
{ "name": "rgb" }
|
|
272
|
+
]
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "diffuse-map-offset",
|
|
276
|
+
"description": "The 2D offset of the diffuse map. Accepts 2 space-separated numbers.",
|
|
277
|
+
"values": []
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "diffuse-map-rotation",
|
|
281
|
+
"description": "The 2D rotation of the diffuse map.",
|
|
282
|
+
"values": []
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"name": "diffuse-map-tiling",
|
|
286
|
+
"description": "The 2D tiling of the diffuse map. Accepts 2 space-separated numbers.",
|
|
287
|
+
"values": []
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"name": "diffuse-map-uv",
|
|
291
|
+
"description": "The UV channel the diffuse map samples.",
|
|
292
|
+
"values": []
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
"name": "emissive",
|
|
296
|
+
"description": "The emissive color of the material. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
297
|
+
"values": []
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "emissive-intensity",
|
|
301
|
+
"description": "The multiplier applied to the emissive color and map.",
|
|
302
|
+
"values": []
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "emissive-map",
|
|
306
|
+
"description": "The id of the `pc-asset` used as the emissive map.",
|
|
307
|
+
"values": []
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"name": "emissive-map-channel",
|
|
311
|
+
"description": "The color channels of the emissive map to sample.",
|
|
312
|
+
"values": [
|
|
313
|
+
{ "name": "r" },
|
|
314
|
+
{ "name": "g" },
|
|
315
|
+
{ "name": "b" },
|
|
316
|
+
{ "name": "a" },
|
|
317
|
+
{ "name": "rgb" }
|
|
318
|
+
]
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "emissive-map-offset",
|
|
322
|
+
"description": "The 2D offset of the emissive map. Accepts 2 space-separated numbers.",
|
|
323
|
+
"values": []
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "emissive-map-rotation",
|
|
327
|
+
"description": "The 2D rotation of the emissive map.",
|
|
328
|
+
"values": []
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"name": "emissive-map-tiling",
|
|
332
|
+
"description": "The 2D tiling of the emissive map. Accepts 2 space-separated numbers.",
|
|
333
|
+
"values": []
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"name": "emissive-map-uv",
|
|
337
|
+
"description": "The UV channel the emissive map samples.",
|
|
338
|
+
"values": []
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"name": "enable-ggx-specular",
|
|
342
|
+
"description": "Whether to use the GGX specular model.",
|
|
343
|
+
"values": []
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"name": "fresnel-model",
|
|
347
|
+
"description": "The Fresnel model used for specular reflections at grazing angles.",
|
|
348
|
+
"values": [{ "name": "none" }, { "name": "schlick" }]
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "gloss",
|
|
352
|
+
"description": "The glossiness of the material.",
|
|
353
|
+
"values": []
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "gloss-invert",
|
|
357
|
+
"description": "Whether the gloss value and map are inverted.",
|
|
358
|
+
"values": []
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"name": "gloss-map",
|
|
362
|
+
"description": "The id of the `pc-asset` used as the gloss map.",
|
|
363
|
+
"values": []
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"name": "gloss-map-channel",
|
|
367
|
+
"description": "The color channel of the gloss map to sample.",
|
|
368
|
+
"values": [
|
|
369
|
+
{ "name": "r" },
|
|
370
|
+
{ "name": "g" },
|
|
371
|
+
{ "name": "b" },
|
|
372
|
+
{ "name": "a" }
|
|
373
|
+
]
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "gloss-map-offset",
|
|
377
|
+
"description": "The 2D offset of the gloss map. Accepts 2 space-separated numbers.",
|
|
378
|
+
"values": []
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "gloss-map-rotation",
|
|
382
|
+
"description": "The 2D rotation of the gloss map.",
|
|
383
|
+
"values": []
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"name": "gloss-map-tiling",
|
|
387
|
+
"description": "The 2D tiling of the gloss map. Accepts 2 space-separated numbers.",
|
|
388
|
+
"values": []
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"name": "gloss-map-uv",
|
|
392
|
+
"description": "The UV channel the gloss map samples.",
|
|
393
|
+
"values": []
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"name": "height-map",
|
|
397
|
+
"description": "The id of the `pc-asset` used as the height map.",
|
|
398
|
+
"values": []
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "height-map-channel",
|
|
402
|
+
"description": "The color channel of the height map to sample.",
|
|
403
|
+
"values": [
|
|
404
|
+
{ "name": "r" },
|
|
405
|
+
{ "name": "g" },
|
|
406
|
+
{ "name": "b" },
|
|
407
|
+
{ "name": "a" }
|
|
408
|
+
]
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"name": "height-map-factor",
|
|
412
|
+
"description": "The strength of the parallax effect driven by the height map.",
|
|
413
|
+
"values": []
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "height-map-offset",
|
|
417
|
+
"description": "The 2D offset of the height map. Accepts 2 space-separated numbers.",
|
|
418
|
+
"values": []
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
"name": "height-map-rotation",
|
|
422
|
+
"description": "The 2D rotation of the height map.",
|
|
423
|
+
"values": []
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "height-map-tiling",
|
|
427
|
+
"description": "The 2D tiling of the height map. Accepts 2 space-separated numbers.",
|
|
428
|
+
"values": []
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "height-map-uv",
|
|
432
|
+
"description": "The UV channel the height map samples.",
|
|
433
|
+
"values": []
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "metalness",
|
|
437
|
+
"description": "How metallic the surface is.",
|
|
438
|
+
"values": []
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "metalness-map",
|
|
442
|
+
"description": "The id of the `pc-asset` used as the metalness map.",
|
|
443
|
+
"values": []
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "metalness-map-channel",
|
|
447
|
+
"description": "The color channel of the metalness map to sample.",
|
|
448
|
+
"values": [
|
|
449
|
+
{ "name": "r" },
|
|
450
|
+
{ "name": "g" },
|
|
451
|
+
{ "name": "b" },
|
|
452
|
+
{ "name": "a" }
|
|
453
|
+
]
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"name": "metalness-map-offset",
|
|
457
|
+
"description": "The 2D offset of the metalness map. Accepts 2 space-separated numbers.",
|
|
458
|
+
"values": []
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"name": "metalness-map-rotation",
|
|
462
|
+
"description": "The 2D rotation of the metalness map.",
|
|
463
|
+
"values": []
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "metalness-map-tiling",
|
|
467
|
+
"description": "The 2D tiling of the metalness map. Accepts 2 space-separated numbers.",
|
|
468
|
+
"values": []
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "metalness-map-uv",
|
|
472
|
+
"description": "The UV channel the metalness map samples.",
|
|
473
|
+
"values": []
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "normal-map",
|
|
477
|
+
"description": "The id of the `pc-asset` used as the normal map.",
|
|
478
|
+
"values": []
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "normal-map-offset",
|
|
482
|
+
"description": "The 2D offset of the normal map. Accepts 2 space-separated numbers.",
|
|
483
|
+
"values": []
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "normal-map-rotation",
|
|
487
|
+
"description": "The 2D rotation of the normal map.",
|
|
488
|
+
"values": []
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"name": "normal-map-tiling",
|
|
492
|
+
"description": "The 2D tiling of the normal map. Accepts 2 space-separated numbers.",
|
|
493
|
+
"values": []
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "normal-map-uv",
|
|
497
|
+
"description": "The UV channel the normal map samples.",
|
|
498
|
+
"values": []
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "occlude-direct",
|
|
502
|
+
"description": "Whether ambient occlusion also attenuates direct lighting.",
|
|
503
|
+
"values": []
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"name": "occlude-specular",
|
|
507
|
+
"description": "How specular reflections are occluded.",
|
|
508
|
+
"values": [
|
|
509
|
+
{ "name": "none" },
|
|
510
|
+
{ "name": "ao" },
|
|
511
|
+
{ "name": "gloss-dependent" }
|
|
512
|
+
]
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "opacity",
|
|
516
|
+
"description": "The opacity of the material, which requires a `blend-type` other than `none` to have any visible effect.",
|
|
517
|
+
"values": []
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "opacity-dither",
|
|
521
|
+
"description": "The dithering used to render opacity.",
|
|
522
|
+
"values": [
|
|
523
|
+
{ "name": "none" },
|
|
524
|
+
{ "name": "bayer8" },
|
|
525
|
+
{ "name": "bluenoise" },
|
|
526
|
+
{ "name": "ignnoise" }
|
|
527
|
+
]
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "opacity-fades-specular",
|
|
531
|
+
"description": "Whether specular highlights fade out as the material becomes transparent.",
|
|
532
|
+
"values": []
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "opacity-map",
|
|
536
|
+
"description": "The id of the `pc-asset` used as the opacity map.",
|
|
537
|
+
"values": []
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "opacity-map-channel",
|
|
541
|
+
"description": "The color channel of the opacity map to sample.",
|
|
542
|
+
"values": [
|
|
543
|
+
{ "name": "r" },
|
|
544
|
+
{ "name": "g" },
|
|
545
|
+
{ "name": "b" },
|
|
546
|
+
{ "name": "a" }
|
|
547
|
+
]
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "opacity-map-offset",
|
|
551
|
+
"description": "The 2D offset of the opacity map. Accepts 2 space-separated numbers.",
|
|
552
|
+
"values": []
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "opacity-map-rotation",
|
|
556
|
+
"description": "The 2D rotation of the opacity map.",
|
|
557
|
+
"values": []
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "opacity-map-tiling",
|
|
561
|
+
"description": "The 2D tiling of the opacity map. Accepts 2 space-separated numbers.",
|
|
562
|
+
"values": []
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "opacity-map-uv",
|
|
566
|
+
"description": "The UV channel the opacity map samples.",
|
|
567
|
+
"values": []
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "roughness-map",
|
|
571
|
+
"description": "The id of the `pc-asset` to use as the roughness map. An alias for `gloss-map` that also inverts the gloss channel, so do not combine it with the `gloss` attributes.",
|
|
572
|
+
"values": []
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "slope-depth-bias",
|
|
576
|
+
"description": "The depth offset applied in proportion to a surface's slope.",
|
|
577
|
+
"values": []
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "specular",
|
|
581
|
+
"description": "The specular color of the material, which applies only when the metalness workflow is disabled or `use-metalness-specular-color` is enabled. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
582
|
+
"values": []
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "specularity-factor",
|
|
586
|
+
"description": "The strength of specular reflections at direct angles, which applies only when `use-metalness-specular-color` is enabled.",
|
|
587
|
+
"values": []
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
"name": "two-sided-lighting",
|
|
591
|
+
"description": "Whether back faces are lit as though their normals were flipped.",
|
|
592
|
+
"values": []
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
"name": "use-fog",
|
|
596
|
+
"description": "Whether the material is affected by scene fog.",
|
|
597
|
+
"values": []
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "use-lighting",
|
|
601
|
+
"description": "Whether the material is affected by scene lights.",
|
|
602
|
+
"values": []
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "use-metalness",
|
|
606
|
+
"description": "Whether to use the metalness workflow.",
|
|
607
|
+
"values": []
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"name": "use-metalness-specular-color",
|
|
611
|
+
"description": "Whether the specular color tints reflections while the metalness workflow is in use.",
|
|
612
|
+
"values": []
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "use-skybox",
|
|
616
|
+
"description": "Whether the material is lit by the scene's skybox.",
|
|
617
|
+
"values": []
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"name": "use-tonemap",
|
|
621
|
+
"description": "Whether the camera's tone mapping is applied to the material.",
|
|
622
|
+
"values": []
|
|
623
|
+
}
|
|
624
|
+
],
|
|
625
|
+
"references": []
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"name": "pc-model",
|
|
629
|
+
"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\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.",
|
|
630
|
+
"attributes": [
|
|
631
|
+
{
|
|
632
|
+
"name": "asset",
|
|
633
|
+
"description": "The id of the `pc-asset` to use for the model.",
|
|
634
|
+
"values": []
|
|
635
|
+
}
|
|
636
|
+
],
|
|
637
|
+
"references": []
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"name": "pc-module",
|
|
641
|
+
"description": "The ModuleElement interface provides properties and methods for manipulating\n[`<pc-module>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-module/) elements.\nThe ModuleElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nNote that these attributes are read once when the element is created, so changing them later\nhas no effect.\n\n---\n",
|
|
642
|
+
"attributes": [
|
|
643
|
+
{
|
|
644
|
+
"name": "fallback",
|
|
645
|
+
"description": "The URL of the module's asm.js fallback script, used when WebAssembly is unavailable.",
|
|
646
|
+
"values": []
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "glue",
|
|
650
|
+
"description": "The URL of the module's glue script.",
|
|
651
|
+
"values": []
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"name": "name",
|
|
655
|
+
"description": "The name of the WebAssembly module to configure, e.g. `Basis` or `Ammo`.",
|
|
656
|
+
"values": []
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "wasm",
|
|
660
|
+
"description": "The URL of the module's WebAssembly binary.",
|
|
661
|
+
"values": []
|
|
662
|
+
}
|
|
663
|
+
],
|
|
664
|
+
"references": []
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "pc-scene",
|
|
668
|
+
"description": "The SceneElement interface provides properties and methods for manipulating\n[`<pc-scene>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scene/) elements.\nThe SceneElement 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.",
|
|
669
|
+
"attributes": [
|
|
670
|
+
{
|
|
671
|
+
"name": "fog",
|
|
672
|
+
"description": "The fog type of the scene.",
|
|
673
|
+
"values": [
|
|
674
|
+
{ "name": "none" },
|
|
675
|
+
{ "name": "linear" },
|
|
676
|
+
{ "name": "exp" },
|
|
677
|
+
{ "name": "exp2" }
|
|
678
|
+
]
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "fog-color",
|
|
682
|
+
"description": "The fog color of the scene. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
683
|
+
"values": []
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
"name": "fog-density",
|
|
687
|
+
"description": "The fog density of the scene.",
|
|
688
|
+
"values": []
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "fog-end",
|
|
692
|
+
"description": "The fog end distance of the scene.",
|
|
693
|
+
"values": []
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
"name": "fog-start",
|
|
697
|
+
"description": "The fog start distance of the scene.",
|
|
698
|
+
"values": []
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"name": "gravity",
|
|
702
|
+
"description": "The gravity of the scene. Accepts 3 space-separated numbers.",
|
|
703
|
+
"values": []
|
|
704
|
+
}
|
|
705
|
+
],
|
|
706
|
+
"references": []
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"name": "pc-sky",
|
|
710
|
+
"description": "The SkyElement interface provides properties and methods for manipulating\n`<pc-sky>` elements. The SkyElement interface also inherits the properties and\nmethods of the HTMLElement 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.",
|
|
711
|
+
"attributes": [
|
|
712
|
+
{
|
|
713
|
+
"name": "asset",
|
|
714
|
+
"description": "The id of the `pc-asset` to use for the skybox.",
|
|
715
|
+
"values": []
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
"name": "center",
|
|
719
|
+
"description": "The center of the skybox. Accepts 3 space-separated numbers.",
|
|
720
|
+
"values": []
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "intensity",
|
|
724
|
+
"description": "The intensity of the skybox.",
|
|
725
|
+
"values": []
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "level",
|
|
729
|
+
"description": "The mip level of the skybox.",
|
|
730
|
+
"values": []
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"name": "lighting",
|
|
734
|
+
"description": "Whether the skybox is used as a light source.",
|
|
735
|
+
"values": []
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
"name": "rotation",
|
|
739
|
+
"description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers.",
|
|
740
|
+
"values": []
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"name": "scale",
|
|
744
|
+
"description": "The scale of the skybox. Accepts 3 space-separated numbers.",
|
|
745
|
+
"values": []
|
|
746
|
+
},
|
|
747
|
+
{
|
|
748
|
+
"name": "type",
|
|
749
|
+
"description": "The type of the skybox.",
|
|
750
|
+
"values": [
|
|
751
|
+
{ "name": "box" },
|
|
752
|
+
{ "name": "dome" },
|
|
753
|
+
{ "name": "infinite" },
|
|
754
|
+
{ "name": "none" }
|
|
755
|
+
]
|
|
756
|
+
}
|
|
757
|
+
],
|
|
758
|
+
"references": []
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
"name": "pc-button",
|
|
762
|
+
"description": "The ButtonComponentElement interface provides properties and methods for manipulating\n[`<pc-button>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-button/) elements.\nThe ButtonComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
763
|
+
"attributes": [
|
|
764
|
+
{
|
|
765
|
+
"name": "active",
|
|
766
|
+
"description": "Whether the button is active.",
|
|
767
|
+
"values": []
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
"name": "enabled",
|
|
771
|
+
"description": "The enabled state of the component.",
|
|
772
|
+
"values": []
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"name": "fade-duration",
|
|
776
|
+
"description": "The duration over which tint transitions are applied.",
|
|
777
|
+
"values": []
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"name": "hit-padding",
|
|
781
|
+
"description": "The padding used to expand the button's hit area. Accepts 4 space-separated numbers.",
|
|
782
|
+
"values": []
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "hover-sprite-asset",
|
|
786
|
+
"description": "The id of the `pc-asset` sprite shown when the button is hovered.",
|
|
787
|
+
"values": []
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"name": "hover-sprite-frame",
|
|
791
|
+
"description": "The frame of the hover sprite to show.",
|
|
792
|
+
"values": []
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "hover-tint",
|
|
796
|
+
"description": "The hover tint color. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
797
|
+
"values": []
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"name": "image",
|
|
801
|
+
"description": "The reference to the `<pc-entity>` whose image element is used for visual transitions.",
|
|
802
|
+
"values": []
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
"name": "inactive-sprite-asset",
|
|
806
|
+
"description": "The id of the `pc-asset` sprite shown when the button is inactive.",
|
|
807
|
+
"values": []
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "inactive-sprite-frame",
|
|
811
|
+
"description": "The frame of the inactive sprite to show.",
|
|
812
|
+
"values": []
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "inactive-tint",
|
|
816
|
+
"description": "The inactive tint color. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
817
|
+
"values": []
|
|
818
|
+
},
|
|
819
|
+
{
|
|
820
|
+
"name": "pressed-sprite-asset",
|
|
821
|
+
"description": "The id of the `pc-asset` sprite shown when the button is pressed.",
|
|
822
|
+
"values": []
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"name": "pressed-sprite-frame",
|
|
826
|
+
"description": "The frame of the pressed sprite to show.",
|
|
827
|
+
"values": []
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "pressed-tint",
|
|
831
|
+
"description": "The pressed tint color. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
832
|
+
"values": []
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"name": "transition-mode",
|
|
836
|
+
"description": "How the button reacts to being hovered/pressed.",
|
|
837
|
+
"values": [{ "name": "tint" }, { "name": "sprite" }]
|
|
838
|
+
}
|
|
839
|
+
],
|
|
840
|
+
"references": []
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "pc-camera",
|
|
844
|
+
"description": "The CameraComponentElement interface provides properties and methods for manipulating\n[`<pc-camera>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-camera/) elements.\nThe CameraComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n - **startXr(type: _'immersive-ar' | 'immersive-vr'_, space: _'bounded-floor' | 'local' | 'local-floor' | 'unbounded' | 'viewer'_)** - Starts the camera in XR mode.\n- **endXr()** - Ends the camera's XR mode.\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.",
|
|
845
|
+
"attributes": [
|
|
846
|
+
{
|
|
847
|
+
"name": "clear-color",
|
|
848
|
+
"description": "The clear color of the camera. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
849
|
+
"values": []
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"name": "clear-color-buffer",
|
|
853
|
+
"description": "The clear color buffer of the camera.",
|
|
854
|
+
"values": []
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "clear-depth-buffer",
|
|
858
|
+
"description": "The clear depth buffer of the camera.",
|
|
859
|
+
"values": []
|
|
860
|
+
},
|
|
861
|
+
{
|
|
862
|
+
"name": "clear-stencil-buffer",
|
|
863
|
+
"description": "The clear stencil buffer of the camera.",
|
|
864
|
+
"values": []
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "cull-faces",
|
|
868
|
+
"description": "The cull faces of the camera.",
|
|
869
|
+
"values": []
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"name": "enabled",
|
|
873
|
+
"description": "The enabled state of the component.",
|
|
874
|
+
"values": []
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "far-clip",
|
|
878
|
+
"description": "The far clip distance of the camera.",
|
|
879
|
+
"values": []
|
|
880
|
+
},
|
|
881
|
+
{
|
|
882
|
+
"name": "flip-faces",
|
|
883
|
+
"description": "The flip faces of the camera.",
|
|
884
|
+
"values": []
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"name": "fov",
|
|
888
|
+
"description": "The field of view of the camera.",
|
|
889
|
+
"values": []
|
|
890
|
+
},
|
|
891
|
+
{
|
|
892
|
+
"name": "frustum-culling",
|
|
893
|
+
"description": "The frustum culling of the camera.",
|
|
894
|
+
"values": []
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
"name": "gamma",
|
|
898
|
+
"description": "The gamma correction of the camera.",
|
|
899
|
+
"values": [{ "name": "linear" }, { "name": "srgb" }]
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"name": "horizontal-fov",
|
|
903
|
+
"description": "Whether the camera's field of view (fov) is horizontal or vertical.",
|
|
904
|
+
"values": []
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "near-clip",
|
|
908
|
+
"description": "The near clip distance of the camera.",
|
|
909
|
+
"values": []
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"name": "ortho-height",
|
|
913
|
+
"description": "The orthographic height of the camera.",
|
|
914
|
+
"values": []
|
|
915
|
+
},
|
|
916
|
+
{
|
|
917
|
+
"name": "orthographic",
|
|
918
|
+
"description": "The orthographic projection of the camera.",
|
|
919
|
+
"values": []
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"name": "priority",
|
|
923
|
+
"description": "The priority of the camera.",
|
|
924
|
+
"values": []
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "rect",
|
|
928
|
+
"description": "The rect of the camera. Accepts 4 space-separated numbers.",
|
|
929
|
+
"values": []
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "scissor-rect",
|
|
933
|
+
"description": "The scissor rect of the camera. Accepts 4 space-separated numbers.",
|
|
934
|
+
"values": []
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "tonemap",
|
|
938
|
+
"description": "The tone mapping of the camera.",
|
|
939
|
+
"values": [
|
|
940
|
+
{ "name": "none" },
|
|
941
|
+
{ "name": "linear" },
|
|
942
|
+
{ "name": "filmic" },
|
|
943
|
+
{ "name": "hejl" },
|
|
944
|
+
{ "name": "aces" },
|
|
945
|
+
{ "name": "aces2" },
|
|
946
|
+
{ "name": "neutral" }
|
|
947
|
+
]
|
|
948
|
+
}
|
|
949
|
+
],
|
|
950
|
+
"references": []
|
|
951
|
+
},
|
|
952
|
+
{
|
|
953
|
+
"name": "pc-collision",
|
|
954
|
+
"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\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.",
|
|
955
|
+
"attributes": [
|
|
956
|
+
{
|
|
957
|
+
"name": "angular-offset",
|
|
958
|
+
"description": "Accepts 3 space-separated Euler angles in degrees.",
|
|
959
|
+
"values": []
|
|
960
|
+
},
|
|
961
|
+
{ "name": "axis", "values": [] },
|
|
962
|
+
{ "name": "convex-hull", "values": [] },
|
|
963
|
+
{
|
|
964
|
+
"name": "enabled",
|
|
965
|
+
"description": "The enabled state of the component.",
|
|
966
|
+
"values": []
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "half-extents",
|
|
970
|
+
"description": "Accepts 3 space-separated numbers.",
|
|
971
|
+
"values": []
|
|
972
|
+
},
|
|
973
|
+
{ "name": "height", "values": [] },
|
|
974
|
+
{
|
|
975
|
+
"name": "linear-offset",
|
|
976
|
+
"description": "Accepts 3 space-separated numbers.",
|
|
977
|
+
"values": []
|
|
978
|
+
},
|
|
979
|
+
{ "name": "radius", "values": [] },
|
|
980
|
+
{
|
|
981
|
+
"name": "type",
|
|
982
|
+
"values": [
|
|
983
|
+
{ "name": "box" },
|
|
984
|
+
{ "name": "capsule" },
|
|
985
|
+
{ "name": "compound" },
|
|
986
|
+
{ "name": "cone" },
|
|
987
|
+
{ "name": "cylinder" },
|
|
988
|
+
{ "name": "mesh" },
|
|
989
|
+
{ "name": "sphere" }
|
|
990
|
+
]
|
|
991
|
+
}
|
|
992
|
+
],
|
|
993
|
+
"references": []
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
"name": "pc-element",
|
|
997
|
+
"description": "The ElementComponentElement interface provides properties and methods for manipulating\n[`<pc-element>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-element/) elements.\nThe ElementComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
998
|
+
"attributes": [
|
|
999
|
+
{
|
|
1000
|
+
"name": "anchor",
|
|
1001
|
+
"description": "The anchor of the element component. Accepts 4 space-separated numbers.",
|
|
1002
|
+
"values": []
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "auto-fit-height",
|
|
1006
|
+
"description": "Whether a text element automatically reduces its font size to fit its height.",
|
|
1007
|
+
"values": []
|
|
1008
|
+
},
|
|
1009
|
+
{
|
|
1010
|
+
"name": "auto-fit-width",
|
|
1011
|
+
"description": "Whether a text element automatically reduces its font size to fit its width.",
|
|
1012
|
+
"values": []
|
|
1013
|
+
},
|
|
1014
|
+
{
|
|
1015
|
+
"name": "auto-height",
|
|
1016
|
+
"description": "Whether the element component should automatically adjust its height.",
|
|
1017
|
+
"values": []
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"name": "auto-width",
|
|
1021
|
+
"description": "Whether the element component should automatically adjust its width.",
|
|
1022
|
+
"values": []
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"name": "color",
|
|
1026
|
+
"description": "The color of the element component. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
1027
|
+
"values": []
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"name": "enable-markup",
|
|
1031
|
+
"description": "Whether the element component should use markup.",
|
|
1032
|
+
"values": []
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "enabled",
|
|
1036
|
+
"description": "The enabled state of the component.",
|
|
1037
|
+
"values": []
|
|
1038
|
+
},
|
|
1039
|
+
{
|
|
1040
|
+
"name": "font-asset",
|
|
1041
|
+
"description": "The id of the `pc-asset` to use for the font.",
|
|
1042
|
+
"values": []
|
|
1043
|
+
},
|
|
1044
|
+
{
|
|
1045
|
+
"name": "font-size",
|
|
1046
|
+
"description": "The font size of the element component.",
|
|
1047
|
+
"values": []
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
"name": "height",
|
|
1051
|
+
"description": "The height of the element component.",
|
|
1052
|
+
"values": []
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "line-height",
|
|
1056
|
+
"description": "The line height of the element component.",
|
|
1057
|
+
"values": []
|
|
1058
|
+
},
|
|
1059
|
+
{
|
|
1060
|
+
"name": "margin",
|
|
1061
|
+
"description": "The margin of the element component. Accepts 4 space-separated numbers.",
|
|
1062
|
+
"values": []
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "mask",
|
|
1066
|
+
"description": "Whether the element component is a mask.",
|
|
1067
|
+
"values": []
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"name": "max-font-size",
|
|
1071
|
+
"description": "The largest font size a text element may use when auto-fitting.",
|
|
1072
|
+
"values": []
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "min-font-size",
|
|
1076
|
+
"description": "The smallest font size a text element may use when auto-fitting.",
|
|
1077
|
+
"values": []
|
|
1078
|
+
},
|
|
1079
|
+
{
|
|
1080
|
+
"name": "opacity",
|
|
1081
|
+
"description": "The opacity of the element component.",
|
|
1082
|
+
"values": []
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"name": "pivot",
|
|
1086
|
+
"description": "The pivot of the element component. Accepts 2 space-separated numbers.",
|
|
1087
|
+
"values": []
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
"name": "pixels-per-unit",
|
|
1091
|
+
"description": "The number of pixels per unit used when rendering a sprite.",
|
|
1092
|
+
"values": []
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "sprite-asset",
|
|
1096
|
+
"description": "The id of the `pc-asset` to use for the sprite.",
|
|
1097
|
+
"values": []
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "sprite-frame",
|
|
1101
|
+
"description": "The frame of the sprite to render.",
|
|
1102
|
+
"values": []
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"name": "text",
|
|
1106
|
+
"description": "The text of the element component.",
|
|
1107
|
+
"values": []
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
"name": "texture-asset",
|
|
1111
|
+
"description": "The id of the `pc-asset` to use for the texture.",
|
|
1112
|
+
"values": []
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
"name": "type",
|
|
1116
|
+
"description": "The type of the element component.",
|
|
1117
|
+
"values": [
|
|
1118
|
+
{ "name": "group" },
|
|
1119
|
+
{ "name": "image" },
|
|
1120
|
+
{ "name": "text" }
|
|
1121
|
+
]
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "use-input",
|
|
1125
|
+
"description": "Whether the element component accepts input events.",
|
|
1126
|
+
"values": []
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"name": "width",
|
|
1130
|
+
"description": "The width of the element component.",
|
|
1131
|
+
"values": []
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"name": "wrap-lines",
|
|
1135
|
+
"description": "Whether the element component should wrap lines.",
|
|
1136
|
+
"values": []
|
|
1137
|
+
}
|
|
1138
|
+
],
|
|
1139
|
+
"references": []
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "pc-gsplat",
|
|
1143
|
+
"description": "The GSplatComponentElement interface provides properties and methods for manipulating\n[`<pc-gsplat>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-gsplat/) elements.\nThe GSplatComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
1144
|
+
"attributes": [
|
|
1145
|
+
{
|
|
1146
|
+
"name": "asset",
|
|
1147
|
+
"description": "The id of the `pc-asset` to use for the splat.",
|
|
1148
|
+
"values": []
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "cast-shadows",
|
|
1152
|
+
"description": "Whether the splat casts shadows.",
|
|
1153
|
+
"values": []
|
|
1154
|
+
},
|
|
1155
|
+
{
|
|
1156
|
+
"name": "enabled",
|
|
1157
|
+
"description": "The enabled state of the component.",
|
|
1158
|
+
"values": []
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "lod-base-distance",
|
|
1162
|
+
"description": "The base distance for the first LOD transition.",
|
|
1163
|
+
"values": []
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"name": "lod-multiplier",
|
|
1167
|
+
"description": "The multiplier between successive LOD distance thresholds.",
|
|
1168
|
+
"values": []
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"name": "lod-range-max",
|
|
1172
|
+
"description": "The maximum allowed LOD index.",
|
|
1173
|
+
"values": []
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"name": "lod-range-min",
|
|
1177
|
+
"description": "The minimum allowed LOD index.",
|
|
1178
|
+
"values": []
|
|
1179
|
+
}
|
|
1180
|
+
],
|
|
1181
|
+
"references": []
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
"name": "pc-layoutchild",
|
|
1185
|
+
"description": "The LayoutChildComponentElement interface provides properties and methods for manipulating\n[`<pc-layoutchild>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-layoutchild/) elements.\nThe LayoutChildComponentElement 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.",
|
|
1186
|
+
"attributes": [
|
|
1187
|
+
{
|
|
1188
|
+
"name": "enabled",
|
|
1189
|
+
"description": "The enabled state of the component.",
|
|
1190
|
+
"values": []
|
|
1191
|
+
},
|
|
1192
|
+
{
|
|
1193
|
+
"name": "exclude-from-layout",
|
|
1194
|
+
"description": "Whether the element is excluded from the layout.",
|
|
1195
|
+
"values": []
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "fit-height-proportion",
|
|
1199
|
+
"description": "The proportion of the container's spare height this element should take.",
|
|
1200
|
+
"values": []
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "fit-width-proportion",
|
|
1204
|
+
"description": "The proportion of the container's spare width this element should take.",
|
|
1205
|
+
"values": []
|
|
1206
|
+
},
|
|
1207
|
+
{
|
|
1208
|
+
"name": "max-height",
|
|
1209
|
+
"description": "The maximum height the element should be laid out with.",
|
|
1210
|
+
"values": []
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"name": "max-width",
|
|
1214
|
+
"description": "The maximum width the element should be laid out with.",
|
|
1215
|
+
"values": []
|
|
1216
|
+
},
|
|
1217
|
+
{
|
|
1218
|
+
"name": "min-height",
|
|
1219
|
+
"description": "The minimum height the element should be laid out with.",
|
|
1220
|
+
"values": []
|
|
1221
|
+
},
|
|
1222
|
+
{
|
|
1223
|
+
"name": "min-width",
|
|
1224
|
+
"description": "The minimum width the element should be laid out with.",
|
|
1225
|
+
"values": []
|
|
1226
|
+
}
|
|
1227
|
+
],
|
|
1228
|
+
"references": []
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"name": "pc-layoutgroup",
|
|
1232
|
+
"description": "The LayoutGroupComponentElement interface provides properties and methods for manipulating\n[`<pc-layoutgroup>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-layoutgroup/) elements.\nThe LayoutGroupComponentElement 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.",
|
|
1233
|
+
"attributes": [
|
|
1234
|
+
{
|
|
1235
|
+
"name": "alignment",
|
|
1236
|
+
"description": "The alignment of the child elements. Accepts 2 space-separated numbers.",
|
|
1237
|
+
"values": []
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
"name": "enabled",
|
|
1241
|
+
"description": "The enabled state of the component.",
|
|
1242
|
+
"values": []
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
"name": "height-fitting",
|
|
1246
|
+
"description": "The fitting mode along the vertical axis.",
|
|
1247
|
+
"values": [
|
|
1248
|
+
{ "name": "none" },
|
|
1249
|
+
{ "name": "stretch" },
|
|
1250
|
+
{ "name": "shrink" },
|
|
1251
|
+
{ "name": "both" }
|
|
1252
|
+
]
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "orientation",
|
|
1256
|
+
"description": "The orientation of the layout group.",
|
|
1257
|
+
"values": [{ "name": "horizontal" }, { "name": "vertical" }]
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"name": "padding",
|
|
1261
|
+
"description": "The padding around the layout group. Accepts 4 space-separated numbers.",
|
|
1262
|
+
"values": []
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"name": "reverse-x",
|
|
1266
|
+
"description": "Whether the order of children is reversed along the horizontal axis.",
|
|
1267
|
+
"values": []
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"name": "reverse-y",
|
|
1271
|
+
"description": "Whether the order of children is reversed along the vertical axis.",
|
|
1272
|
+
"values": []
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"name": "spacing",
|
|
1276
|
+
"description": "The spacing between child elements. Accepts 2 space-separated numbers.",
|
|
1277
|
+
"values": []
|
|
1278
|
+
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "width-fitting",
|
|
1281
|
+
"description": "The fitting mode along the horizontal axis.",
|
|
1282
|
+
"values": [
|
|
1283
|
+
{ "name": "none" },
|
|
1284
|
+
{ "name": "stretch" },
|
|
1285
|
+
{ "name": "shrink" },
|
|
1286
|
+
{ "name": "both" }
|
|
1287
|
+
]
|
|
1288
|
+
},
|
|
1289
|
+
{
|
|
1290
|
+
"name": "wrap",
|
|
1291
|
+
"description": "Whether children wrap onto a new line/column when they overflow the group.",
|
|
1292
|
+
"values": []
|
|
1293
|
+
}
|
|
1294
|
+
],
|
|
1295
|
+
"references": []
|
|
1296
|
+
},
|
|
1297
|
+
{
|
|
1298
|
+
"name": "pc-light",
|
|
1299
|
+
"description": "The LightComponentElement interface provides properties and methods for manipulating\n[`<pc-light>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/) elements.\nThe LightComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
1300
|
+
"attributes": [
|
|
1301
|
+
{
|
|
1302
|
+
"name": "cast-shadows",
|
|
1303
|
+
"description": "The cast shadows flag of the light.",
|
|
1304
|
+
"values": []
|
|
1305
|
+
},
|
|
1306
|
+
{
|
|
1307
|
+
"name": "color",
|
|
1308
|
+
"description": "The color of the light. Accepts a CSS color name, a hex color, or 3 or 4 space-separated numbers in the range 0 to 1.",
|
|
1309
|
+
"values": []
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"name": "enabled",
|
|
1313
|
+
"description": "The enabled state of the component.",
|
|
1314
|
+
"values": []
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "inner-cone-angle",
|
|
1318
|
+
"description": "The inner cone angle of the light.",
|
|
1319
|
+
"values": []
|
|
1320
|
+
},
|
|
1321
|
+
{
|
|
1322
|
+
"name": "intensity",
|
|
1323
|
+
"description": "The intensity of the light.",
|
|
1324
|
+
"values": []
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"name": "normal-offset-bias",
|
|
1328
|
+
"description": "The normal offset bias of the light.",
|
|
1329
|
+
"values": []
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "outer-cone-angle",
|
|
1333
|
+
"description": "The outer cone angle of the light.",
|
|
1334
|
+
"values": []
|
|
1335
|
+
},
|
|
1336
|
+
{
|
|
1337
|
+
"name": "penumbra-falloff",
|
|
1338
|
+
"description": "The penumbra falloff of the light.",
|
|
1339
|
+
"values": []
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"name": "penumbra-size",
|
|
1343
|
+
"description": "The penumbra size of the light.",
|
|
1344
|
+
"values": []
|
|
1345
|
+
},
|
|
1346
|
+
{
|
|
1347
|
+
"name": "range",
|
|
1348
|
+
"description": "The range of the light.",
|
|
1349
|
+
"values": []
|
|
1350
|
+
},
|
|
1351
|
+
{
|
|
1352
|
+
"name": "shadow-bias",
|
|
1353
|
+
"description": "The shadow bias of the light.",
|
|
1354
|
+
"values": []
|
|
1355
|
+
},
|
|
1356
|
+
{
|
|
1357
|
+
"name": "shadow-blocker-samples",
|
|
1358
|
+
"description": "The number of shadow blocker samples.",
|
|
1359
|
+
"values": []
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"name": "shadow-distance",
|
|
1363
|
+
"description": "The shadow distance of the light.",
|
|
1364
|
+
"values": []
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
"name": "shadow-intensity",
|
|
1368
|
+
"description": "The shadow intensity of the light.",
|
|
1369
|
+
"values": []
|
|
1370
|
+
},
|
|
1371
|
+
{
|
|
1372
|
+
"name": "shadow-resolution",
|
|
1373
|
+
"description": "The shadow resolution of the light.",
|
|
1374
|
+
"values": []
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "shadow-samples",
|
|
1378
|
+
"description": "The number of shadow samples.",
|
|
1379
|
+
"values": []
|
|
1380
|
+
},
|
|
1381
|
+
{
|
|
1382
|
+
"name": "shadow-type",
|
|
1383
|
+
"description": "The shadow type of the light.",
|
|
1384
|
+
"values": [
|
|
1385
|
+
{ "name": "pcf1-16f" },
|
|
1386
|
+
{ "name": "pcf1-32f" },
|
|
1387
|
+
{ "name": "pcf3-16f" },
|
|
1388
|
+
{ "name": "pcf3-32f" },
|
|
1389
|
+
{ "name": "pcf5-16f" },
|
|
1390
|
+
{ "name": "pcf5-32f" },
|
|
1391
|
+
{ "name": "vsm-16f" },
|
|
1392
|
+
{ "name": "vsm-32f" },
|
|
1393
|
+
{ "name": "pcss-32f" }
|
|
1394
|
+
]
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"name": "type",
|
|
1398
|
+
"description": "The type of the light.",
|
|
1399
|
+
"values": [
|
|
1400
|
+
{ "name": "directional" },
|
|
1401
|
+
{ "name": "omni" },
|
|
1402
|
+
{ "name": "spot" }
|
|
1403
|
+
]
|
|
1404
|
+
},
|
|
1405
|
+
{
|
|
1406
|
+
"name": "vsm-bias",
|
|
1407
|
+
"description": "The VSM bias of the light.",
|
|
1408
|
+
"values": []
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
"name": "vsm-blur-size",
|
|
1412
|
+
"description": "The VSM blur size of the light.",
|
|
1413
|
+
"values": []
|
|
1414
|
+
}
|
|
1415
|
+
],
|
|
1416
|
+
"references": []
|
|
1417
|
+
},
|
|
1418
|
+
{
|
|
1419
|
+
"name": "pc-listener",
|
|
1420
|
+
"description": "The ListenerComponentElement interface provides properties and methods for manipulating\n[`<pc-listener>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-listener/) elements.\nThe ListenerComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
1421
|
+
"attributes": [
|
|
1422
|
+
{
|
|
1423
|
+
"name": "enabled",
|
|
1424
|
+
"description": "The enabled state of the component.",
|
|
1425
|
+
"values": []
|
|
1426
|
+
}
|
|
1427
|
+
],
|
|
1428
|
+
"references": []
|
|
1429
|
+
},
|
|
1430
|
+
{
|
|
1431
|
+
"name": "pc-particles",
|
|
1432
|
+
"description": "The ParticleSystemComponentElement interface provides properties and methods for manipulating\n[`<pc-particles>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-particles/) elements.\nThe ParticleSystemComponentElement 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 - **play()** - Starts playing the particle system\n- **pause()** - Pauses the particle system\n- **reset()** - Resets the particle system\n- **stop()** - Stops the particle system\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.",
|
|
1433
|
+
"attributes": [
|
|
1434
|
+
{
|
|
1435
|
+
"name": "asset",
|
|
1436
|
+
"description": "The id of the `pc-asset` to use for the model.",
|
|
1437
|
+
"values": []
|
|
1438
|
+
},
|
|
1439
|
+
{
|
|
1440
|
+
"name": "enabled",
|
|
1441
|
+
"description": "The enabled state of the component.",
|
|
1442
|
+
"values": []
|
|
1443
|
+
}
|
|
1444
|
+
],
|
|
1445
|
+
"references": []
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
"name": "pc-render",
|
|
1449
|
+
"description": "The RenderComponentElement interface provides properties and methods for manipulating\n[`<pc-render>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/) elements.\nThe RenderComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThis element renders one of the engine's built-in primitives, selected with `type` (defaulting\nto `box`). It does not cover the engine's `asset` render type, since there is no way to supply\na render asset here — use `pc-model` for glTF content instead.\n\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.",
|
|
1450
|
+
"attributes": [
|
|
1451
|
+
{
|
|
1452
|
+
"name": "cast-shadows",
|
|
1453
|
+
"description": "The cast shadows flag of the render component.",
|
|
1454
|
+
"values": []
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"name": "enabled",
|
|
1458
|
+
"description": "The enabled state of the component.",
|
|
1459
|
+
"values": []
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "material",
|
|
1463
|
+
"description": "The id of the material asset used by the render component.",
|
|
1464
|
+
"values": []
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
"name": "receive-shadows",
|
|
1468
|
+
"description": "The receive shadows flag of the render component.",
|
|
1469
|
+
"values": []
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
"name": "type",
|
|
1473
|
+
"description": "The type of the render component.",
|
|
1474
|
+
"values": [
|
|
1475
|
+
{ "name": "box" },
|
|
1476
|
+
{ "name": "capsule" },
|
|
1477
|
+
{ "name": "cone" },
|
|
1478
|
+
{ "name": "cylinder" },
|
|
1479
|
+
{ "name": "plane" },
|
|
1480
|
+
{ "name": "sphere" }
|
|
1481
|
+
]
|
|
1482
|
+
}
|
|
1483
|
+
],
|
|
1484
|
+
"references": []
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"name": "pc-rigidbody",
|
|
1488
|
+
"description": "The RigidBodyComponentElement interface provides properties and methods for manipulating\n[`<pc-rigidbody>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-rigidbody/) elements.\nThe RigidBodyComponentElement 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.",
|
|
1489
|
+
"attributes": [
|
|
1490
|
+
{ "name": "angular-damping", "values": [] },
|
|
1491
|
+
{
|
|
1492
|
+
"name": "angular-factor",
|
|
1493
|
+
"description": "Accepts 3 space-separated numbers.",
|
|
1494
|
+
"values": []
|
|
1495
|
+
},
|
|
1496
|
+
{
|
|
1497
|
+
"name": "enabled",
|
|
1498
|
+
"description": "The enabled state of the component.",
|
|
1499
|
+
"values": []
|
|
1500
|
+
},
|
|
1501
|
+
{ "name": "friction", "values": [] },
|
|
1502
|
+
{ "name": "linear-damping", "values": [] },
|
|
1503
|
+
{
|
|
1504
|
+
"name": "linear-factor",
|
|
1505
|
+
"description": "Accepts 3 space-separated numbers.",
|
|
1506
|
+
"values": []
|
|
1507
|
+
},
|
|
1508
|
+
{ "name": "mass", "values": [] },
|
|
1509
|
+
{ "name": "restitution", "values": [] },
|
|
1510
|
+
{ "name": "rolling-friction", "values": [] },
|
|
1511
|
+
{
|
|
1512
|
+
"name": "type",
|
|
1513
|
+
"values": [
|
|
1514
|
+
{ "name": "static" },
|
|
1515
|
+
{ "name": "dynamic" },
|
|
1516
|
+
{ "name": "kinematic" }
|
|
1517
|
+
]
|
|
1518
|
+
}
|
|
1519
|
+
],
|
|
1520
|
+
"references": []
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "pc-screen",
|
|
1524
|
+
"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.",
|
|
1525
|
+
"attributes": [
|
|
1526
|
+
{ "name": "blend", "values": [] },
|
|
1527
|
+
{
|
|
1528
|
+
"name": "enabled",
|
|
1529
|
+
"description": "The enabled state of the component.",
|
|
1530
|
+
"values": []
|
|
1531
|
+
},
|
|
1532
|
+
{ "name": "priority", "values": [] },
|
|
1533
|
+
{
|
|
1534
|
+
"name": "reference-resolution",
|
|
1535
|
+
"description": "Accepts 2 space-separated numbers.",
|
|
1536
|
+
"values": []
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
"name": "resolution",
|
|
1540
|
+
"description": "Accepts 2 space-separated numbers.",
|
|
1541
|
+
"values": []
|
|
1542
|
+
},
|
|
1543
|
+
{ "name": "scale-blend", "values": [] },
|
|
1544
|
+
{ "name": "screen-space", "values": [] }
|
|
1545
|
+
],
|
|
1546
|
+
"references": []
|
|
1547
|
+
},
|
|
1548
|
+
{
|
|
1549
|
+
"name": "pc-scripts",
|
|
1550
|
+
"description": "The ScriptComponentElement interface provides properties and methods for manipulating\n[`<pc-scripts>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scripts/) elements.\nThe ScriptComponentElement 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.",
|
|
1551
|
+
"attributes": [
|
|
1552
|
+
{
|
|
1553
|
+
"name": "enabled",
|
|
1554
|
+
"description": "The enabled state of the component.",
|
|
1555
|
+
"values": []
|
|
1556
|
+
}
|
|
1557
|
+
],
|
|
1558
|
+
"references": []
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
"name": "pc-script",
|
|
1562
|
+
"description": "The ScriptElement interface provides properties and methods for manipulating\n`<pc-script>` elements. The ScriptElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n\nScript attributes can be supplied through two channels:\n\n- **Per-property attributes**: any non-reserved attribute on the element maps to the script\n attribute of the same name (kebab-case to camelCase, e.g. `focus-point` → `focusPoint`).\n Values are parsed according to the type of the attribute's current value — initially the\n script's declared default (numbers, booleans, strings, Vec2/3/4, Color, Quat as Euler\n angles) — and the `asset:`/`entity:`/`vec2:`/`vec3:`/`vec4:`/`color:` prefixes may be used\n to be explicit.\n- **The `attributes` JSON attribute**: an object supporting nested structures and attribute\n names that collide with reserved HTML attribute names (e.g. `title`).\n\nWhen both specify the same attribute, the per-property attribute wins — at creation and\nwhenever either channel changes at runtime. The element's own `name` and `enabled`\nattributes configure the element itself and are not script attributes.\n\nChanging `name` on a live element destroys the old-name script instance and creates the\nnew-name one, re-applying both attribute channels to it.\n\nThe element becomes ready once its script instance has been created by the parent\n`<pc-scripts>` element.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n- **scriptattributeschange** - Fired when the script's attributes change. The `detail` carries the new `attributes` object. Bubbles.\n- **scriptenablechange** - Fired when the script's enabled state changes. The `detail` carries the new `enabled` state. Bubbles.\n- **scriptnamechange** - Fired when the script is renamed on a live element. The `detail` carries `oldName` and `newName`. Bubbles.\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.",
|
|
1563
|
+
"attributes": [
|
|
1564
|
+
{
|
|
1565
|
+
"name": "attributes",
|
|
1566
|
+
"description": "The attributes of the script.",
|
|
1567
|
+
"values": []
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"name": "enabled",
|
|
1571
|
+
"description": "The enabled state of the script.",
|
|
1572
|
+
"values": []
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "name",
|
|
1576
|
+
"description": "The name of the script.",
|
|
1577
|
+
"values": []
|
|
1578
|
+
}
|
|
1579
|
+
],
|
|
1580
|
+
"references": []
|
|
1581
|
+
},
|
|
1582
|
+
{
|
|
1583
|
+
"name": "pc-scrollbar",
|
|
1584
|
+
"description": "The ScrollbarComponentElement interface provides properties and methods for manipulating\n[`<pc-scrollbar>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollbar/) elements.\nThe ScrollbarComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\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.",
|
|
1585
|
+
"attributes": [
|
|
1586
|
+
{
|
|
1587
|
+
"name": "enabled",
|
|
1588
|
+
"description": "The enabled state of the component.",
|
|
1589
|
+
"values": []
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"name": "handle",
|
|
1593
|
+
"description": "The reference to the `<pc-entity>` used as the scrollbar handle.",
|
|
1594
|
+
"values": []
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"name": "handle-size",
|
|
1598
|
+
"description": "The size of the handle relative to the size of the track.",
|
|
1599
|
+
"values": []
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"name": "orientation",
|
|
1603
|
+
"description": "The orientation of the scrollbar.",
|
|
1604
|
+
"values": [{ "name": "horizontal" }, { "name": "vertical" }]
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"name": "value",
|
|
1608
|
+
"description": "The current position value of the scrollbar.",
|
|
1609
|
+
"values": []
|
|
1610
|
+
}
|
|
1611
|
+
],
|
|
1612
|
+
"references": []
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"name": "pc-scrollview",
|
|
1616
|
+
"description": "The ScrollViewComponentElement interface provides properties and methods for manipulating\n[`<pc-scrollview>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-scrollview/) elements.\nThe ScrollViewComponentElement 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.",
|
|
1617
|
+
"attributes": [
|
|
1618
|
+
{
|
|
1619
|
+
"name": "bounce-amount",
|
|
1620
|
+
"description": "The bounce amount.",
|
|
1621
|
+
"values": []
|
|
1622
|
+
},
|
|
1623
|
+
{
|
|
1624
|
+
"name": "content",
|
|
1625
|
+
"description": "The reference to the `<pc-entity>` used as the content.",
|
|
1626
|
+
"values": []
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"name": "enabled",
|
|
1630
|
+
"description": "The enabled state of the component.",
|
|
1631
|
+
"values": []
|
|
1632
|
+
},
|
|
1633
|
+
{ "name": "friction", "description": "The friction.", "values": [] },
|
|
1634
|
+
{
|
|
1635
|
+
"name": "horizontal",
|
|
1636
|
+
"description": "Whether horizontal scrolling is enabled.",
|
|
1637
|
+
"values": []
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
"name": "horizontal-scrollbar",
|
|
1641
|
+
"description": "The reference to the `<pc-entity>` containing the horizontal scrollbar.",
|
|
1642
|
+
"values": []
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"name": "horizontal-scrollbar-visibility",
|
|
1646
|
+
"description": "The visibility of the horizontal scrollbar.",
|
|
1647
|
+
"values": [{ "name": "always" }, { "name": "when-required" }]
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
"name": "mouse-wheel-sensitivity",
|
|
1651
|
+
"description": "The mouse wheel sensitivity. Accepts 2 space-separated numbers.",
|
|
1652
|
+
"values": []
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"name": "scroll-mode",
|
|
1656
|
+
"description": "How the scroll view behaves when the content is scrolled beyond its bounds.",
|
|
1657
|
+
"values": [
|
|
1658
|
+
{ "name": "clamp" },
|
|
1659
|
+
{ "name": "bounce" },
|
|
1660
|
+
{ "name": "infinite" }
|
|
1661
|
+
]
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
"name": "use-mouse-wheel",
|
|
1665
|
+
"description": "Whether the scroll view responds to mouse wheel events.",
|
|
1666
|
+
"values": []
|
|
1667
|
+
},
|
|
1668
|
+
{
|
|
1669
|
+
"name": "vertical",
|
|
1670
|
+
"description": "Whether vertical scrolling is enabled.",
|
|
1671
|
+
"values": []
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "vertical-scrollbar",
|
|
1675
|
+
"description": "The reference to the `<pc-entity>` containing the vertical scrollbar.",
|
|
1676
|
+
"values": []
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"name": "vertical-scrollbar-visibility",
|
|
1680
|
+
"description": "The visibility of the vertical scrollbar.",
|
|
1681
|
+
"values": [{ "name": "always" }, { "name": "when-required" }]
|
|
1682
|
+
},
|
|
1683
|
+
{
|
|
1684
|
+
"name": "viewport",
|
|
1685
|
+
"description": "The reference to the `<pc-entity>` used as the viewport.",
|
|
1686
|
+
"values": []
|
|
1687
|
+
}
|
|
1688
|
+
],
|
|
1689
|
+
"references": []
|
|
1690
|
+
},
|
|
1691
|
+
{
|
|
1692
|
+
"name": "pc-sounds",
|
|
1693
|
+
"description": "The SoundComponentElement interface provides properties and methods for manipulating\n[`<pc-sounds>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-sounds/) elements.\nThe SoundComponentElement 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.",
|
|
1694
|
+
"attributes": [
|
|
1695
|
+
{
|
|
1696
|
+
"name": "distance-model",
|
|
1697
|
+
"description": "Which algorithm to use to reduce the volume of the sound as it moves away from the listener.",
|
|
1698
|
+
"values": [
|
|
1699
|
+
{ "name": "exponential" },
|
|
1700
|
+
{ "name": "inverse" },
|
|
1701
|
+
{ "name": "linear" }
|
|
1702
|
+
]
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "enabled",
|
|
1706
|
+
"description": "The enabled state of the component.",
|
|
1707
|
+
"values": []
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "max-distance",
|
|
1711
|
+
"description": "The maximum distance from the listener at which audio falloff stops.",
|
|
1712
|
+
"values": []
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"name": "pitch",
|
|
1716
|
+
"description": "The pitch of the sound.",
|
|
1717
|
+
"values": []
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
"name": "positional",
|
|
1721
|
+
"description": "The positional flag of the sound.",
|
|
1722
|
+
"values": []
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"name": "ref-distance",
|
|
1726
|
+
"description": "The reference distance for reducing volume as the sound source moves further from the listener.",
|
|
1727
|
+
"values": []
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
"name": "roll-off-factor",
|
|
1731
|
+
"description": "The factor used in the falloff equation.",
|
|
1732
|
+
"values": []
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "volume",
|
|
1736
|
+
"description": "The volume of the sound.",
|
|
1737
|
+
"values": []
|
|
1738
|
+
}
|
|
1739
|
+
],
|
|
1740
|
+
"references": []
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"name": "pc-sound",
|
|
1744
|
+
"description": "The SoundSlotElement interface provides properties and methods for manipulating\n`<pc-sound>` elements. The SoundSlotElement interface also inherits the properties and\nmethods of the AsyncElement interface.\n\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.",
|
|
1745
|
+
"attributes": [
|
|
1746
|
+
{
|
|
1747
|
+
"name": "asset",
|
|
1748
|
+
"description": "The id of the `pc-asset` to use for the sound slot.",
|
|
1749
|
+
"values": []
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "auto-play",
|
|
1753
|
+
"description": "The auto play flag of the sound slot.",
|
|
1754
|
+
"values": []
|
|
1755
|
+
},
|
|
1756
|
+
{
|
|
1757
|
+
"name": "duration",
|
|
1758
|
+
"description": "The duration of the sound slot.",
|
|
1759
|
+
"values": []
|
|
1760
|
+
},
|
|
1761
|
+
{
|
|
1762
|
+
"name": "loop",
|
|
1763
|
+
"description": "The loop flag of the sound slot.",
|
|
1764
|
+
"values": []
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "name",
|
|
1768
|
+
"description": "The name of the sound slot.",
|
|
1769
|
+
"values": []
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
"name": "overlap",
|
|
1773
|
+
"description": "The overlap flag of the sound slot.",
|
|
1774
|
+
"values": []
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "pitch",
|
|
1778
|
+
"description": "The pitch of the sound slot.",
|
|
1779
|
+
"values": []
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"name": "start-time",
|
|
1783
|
+
"description": "The start time of the sound slot.",
|
|
1784
|
+
"values": []
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"name": "volume",
|
|
1788
|
+
"description": "The volume of the sound slot.",
|
|
1789
|
+
"values": []
|
|
1790
|
+
}
|
|
1791
|
+
],
|
|
1792
|
+
"references": []
|
|
1793
|
+
}
|
|
1794
|
+
]
|
|
1795
|
+
}
|