@dcl/js-runtime 7.5.3-9489675536.commit-34d22e9 → 7.5.3

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/apis.d.ts ADDED
@@ -0,0 +1,1616 @@
1
+
2
+ /**
3
+ * CommsApi
4
+ */
5
+ declare module "~system/CommsApi" {
6
+
7
+ export enum VideoTrackSourceType {
8
+ VTST_UNKNOWN = 0,
9
+ VTST_CAMERA = 1,
10
+ VTST_SCREEN_SHARE = 2,
11
+ UNRECOGNIZED = -1
12
+ }
13
+ export interface VideoTracksActiveStreamsRequest {
14
+ }
15
+ export interface VideoTracksActiveStreamsResponse {
16
+ streams: VideoTracksActiveStreamsData[];
17
+ }
18
+ export interface VideoTracksActiveStreamsData {
19
+ identity: string;
20
+ trackSid: string;
21
+ sourceType: VideoTrackSourceType;
22
+ }
23
+
24
+ // Function declaration section
25
+ export function getActiveVideoStreams(body: VideoTracksActiveStreamsRequest): Promise<VideoTracksActiveStreamsResponse>;
26
+
27
+ }
28
+ /**
29
+ * CommunicationsController
30
+ */
31
+ declare module "~system/CommunicationsController" {
32
+
33
+ export interface RealSendRequest {
34
+ message: string;
35
+ }
36
+ export interface RealSendResponse {
37
+ }
38
+ export interface SendBinaryRequest {
39
+ data: Uint8Array[];
40
+ }
41
+ export interface SendBinaryResponse {
42
+ data: Uint8Array[];
43
+ }
44
+
45
+ // Function declaration section
46
+ /**
47
+ * @deprecated - This API should use a bidirectional binary stream in sdk7
48
+ * https://github.com/decentraland/sdk/issues/582
49
+ */
50
+ export function send(body: RealSendRequest): Promise<RealSendResponse>;
51
+ export function sendBinary(body: SendBinaryRequest): Promise<SendBinaryResponse>;
52
+
53
+ }
54
+ /**
55
+ * EngineApi
56
+ */
57
+ declare module "~system/EngineApi" {
58
+
59
+ export interface Position {
60
+ x: number;
61
+ y: number;
62
+ z: number;
63
+ }
64
+ export interface Vector3 {
65
+ x: number;
66
+ y: number;
67
+ z: number;
68
+ }
69
+ export interface Vector2 {
70
+ x: number;
71
+ y: number;
72
+ }
73
+ export interface Quaternion {
74
+ x: number;
75
+ y: number;
76
+ z: number;
77
+ w: number;
78
+ }
79
+
80
+ // Function declaration section
81
+ export interface Color3 {
82
+ r: number;
83
+ g: number;
84
+ b: number;
85
+ }
86
+ export interface Color4 {
87
+ r: number;
88
+ g: number;
89
+ b: number;
90
+ a: number;
91
+ }
92
+
93
+ // Function declaration section
94
+ export interface ECS6Color4 {
95
+ r: number;
96
+ g: number;
97
+ b: number;
98
+ a?: number | undefined;
99
+ }
100
+ export interface Area {
101
+ box?: Vector3 | undefined;
102
+ }
103
+ export interface UiValue {
104
+ value?: number | undefined;
105
+ type?: UiValue_UiValueType | undefined;
106
+ }
107
+ export enum UiValue_UiValueType {
108
+ UVT_PERCENT = 0,
109
+ PIXELS = 1,
110
+ UNRECOGNIZED = -1
111
+ }
112
+ /** CLASS_ID.AVATAR_MODIFIER_AREA */
113
+ export interface ECS6ComponentAvatarModifierArea {
114
+ area?: Area | undefined;
115
+ modifiers: string[];
116
+ excludeIds: string[];
117
+ }
118
+ /** CLASS_ID.TRANSFORM */
119
+ export interface ECS6ComponentTransform {
120
+ position?: Vector3 | undefined;
121
+ rotation?: Quaternion | undefined;
122
+ scale?: Vector3 | undefined;
123
+ }
124
+ /** CLASS_ID.AVATAR_ATTACH */
125
+ export interface ECS6ComponentAttachToAvatar {
126
+ avatarId?: string | undefined;
127
+ anchorPointId?: ECS6ComponentAttachToAvatar_AttachToAvatarAnchorPointId | undefined;
128
+ avatarSceneId?: string | undefined;
129
+ }
130
+ export enum ECS6ComponentAttachToAvatar_AttachToAvatarAnchorPointId {
131
+ ATAAP_POSITION = 0,
132
+ ATAAP_NAME_TAG = 1,
133
+ ATAAP_LEFT_HAND = 2,
134
+ ATAAP_RIGHT_HAND = 3,
135
+ UNRECOGNIZED = -1
136
+ }
137
+ /** CLASS_ID.BILLBOARD */
138
+ export interface ECS6ComponentBillboard {
139
+ x?: boolean | undefined;
140
+ y?: boolean | undefined;
141
+ z?: boolean | undefined;
142
+ }
143
+ /** CLASS_ID.BOX_SHAPE */
144
+ export interface ECS6ComponentBoxShape {
145
+ withCollisions?: boolean | undefined;
146
+ isPointerBlocker?: boolean | undefined;
147
+ visible?: boolean | undefined;
148
+ uvs: number[];
149
+ }
150
+ /** CLASS_ID.SPHERE_SHAPE */
151
+ export interface ECS6ComponentSphereShape {
152
+ withCollisions?: boolean | undefined;
153
+ isPointerBlocker?: boolean | undefined;
154
+ visible?: boolean | undefined;
155
+ }
156
+ /** CLASS_ID.CIRCLE_SHAPE */
157
+ export interface ECS6ComponentCircleShape {
158
+ withCollisions?: boolean | undefined;
159
+ isPointerBlocker?: boolean | undefined;
160
+ visible?: boolean | undefined;
161
+ segments?: number | undefined;
162
+ arc?: number | undefined;
163
+ }
164
+ /** CLASS_ID.PLANE_SHAPE */
165
+ export interface ECS6ComponentPlaneShape {
166
+ withCollisions?: boolean | undefined;
167
+ isPointerBlocker?: boolean | undefined;
168
+ visible?: boolean | undefined;
169
+ uvs: number[];
170
+ width?: number | undefined;
171
+ height?: number | undefined;
172
+ }
173
+ /** CLASS_ID.CONE_SHAPE */
174
+ export interface ECS6ComponentConeShape {
175
+ withCollisions?: boolean | undefined;
176
+ isPointerBlocker?: boolean | undefined;
177
+ visible?: boolean | undefined;
178
+ radiusTop?: number | undefined;
179
+ radiusBottom?: number | undefined;
180
+ segmentsHeight?: number | undefined;
181
+ segmentsRadial?: number | undefined;
182
+ openEnded?: boolean | undefined;
183
+ radius?: number | undefined;
184
+ arc?: number | undefined;
185
+ }
186
+ /** CLASS_ID.CYLINDER_SHAPE */
187
+ export interface ECS6ComponentCylinderShape {
188
+ withCollisions?: boolean | undefined;
189
+ isPointerBlocker?: boolean | undefined;
190
+ visible?: boolean | undefined;
191
+ radiusTop?: number | undefined;
192
+ radiusBottom?: number | undefined;
193
+ segmentsHeight?: number | undefined;
194
+ segmentsRadial?: number | undefined;
195
+ openEnded?: boolean | undefined;
196
+ radius?: number | undefined;
197
+ arc?: number | undefined;
198
+ }
199
+ /** CLASS_ID.GLTF_SHAPE */
200
+ export interface ECS6ComponentGltfShape {
201
+ withCollisions?: boolean | undefined;
202
+ isPointerBlocker?: boolean | undefined;
203
+ visible?: boolean | undefined;
204
+ src?: string | undefined;
205
+ }
206
+ /** CLASS_ID.NFT_SHAPE */
207
+ export interface ECS6ComponentNftShape {
208
+ withCollisions?: boolean | undefined;
209
+ isPointerBlocker?: boolean | undefined;
210
+ visible?: boolean | undefined;
211
+ src?: string | undefined;
212
+ style?: ECS6ComponentNftShape_PictureFrameStyle | undefined;
213
+ color?: Color3 | undefined;
214
+ }
215
+ export enum ECS6ComponentNftShape_PictureFrameStyle {
216
+ PFS_CLASSIC = 0,
217
+ PFS_BAROQUE_ORNAMENT = 1,
218
+ PFS_DIAMOND_ORNAMENT = 2,
219
+ PFS_MINIMAL_WIDE = 3,
220
+ PFS_MINIMAL_GREY = 4,
221
+ PFS_BLOCKY = 5,
222
+ PFS_GOLD_EDGES = 6,
223
+ PFS_GOLD_CARVED = 7,
224
+ PFS_GOLD_WIDE = 8,
225
+ PFS_GOLD_ROUNDED = 9,
226
+ PFS_METAL_MEDIUM = 10,
227
+ PFS_METAL_WIDE = 11,
228
+ PFS_METAL_SLIM = 12,
229
+ PFS_METAL_ROUNDED = 13,
230
+ PFS_PINS = 14,
231
+ PFS_MINIMAL_BLACK = 15,
232
+ PFS_MINIMAL_WHITE = 16,
233
+ PFS_TAPE = 17,
234
+ PFS_WOOD_SLIM = 18,
235
+ PFS_WOOD_WIDE = 19,
236
+ PFS_WOOD_TWIGS = 20,
237
+ PFS_CANVAS = 21,
238
+ PFS_NONE = 22,
239
+ UNRECOGNIZED = -1
240
+ }
241
+ /** CLASS_ID.TEXTURE */
242
+ export interface ECS6ComponentTexture {
243
+ src?: string | undefined;
244
+ samplingMode?: number | undefined;
245
+ wrap?: number | undefined;
246
+ hasAlpha?: boolean | undefined;
247
+ }
248
+ /** CLASS_ID.ANIMATION */
249
+ export interface ECS6ComponentAnimator {
250
+ states: ECS6ComponentAnimator_AnimationState[];
251
+ }
252
+ export interface ECS6ComponentAnimator_AnimationState {
253
+ clip?: string | undefined;
254
+ looping?: boolean | undefined;
255
+ weight?: number | undefined;
256
+ playing?: boolean | undefined;
257
+ shouldReset?: boolean | undefined;
258
+ speed?: number | undefined;
259
+ name?: string | undefined;
260
+ }
261
+ /** CLASS_ID.OBJ_SHAPE */
262
+ export interface ECS6ComponentObjShape {
263
+ withCollisions?: boolean | undefined;
264
+ isPointerBlocker?: boolean | undefined;
265
+ visible?: boolean | undefined;
266
+ src?: string | undefined;
267
+ }
268
+ /** CLASS_ID.FONT */
269
+ export interface ECS6ComponentFont {
270
+ src?: string | undefined;
271
+ }
272
+ /** CLASS_ID.TEXT_SHAPE */
273
+ export interface ECS6ComponentTextShape {
274
+ outlineWidth?: number | undefined;
275
+ outlineColor?: Color3 | undefined;
276
+ color?: Color3 | undefined;
277
+ fontSize?: number | undefined;
278
+ font?: string | undefined;
279
+ opacity?: number | undefined;
280
+ value?: string | undefined;
281
+ lineSpacing?: string | undefined;
282
+ lineCount?: number | undefined;
283
+ textWrapping?: boolean | undefined;
284
+ shadowBlur?: number | undefined;
285
+ shadowOffsetX?: number | undefined;
286
+ shadowOffsetY?: number | undefined;
287
+ shadowColor?: Color3 | undefined;
288
+ hTextAlign?: string | undefined;
289
+ vTextAlign?: string | undefined;
290
+ width?: number | undefined;
291
+ height?: number | undefined;
292
+ paddingTop?: number | undefined;
293
+ paddingRight?: number | undefined;
294
+ paddingBottom?: number | undefined;
295
+ paddingLeft?: number | undefined;
296
+ billboard?: boolean | undefined;
297
+ visible?: boolean | undefined;
298
+ }
299
+ /** CLASS_ID.PBR_MATERIAL */
300
+ export interface ECS6ComponentMaterial {
301
+ alphaTest?: number | undefined;
302
+ albedoColor?: ECS6Color4 | undefined;
303
+ emissiveColor?: Color3 | undefined;
304
+ metallic?: number | undefined;
305
+ roughness?: number | undefined;
306
+ reflectivityColor?: Color3 | undefined;
307
+ directIntensity?: number | undefined;
308
+ microSurface?: number | undefined;
309
+ emissiveIntensity?: number | undefined;
310
+ specularIntensity?: number | undefined;
311
+ albedoTexture?: string | undefined;
312
+ alphaTexture?: string | undefined;
313
+ emissiveTexture?: string | undefined;
314
+ bumpTexture?: string | undefined;
315
+ transparencyMode?: number | undefined;
316
+ castShadows?: boolean | undefined;
317
+ }
318
+ /** CLASS_ID.BASIC_MATERIAL */
319
+ export interface ECS6ComponentBasicMaterial {
320
+ alphaTest?: number | undefined;
321
+ texture?: string | undefined;
322
+ castShadows?: boolean | undefined;
323
+ }
324
+ /** CLASS_ID.UUID_CALLBACK */
325
+ export interface ECS6ComponentUuidCallback {
326
+ button?: string | undefined;
327
+ hoverText?: string | undefined;
328
+ distance?: number | undefined;
329
+ showFeedback?: boolean | undefined;
330
+ type?: string | undefined;
331
+ uuid?: string | undefined;
332
+ }
333
+ /** CLASS_ID.SMART_ITEM) */
334
+ export interface ECS6ComponentSmartItem {
335
+ }
336
+ /** CLASS_ID.VIDEO_CLIP */
337
+ export interface ECS6ComponentVideoClip {
338
+ url?: string | undefined;
339
+ }
340
+ /** CLASS_ID.VIDEO_TEXTURE */
341
+ export interface ECS6ComponentVideoTexture {
342
+ samplingMode?: number | undefined;
343
+ wrap?: number | undefined;
344
+ volume?: number | undefined;
345
+ playbackRate?: number | undefined;
346
+ seek?: number | undefined;
347
+ playing?: boolean | undefined;
348
+ loop?: boolean | undefined;
349
+ videoClipId?: string | undefined;
350
+ }
351
+ export enum ECS6ComponentVideoTexture_VideoStatus {
352
+ NONE = 0,
353
+ ERROR = 1,
354
+ LOADING = 2,
355
+ READY = 3,
356
+ PLAYING = 4,
357
+ BUFFERING = 5,
358
+ UNRECOGNIZED = -1
359
+ }
360
+ /** CLASS_ID.CAMERA_MODE_AREA */
361
+ export interface ECS6ComponentCameraModeArea {
362
+ area: Area | undefined;
363
+ cameraMode: ECS6ComponentCameraModeArea_CameraMode;
364
+ }
365
+ export enum ECS6ComponentCameraModeArea_CameraMode {
366
+ CM_FIRST_PERSON = 0,
367
+ CM_THIRD_PERSON = 1,
368
+ CM_BUILDING_TOOL_GOD_MODE = 2,
369
+ UNRECOGNIZED = -1
370
+ }
371
+ /** CLASS_ID.AVATAR_TEXTURE */
372
+ export interface ECS6ComponentAvatarTexture {
373
+ samplingMode?: number | undefined;
374
+ wrap?: number | undefined;
375
+ hasAlpha?: boolean | undefined;
376
+ userId?: string | undefined;
377
+ }
378
+ /** CLASS_ID.AUDIO_CLIP */
379
+ export interface ECS6ComponentAudioClip {
380
+ url?: string | undefined;
381
+ loop?: boolean | undefined;
382
+ loadingCompleteEventId?: string | undefined;
383
+ volume?: number | undefined;
384
+ }
385
+ /** CLASS_ID.AUDIO_SOURCE */
386
+ export interface ECS6ComponentAudioSource {
387
+ audioClipId?: string | undefined;
388
+ loop?: boolean | undefined;
389
+ volume?: number | undefined;
390
+ playing?: boolean | undefined;
391
+ pitch?: number | undefined;
392
+ playedAtTimestamp?: number | undefined;
393
+ }
394
+ /** CLASS_ID.AUDIO_STREAM */
395
+ export interface ECS6ComponentAudioStream {
396
+ url?: string | undefined;
397
+ playing?: boolean | undefined;
398
+ volume?: number | undefined;
399
+ }
400
+ /** CLASS_ID.AVATAR_SHAPE */
401
+ export interface ECS6ComponentAvatarShape {
402
+ id?: string | undefined;
403
+ name?: string | undefined;
404
+ expressionTriggerId?: string | undefined;
405
+ expressionTriggerTimestamp?: number | undefined;
406
+ bodyShape?: string | undefined;
407
+ wearables: string[];
408
+ emotes: ECS6ComponentAvatarShape_Emote[];
409
+ skinColor?: ECS6Color4 | undefined;
410
+ hairColor?: ECS6Color4 | undefined;
411
+ eyeColor?: ECS6Color4 | undefined;
412
+ useDummyModel?: boolean | undefined;
413
+ talking?: boolean | undefined;
414
+ }
415
+ export interface ECS6ComponentAvatarShape_Emote {
416
+ slot?: number | undefined;
417
+ urn?: string | undefined;
418
+ }
419
+ /** CLASS_ID.GIZMOS */
420
+ export interface ECS6ComponentGizmos {
421
+ position?: boolean | undefined;
422
+ rotation?: boolean | undefined;
423
+ scale?: boolean | undefined;
424
+ cycle?: boolean | undefined;
425
+ selectedGizmo?: string | undefined;
426
+ localReference?: boolean | undefined;
427
+ }
428
+ /** NO CLASS */
429
+ export interface ECS6ComponentUiShape {
430
+ name?: string | undefined;
431
+ visible?: boolean | undefined;
432
+ opacity?: number | undefined;
433
+ hAlign?: string | undefined;
434
+ vAlign?: string | undefined;
435
+ width?: UiValue | undefined;
436
+ height?: UiValue | undefined;
437
+ positionX?: UiValue | undefined;
438
+ positionY?: UiValue | undefined;
439
+ isPointerBlocker?: boolean | undefined;
440
+ parentComponent?: string | undefined;
441
+ }
442
+ /** CLASS_ID.UI_CONTAINER_RECT */
443
+ export interface ECS6ComponentUiContainerRect {
444
+ /** UiShape */
445
+ name?: string | undefined;
446
+ visible?: boolean | undefined;
447
+ opacity?: number | undefined;
448
+ hAlign?: string | undefined;
449
+ vAlign?: string | undefined;
450
+ width?: UiValue | undefined;
451
+ height?: UiValue | undefined;
452
+ positionX?: UiValue | undefined;
453
+ positionY?: UiValue | undefined;
454
+ isPointerBlocker?: boolean | undefined;
455
+ parentComponent?: string | undefined;
456
+ /** UiShape */
457
+ thickness?: number | undefined;
458
+ color?: ECS6Color4 | undefined;
459
+ alignmentUsesSize?: boolean | undefined;
460
+ }
461
+ /** CLASS_ID.UI_CONTAINER_STACK */
462
+ export interface ECS6ComponentUiContainerStack {
463
+ /** UiShape */
464
+ name?: string | undefined;
465
+ visible?: boolean | undefined;
466
+ opacity?: number | undefined;
467
+ hAlign?: string | undefined;
468
+ vAlign?: string | undefined;
469
+ width?: UiValue | undefined;
470
+ height?: UiValue | undefined;
471
+ positionX?: UiValue | undefined;
472
+ positionY?: UiValue | undefined;
473
+ isPointerBlocker?: boolean | undefined;
474
+ /** UiShape */
475
+ parentComponent?: string | undefined;
476
+ adaptWidth?: boolean | undefined;
477
+ adaptHeight?: boolean | undefined;
478
+ color?: ECS6Color4 | undefined;
479
+ stackOrientation?: ECS6ComponentUiContainerStack_UIStackOrientation | undefined;
480
+ spacing?: number | undefined;
481
+ }
482
+ export enum ECS6ComponentUiContainerStack_UIStackOrientation {
483
+ VERTICAL = 0,
484
+ HORIZONTAL = 1,
485
+ UNRECOGNIZED = -1
486
+ }
487
+ /** CLASS_ID.UI_BUTTON_SHAPE */
488
+ export interface ECS6ComponentUiButton {
489
+ /** UiShape */
490
+ name?: string | undefined;
491
+ visible?: boolean | undefined;
492
+ opacity?: number | undefined;
493
+ hAlign?: string | undefined;
494
+ vAlign?: string | undefined;
495
+ width?: UiValue | undefined;
496
+ height?: UiValue | undefined;
497
+ positionX?: UiValue | undefined;
498
+ positionY?: UiValue | undefined;
499
+ isPointerBlocker?: boolean | undefined;
500
+ /** UiShape */
501
+ parentComponent?: string | undefined;
502
+ fontSize?: number | undefined;
503
+ fontWeight?: string | undefined;
504
+ thickness?: number | undefined;
505
+ cornerRadius?: number | undefined;
506
+ color?: ECS6Color4 | undefined;
507
+ background?: ECS6Color4 | undefined;
508
+ paddingTop?: number | undefined;
509
+ paddingRight?: number | undefined;
510
+ paddingBottom?: number | undefined;
511
+ paddingLeft?: number | undefined;
512
+ shadowBlur?: number | undefined;
513
+ shadowOffsetX?: number | undefined;
514
+ shadowOffsetY?: number | undefined;
515
+ shadowColor?: ECS6Color4 | undefined;
516
+ text?: string | undefined;
517
+ }
518
+ /** CLASS_ID.UI_TEXT_SHAPE */
519
+ export interface ECS6ComponentUiText {
520
+ /** UiShape */
521
+ name?: string | undefined;
522
+ visible?: boolean | undefined;
523
+ opacity?: number | undefined;
524
+ hAlign?: string | undefined;
525
+ vAlign?: string | undefined;
526
+ width?: UiValue | undefined;
527
+ height?: UiValue | undefined;
528
+ positionX?: UiValue | undefined;
529
+ positionY?: UiValue | undefined;
530
+ isPointerBlocker?: boolean | undefined;
531
+ /** UiShape */
532
+ parentComponent?: string | undefined;
533
+ outlineWidth?: number | undefined;
534
+ outlineColor?: ECS6Color4 | undefined;
535
+ color?: ECS6Color4 | undefined;
536
+ fontSize?: number | undefined;
537
+ fontAutoSize?: boolean | undefined;
538
+ font?: string | undefined;
539
+ value?: string | undefined;
540
+ lineSpacing?: number | undefined;
541
+ lineCount?: number | undefined;
542
+ adaptWidth?: boolean | undefined;
543
+ adaptHeight?: boolean | undefined;
544
+ textWrapping?: boolean | undefined;
545
+ shadowBlur?: number | undefined;
546
+ shadowOffsetX?: number | undefined;
547
+ shadowOffsetY?: number | undefined;
548
+ shadowColor?: ECS6Color4 | undefined;
549
+ hTextAlign?: string | undefined;
550
+ vTextAlign?: string | undefined;
551
+ paddingTop?: number | undefined;
552
+ paddingRight?: number | undefined;
553
+ paddingBottom?: number | undefined;
554
+ paddingLeft?: number | undefined;
555
+ }
556
+ /** CLASS_ID.UI_INPUT_TEXT_SHAPE */
557
+ export interface ECS6ComponentUiInputText {
558
+ /** UiShape */
559
+ name?: string | undefined;
560
+ visible?: boolean | undefined;
561
+ opacity?: number | undefined;
562
+ hAlign?: string | undefined;
563
+ vAlign?: string | undefined;
564
+ width?: UiValue | undefined;
565
+ height?: UiValue | undefined;
566
+ positionX?: UiValue | undefined;
567
+ positionY?: UiValue | undefined;
568
+ isPointerBlocker?: boolean | undefined;
569
+ /** UiShape */
570
+ parentComponent?: string | undefined;
571
+ outlineWidth?: number | undefined;
572
+ outlineColor?: ECS6Color4 | undefined;
573
+ color?: ECS6Color4 | undefined;
574
+ fontSize?: number | undefined;
575
+ font?: string | undefined;
576
+ value?: string | undefined;
577
+ placeholder?: string | undefined;
578
+ margin?: number | undefined;
579
+ focusedBackground?: ECS6Color4 | undefined;
580
+ textWrapping?: boolean | undefined;
581
+ shadowBlur?: number | undefined;
582
+ shadowOffsetX?: number | undefined;
583
+ shadowOffsetY?: number | undefined;
584
+ shadowColor?: ECS6Color4 | undefined;
585
+ hTextAlign?: string | undefined;
586
+ vTextAlign?: string | undefined;
587
+ paddingTop?: number | undefined;
588
+ paddingRight?: number | undefined;
589
+ paddingBottom?: number | undefined;
590
+ paddingLeft?: number | undefined;
591
+ onTextChanged?: string | undefined;
592
+ onFocus?: string | undefined;
593
+ onBlur?: string | undefined;
594
+ onTextSubmit?: string | undefined;
595
+ onChanged?: string | undefined;
596
+ }
597
+ /** CLASS_ID.UI_IMAGE_SHAPE */
598
+ export interface ECS6ComponentUiImage {
599
+ /** UiShape */
600
+ name?: string | undefined;
601
+ visible?: boolean | undefined;
602
+ opacity?: number | undefined;
603
+ hAlign?: string | undefined;
604
+ vAlign?: string | undefined;
605
+ width?: UiValue | undefined;
606
+ height?: UiValue | undefined;
607
+ positionX?: UiValue | undefined;
608
+ positionY?: UiValue | undefined;
609
+ isPointerBlocker?: boolean | undefined;
610
+ /** UiShape */
611
+ parentComponent?: string | undefined;
612
+ sourceLeft?: number | undefined;
613
+ sourceTop?: number | undefined;
614
+ sourceWidth?: number | undefined;
615
+ sourceHeight?: number | undefined;
616
+ source?: string | undefined;
617
+ paddingTop?: number | undefined;
618
+ paddingRight?: number | undefined;
619
+ paddingBottom?: number | undefined;
620
+ paddingLeft?: number | undefined;
621
+ sizeInPixels?: boolean | undefined;
622
+ onClick?: string | undefined;
623
+ }
624
+ /** CLASS_ID.UI_SLIDER_SHAPE */
625
+ export interface ECS6ComponentUiScrollRect {
626
+ /** UiShape */
627
+ name?: string | undefined;
628
+ visible?: boolean | undefined;
629
+ opacity?: number | undefined;
630
+ hAlign?: string | undefined;
631
+ vAlign?: string | undefined;
632
+ width?: UiValue | undefined;
633
+ height?: UiValue | undefined;
634
+ positionX?: UiValue | undefined;
635
+ positionY?: UiValue | undefined;
636
+ isPointerBlocker?: boolean | undefined;
637
+ /** UiShape */
638
+ parentComponent?: string | undefined;
639
+ valueX?: number | undefined;
640
+ valueY?: number | undefined;
641
+ backgroundColor?: ECS6Color4 | undefined;
642
+ isHorizontal?: boolean | undefined;
643
+ isVertical?: boolean | undefined;
644
+ paddingTop?: number | undefined;
645
+ paddingRight?: number | undefined;
646
+ paddingBottom?: number | undefined;
647
+ paddingLeft?: number | undefined;
648
+ onChanged?: string | undefined;
649
+ }
650
+ /** CLASS_ID.UI_WORLD_SPACE_SHAPE */
651
+ export interface ECS6ComponentUiWorldSpaceShape {
652
+ /** UiShape */
653
+ name?: string | undefined;
654
+ visible?: boolean | undefined;
655
+ opacity?: number | undefined;
656
+ hAlign?: string | undefined;
657
+ vAlign?: string | undefined;
658
+ width?: UiValue | undefined;
659
+ height?: UiValue | undefined;
660
+ positionX?: UiValue | undefined;
661
+ positionY?: UiValue | undefined;
662
+ isPointerBlocker?: boolean | undefined;
663
+ /** UiShape */
664
+ parentComponent?: string | undefined;
665
+ }
666
+ /** CLASS_ID.UI_SCREEN_SPACE_SHAPE */
667
+ export interface ECS6ComponentUiScreenSpaceShape {
668
+ /** UiShape */
669
+ name?: string | undefined;
670
+ visible?: boolean | undefined;
671
+ opacity?: number | undefined;
672
+ hAlign?: string | undefined;
673
+ vAlign?: string | undefined;
674
+ width?: UiValue | undefined;
675
+ height?: UiValue | undefined;
676
+ positionX?: UiValue | undefined;
677
+ positionY?: UiValue | undefined;
678
+ isPointerBlocker?: boolean | undefined;
679
+ /** UiShape */
680
+ parentComponent?: string | undefined;
681
+ }
682
+ /** CLASS_ID.UI_FULLSCREEN_SHAPE */
683
+ export interface ECS6ComponentUiFullScreenShape {
684
+ /** UiShape */
685
+ name?: string | undefined;
686
+ visible?: boolean | undefined;
687
+ opacity?: number | undefined;
688
+ hAlign?: string | undefined;
689
+ vAlign?: string | undefined;
690
+ width?: UiValue | undefined;
691
+ height?: UiValue | undefined;
692
+ positionX?: UiValue | undefined;
693
+ positionY?: UiValue | undefined;
694
+ isPointerBlocker?: boolean | undefined;
695
+ /** UiShape */
696
+ parentComponent?: string | undefined;
697
+ }
698
+
699
+ // Function declaration section
700
+ export interface OpenExternalUrlBody {
701
+ url: string;
702
+ }
703
+ export interface OpenNFTDialogBody {
704
+ assetContractAddress: string;
705
+ tokenId: string;
706
+ comment?: string | undefined;
707
+ }
708
+ export interface ComponentBodyPayload {
709
+ avatarModifierArea?: ECS6ComponentAvatarModifierArea | undefined;
710
+ transform?: ECS6ComponentTransform | undefined;
711
+ attachToAvatar?: ECS6ComponentAttachToAvatar | undefined;
712
+ billboard?: ECS6ComponentBillboard | undefined;
713
+ boxShape?: ECS6ComponentBoxShape | undefined;
714
+ sphereShape?: ECS6ComponentSphereShape | undefined;
715
+ circleShape?: ECS6ComponentCircleShape | undefined;
716
+ planeShape?: ECS6ComponentPlaneShape | undefined;
717
+ coneShape?: ECS6ComponentConeShape | undefined;
718
+ cylinderShape?: ECS6ComponentCylinderShape | undefined;
719
+ gltfShape?: ECS6ComponentGltfShape | undefined;
720
+ nftShape?: ECS6ComponentNftShape | undefined;
721
+ texture?: ECS6ComponentTexture | undefined;
722
+ animator?: ECS6ComponentAnimator | undefined;
723
+ objShape?: ECS6ComponentObjShape | undefined;
724
+ font?: ECS6ComponentFont | undefined;
725
+ textShape?: ECS6ComponentTextShape | undefined;
726
+ material?: ECS6ComponentMaterial | undefined;
727
+ basicMaterial?: ECS6ComponentBasicMaterial | undefined;
728
+ uuidCallback?: ECS6ComponentUuidCallback | undefined;
729
+ smartItem?: ECS6ComponentSmartItem | undefined;
730
+ videoClip?: ECS6ComponentVideoClip | undefined;
731
+ videoTexture?: ECS6ComponentVideoTexture | undefined;
732
+ cameraModeArea?: ECS6ComponentCameraModeArea | undefined;
733
+ avatarTexture?: ECS6ComponentAvatarTexture | undefined;
734
+ audioClip?: ECS6ComponentAudioClip | undefined;
735
+ audioSource?: ECS6ComponentAudioSource | undefined;
736
+ audioStream?: ECS6ComponentAudioStream | undefined;
737
+ avatarShape?: ECS6ComponentAvatarShape | undefined;
738
+ gizmos?: ECS6ComponentGizmos | undefined;
739
+ uiShape?: ECS6ComponentUiShape | undefined;
740
+ uiContainerRect?: ECS6ComponentUiContainerRect | undefined;
741
+ uiContainerStack?: ECS6ComponentUiContainerStack | undefined;
742
+ uiButton?: ECS6ComponentUiButton | undefined;
743
+ uiText?: ECS6ComponentUiText | undefined;
744
+ uiInputText?: ECS6ComponentUiInputText | undefined;
745
+ uiImage?: ECS6ComponentUiImage | undefined;
746
+ uiScrollRect?: ECS6ComponentUiScrollRect | undefined;
747
+ uiWorldSpaceShape?: ECS6ComponentUiWorldSpaceShape | undefined;
748
+ uiScreenSpaceShape?: ECS6ComponentUiScreenSpaceShape | undefined;
749
+ uiFullScreenShape?: ECS6ComponentUiFullScreenShape | undefined;
750
+ }
751
+ export interface CreateEntityBody {
752
+ id: string;
753
+ }
754
+ export interface RemoveEntityBody {
755
+ id: string;
756
+ }
757
+ export interface UpdateEntityComponentBody {
758
+ entityId: string;
759
+ classId: number;
760
+ name: string;
761
+ componentData: ComponentBodyPayload | undefined;
762
+ }
763
+ export interface AttachEntityComponentBody {
764
+ entityId: string;
765
+ name: string;
766
+ id: string;
767
+ }
768
+ export interface ComponentRemovedBody {
769
+ entityId: string;
770
+ name: string;
771
+ }
772
+ export interface SetEntityParentBody {
773
+ entityId: string;
774
+ parentId: string;
775
+ }
776
+ export interface QueryBody {
777
+ queryId: string;
778
+ payload: QueryBody_RayQuery | undefined;
779
+ }
780
+ export interface QueryBody_Ray {
781
+ origin: Vector3 | undefined;
782
+ direction: Vector3 | undefined;
783
+ distance: number;
784
+ }
785
+ export interface QueryBody_RayQuery {
786
+ queryId: string;
787
+ queryType: string;
788
+ ray: QueryBody_Ray | undefined;
789
+ }
790
+ export interface ComponentCreatedBody {
791
+ id: string;
792
+ classId: number;
793
+ name: string;
794
+ }
795
+ export interface ComponentDisposedBody {
796
+ id: string;
797
+ }
798
+ export interface ComponentUpdatedBody {
799
+ id: string;
800
+ componentData: ComponentBodyPayload | undefined;
801
+ }
802
+ export interface InitMessagesFinishedBody {
803
+ }
804
+ export interface EntityActionPayload {
805
+ openExternalUrl?: OpenExternalUrlBody | undefined;
806
+ openNftDialog?: OpenNFTDialogBody | undefined;
807
+ createEntity?: CreateEntityBody | undefined;
808
+ removeEntity?: RemoveEntityBody | undefined;
809
+ updateEntityComponent?: UpdateEntityComponentBody | undefined;
810
+ attachEntityComponent?: AttachEntityComponentBody | undefined;
811
+ componentRemoved?: ComponentRemovedBody | undefined;
812
+ setEntityParent?: SetEntityParentBody | undefined;
813
+ query?: QueryBody | undefined;
814
+ componentCreated?: ComponentCreatedBody | undefined;
815
+ componentDisposed?: ComponentDisposedBody | undefined;
816
+ componentUpdated?: ComponentUpdatedBody | undefined;
817
+ initMessagesFinished?: InitMessagesFinishedBody | undefined;
818
+ }
819
+ export interface EntityAction {
820
+ tag?: string | undefined;
821
+ payload: EntityActionPayload | undefined;
822
+ }
823
+
824
+ // Function declaration section
825
+ /** Events */
826
+ export enum EventDataType {
827
+ EDT_GENERIC = 0,
828
+ EDT_POSITION_CHANGED = 1,
829
+ EDT_ROTATION_CHANGED = 2,
830
+ UNRECOGNIZED = -1
831
+ }
832
+ export interface ManyEntityAction {
833
+ actions: EntityAction[];
834
+ }
835
+ export interface SendBatchResponse {
836
+ events: EventData[];
837
+ }
838
+ export interface UnsubscribeRequest {
839
+ eventId: string;
840
+ }
841
+ export interface SubscribeRequest {
842
+ eventId: string;
843
+ }
844
+ export interface SubscribeResponse {
845
+ }
846
+ export interface UnsubscribeResponse {
847
+ }
848
+ export interface GenericPayload {
849
+ eventId: string;
850
+ eventData: string;
851
+ }
852
+ export interface ReadOnlyVector3 {
853
+ x: number;
854
+ y: number;
855
+ z: number;
856
+ }
857
+ export interface ReadOnlyQuaternion {
858
+ x: number;
859
+ y: number;
860
+ z: number;
861
+ w: number;
862
+ }
863
+ export interface PositionChangedPayload {
864
+ position: ReadOnlyVector3 | undefined;
865
+ cameraPosition: ReadOnlyVector3 | undefined;
866
+ playerHeight: number;
867
+ }
868
+ export interface RotationChangedPayload {
869
+ rotation: ReadOnlyVector3 | undefined;
870
+ quaternion: ReadOnlyQuaternion | undefined;
871
+ }
872
+ export interface EventData {
873
+ type: EventDataType;
874
+ generic?: GenericPayload | undefined;
875
+ positionChanged?: PositionChangedPayload | undefined;
876
+ rotationChanged?: RotationChangedPayload | undefined;
877
+ }
878
+ export interface CrdtSendToRendererRequest {
879
+ data: Uint8Array;
880
+ }
881
+ export interface CrdtSendToResponse {
882
+ /** list of CRDT messages coming back from the renderer */
883
+ data: Uint8Array[];
884
+ }
885
+ export interface CrdtGetStateRequest {
886
+ }
887
+ export interface CrdtGetStateResponse {
888
+ /** returns true if the returned state has scene-created entities */
889
+ hasEntities: boolean;
890
+ /** static entities data (root entity, camera, etc) and scene-created entities */
891
+ data: Uint8Array[];
892
+ }
893
+ /** deprecated */
894
+ export interface CrdtMessageFromRendererRequest {
895
+ }
896
+ /** deprecated */
897
+ export interface CrdtMessageFromRendererResponse {
898
+ data: Uint8Array[];
899
+ }
900
+ export interface IsServerRequest {
901
+ }
902
+ export interface IsServerResponse {
903
+ isServer: boolean;
904
+ }
905
+
906
+ // Function declaration section
907
+ /** @deprecated */
908
+ export function sendBatch(body: ManyEntityAction): Promise<SendBatchResponse>;
909
+ /** @deprecated */
910
+ export function subscribe(body: SubscribeRequest): Promise<SubscribeResponse>;
911
+ /** @deprecated */
912
+ export function unsubscribe(body: UnsubscribeRequest): Promise<UnsubscribeResponse>;
913
+ /**
914
+ * send information of the CRDT messages to the renderer. It returns the CRDT changes back from the renderer
915
+ * like raycast responses or the player's position
916
+ */
917
+ export function crdtSendToRenderer(body: CrdtSendToRendererRequest): Promise<CrdtSendToResponse>;
918
+ /**
919
+ * retrieves the current _full_ state of the entities from the renderer. This function is used to hidrate
920
+ * the state of the scenes when the code of the worker is stopped/resumed
921
+ */
922
+ export function crdtGetState(body: CrdtSendToRendererRequest): Promise<CrdtGetStateResponse>;
923
+ /** @deprecated, this response was merged into CrdtSendToResponse */
924
+ export function crdtGetMessageFromRenderer(body: CrdtMessageFromRendererRequest): Promise<CrdtMessageFromRendererResponse>;
925
+ export function isServer(body: IsServerRequest): Promise<IsServerResponse>;
926
+
927
+ }
928
+ /**
929
+ * EnvironmentApi
930
+ */
931
+ declare module "~system/EnvironmentApi" {
932
+
933
+ export interface ContentMapping {
934
+ file: string;
935
+ hash: string;
936
+ }
937
+
938
+ // Function declaration section
939
+ export interface MinimalRunnableEntity {
940
+ content: ContentMapping[];
941
+ metadataJson: string;
942
+ }
943
+ export interface BootstrapDataResponse {
944
+ id: string;
945
+ baseUrl: string;
946
+ entity: MinimalRunnableEntity | undefined;
947
+ useFPSThrottling: boolean;
948
+ }
949
+ export interface PreviewModeResponse {
950
+ isPreview: boolean;
951
+ }
952
+ export interface AreUnsafeRequestAllowedResponse {
953
+ status: boolean;
954
+ }
955
+ export interface GetPlatformResponse {
956
+ platform: string;
957
+ }
958
+ export interface EnvironmentRealm {
959
+ domain: string;
960
+ layer: string;
961
+ room: string;
962
+ serverName: string;
963
+ displayName: string;
964
+ protocol: string;
965
+ }
966
+ export interface GetCurrentRealmResponse {
967
+ currentRealm?: EnvironmentRealm | undefined;
968
+ }
969
+ export interface GetExplorerConfigurationResponse {
970
+ clientUri: string;
971
+ configurations: {
972
+ [key: string]: string;
973
+ };
974
+ }
975
+ export interface GetExplorerConfigurationResponse_ConfigurationsEntry {
976
+ key: string;
977
+ value: string;
978
+ }
979
+ export interface GetDecentralandTimeResponse {
980
+ seconds: number;
981
+ }
982
+ export interface GetBootstrapDataRequest {
983
+ }
984
+ export interface IsPreviewModeRequest {
985
+ }
986
+ export interface GetPlatformRequest {
987
+ }
988
+ export interface AreUnsafeRequestAllowedRequest {
989
+ }
990
+ export interface GetCurrentRealmRequest {
991
+ }
992
+ export interface GetExplorerConfigurationRequest {
993
+ }
994
+ export interface GetDecentralandTimeRequest {
995
+ }
996
+
997
+ // Function declaration section
998
+ /** @deprecated, only available for SDK6 compatibility. Use runtime_api instead */
999
+ export function getBootstrapData(body: GetBootstrapDataRequest): Promise<BootstrapDataResponse>;
1000
+ /** @deprecated, only available for SDK6 compatibility. Needs migration */
1001
+ export function isPreviewMode(body: IsPreviewModeRequest): Promise<PreviewModeResponse>;
1002
+ /** @deprecated, only available for SDK6 compatibility */
1003
+ export function getPlatform(body: GetPlatformRequest): Promise<GetPlatformResponse>;
1004
+ /** @deprecated, only available for SDK6 compatibility */
1005
+ export function areUnsafeRequestAllowed(body: AreUnsafeRequestAllowedRequest): Promise<AreUnsafeRequestAllowedResponse>;
1006
+ /** @deprecated, use GetCurrentRealm from runtime_api instead */
1007
+ export function getCurrentRealm(body: GetCurrentRealmRequest): Promise<GetCurrentRealmResponse>;
1008
+ /** @deprecated, only available for SDK6 compatibility */
1009
+ export function getExplorerConfiguration(body: GetExplorerConfigurationRequest): Promise<GetExplorerConfigurationResponse>;
1010
+ /** @deprecated, use GetTime from runtime_api instead */
1011
+ export function getDecentralandTime(body: GetDecentralandTimeRequest): Promise<GetDecentralandTimeResponse>;
1012
+
1013
+ }
1014
+ /**
1015
+ * EthereumController
1016
+ */
1017
+ declare module "~system/EthereumController" {
1018
+
1019
+ export interface RequirePaymentRequest {
1020
+ toAddress: string;
1021
+ amount: number;
1022
+ currency: string;
1023
+ }
1024
+ export interface RequirePaymentResponse {
1025
+ jsonAnyResponse: string;
1026
+ }
1027
+ export interface SignMessageRequest {
1028
+ message: {
1029
+ [key: string]: string;
1030
+ };
1031
+ }
1032
+ export interface SignMessageRequest_MessageEntry {
1033
+ key: string;
1034
+ value: string;
1035
+ }
1036
+ export interface SignMessageResponse {
1037
+ message: string;
1038
+ hexEncodedMessage: string;
1039
+ signature: string;
1040
+ }
1041
+ export interface ConvertMessageToObjectRequest {
1042
+ message: string;
1043
+ }
1044
+ export interface ConvertMessageToObjectResponse {
1045
+ dict: {
1046
+ [key: string]: string;
1047
+ };
1048
+ }
1049
+ export interface ConvertMessageToObjectResponse_DictEntry {
1050
+ key: string;
1051
+ value: string;
1052
+ }
1053
+ export interface SendAsyncRequest {
1054
+ id: number;
1055
+ method: string;
1056
+ jsonParams: string;
1057
+ }
1058
+ export interface SendAsyncResponse {
1059
+ jsonAnyResponse: string;
1060
+ }
1061
+ export interface GetUserAccountRequest {
1062
+ }
1063
+ export interface GetUserAccountResponse {
1064
+ address?: string | undefined;
1065
+ }
1066
+
1067
+ // Function declaration section
1068
+ /**
1069
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
1070
+ * be replaced by any ethereum library on top of the provider
1071
+ */
1072
+ export function requirePayment(body: RequirePaymentRequest): Promise<RequirePaymentResponse>;
1073
+ /**
1074
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
1075
+ * be replaced by any ethereum library on top of the provider
1076
+ */
1077
+ export function signMessage(body: SignMessageRequest): Promise<SignMessageResponse>;
1078
+ /**
1079
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
1080
+ * be replaced by any ethereum library on top of the provider
1081
+ */
1082
+ export function convertMessageToObject(body: ConvertMessageToObjectRequest): Promise<ConvertMessageToObjectResponse>;
1083
+ export function sendAsync(body: SendAsyncRequest): Promise<SendAsyncResponse>;
1084
+ /**
1085
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
1086
+ * be replaced by any ethereum library on top of the provider
1087
+ */
1088
+ export function getUserAccount(body: GetUserAccountRequest): Promise<GetUserAccountResponse>;
1089
+
1090
+ }
1091
+ /**
1092
+ * Players
1093
+ */
1094
+ declare module "~system/Players" {
1095
+
1096
+ export interface Snapshots {
1097
+ face256: string;
1098
+ body: string;
1099
+ }
1100
+ export interface AvatarForUserData {
1101
+ bodyShape: string;
1102
+ skinColor: string;
1103
+ hairColor: string;
1104
+ eyeColor: string;
1105
+ wearables: string[];
1106
+ snapshots: Snapshots | undefined;
1107
+ }
1108
+ export interface UserData {
1109
+ displayName: string;
1110
+ publicKey?: string | undefined;
1111
+ hasConnectedWeb3: boolean;
1112
+ userId: string;
1113
+ version: number;
1114
+ avatar: AvatarForUserData | undefined;
1115
+ }
1116
+
1117
+ // Function declaration section
1118
+ export interface Player {
1119
+ userId: string;
1120
+ }
1121
+ export interface PlayersGetUserDataResponse {
1122
+ data?: UserData | undefined;
1123
+ }
1124
+ export interface PlayerListResponse {
1125
+ players: Player[];
1126
+ }
1127
+ export interface GetPlayerDataRequest {
1128
+ userId: string;
1129
+ }
1130
+ export interface GetPlayersInSceneRequest {
1131
+ }
1132
+ export interface GetConnectedPlayersRequest {
1133
+ }
1134
+
1135
+ // Function declaration section
1136
+ /**
1137
+ * Returns data about a specific player, by id
1138
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
1139
+ */
1140
+ export function getPlayerData(body: GetPlayerDataRequest): Promise<PlayersGetUserDataResponse>;
1141
+ /**
1142
+ * Returns a list of all the ids of players who are currently standing within the parcels of the scene
1143
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
1144
+ */
1145
+ export function getPlayersInScene(body: GetPlayersInSceneRequest): Promise<PlayerListResponse>;
1146
+ /**
1147
+ * Returns a list of all the ids of players who are currently connected to the same server and grouped together
1148
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
1149
+ */
1150
+ export function getConnectedPlayers(body: GetConnectedPlayersRequest): Promise<PlayerListResponse>;
1151
+
1152
+ }
1153
+ /**
1154
+ * PortableExperiences
1155
+ */
1156
+ declare module "~system/PortableExperiences" {
1157
+
1158
+ export interface KillRequest {
1159
+ pid: string;
1160
+ }
1161
+ export interface KillResponse {
1162
+ status: boolean;
1163
+ }
1164
+ export interface SpawnRequest {
1165
+ pid?: string | undefined;
1166
+ ens?: string | undefined;
1167
+ }
1168
+ export interface SpawnResponse {
1169
+ pid: string;
1170
+ parentCid: string;
1171
+ name: string;
1172
+ ens?: string | undefined;
1173
+ }
1174
+ export interface PxRequest {
1175
+ pid: string;
1176
+ }
1177
+ export interface GetPortableExperiencesLoadedRequest {
1178
+ }
1179
+ export interface GetPortableExperiencesLoadedResponse {
1180
+ loaded: SpawnResponse[];
1181
+ }
1182
+ export interface ExitRequest {
1183
+ }
1184
+ export interface ExitResponse {
1185
+ status: boolean;
1186
+ }
1187
+
1188
+ // Function declaration section
1189
+ /**
1190
+ * Spawns a new portable experience that is detached from the current scene.
1191
+ * Spawned portable experiences can only be controlled by 1) the user (from the UI)
1192
+ * and 2) from the parent scene. If the parent scene gets unloaded i.e. by distance,
1193
+ * once the player re-loads the parent it will inherit the children portable experiences
1194
+ * to gain control over them.
1195
+ */
1196
+ export function spawn(body: SpawnRequest): Promise<SpawnResponse>;
1197
+ /**
1198
+ * Kill a child portable experience, this method only works if the child was
1199
+ * spawned by the same process trying to kill it.
1200
+ */
1201
+ export function kill(body: KillRequest): Promise<KillResponse>;
1202
+ /**
1203
+ * Kill the current scene if the current scene is a portable experience. Other
1204
+ * kind of scenes are not allowed to finish their programs like portable experiences.
1205
+ */
1206
+ export function exit(body: ExitRequest): Promise<ExitResponse>;
1207
+ /**
1208
+ * Gets a list of running portable experiences for the current user. Be mindful
1209
+ * about the performance penalty of calling this function all frames.
1210
+ */
1211
+ export function getPortableExperiencesLoaded(body: GetPortableExperiencesLoadedRequest): Promise<GetPortableExperiencesLoadedResponse>;
1212
+
1213
+ }
1214
+ /**
1215
+ * RestrictedActions
1216
+ */
1217
+ declare module "~system/RestrictedActions" {
1218
+
1219
+ export interface Position {
1220
+ x: number;
1221
+ y: number;
1222
+ z: number;
1223
+ }
1224
+ export interface Vector3 {
1225
+ x: number;
1226
+ y: number;
1227
+ z: number;
1228
+ }
1229
+ export interface Vector2 {
1230
+ x: number;
1231
+ y: number;
1232
+ }
1233
+ export interface Quaternion {
1234
+ x: number;
1235
+ y: number;
1236
+ z: number;
1237
+ w: number;
1238
+ }
1239
+
1240
+ // Function declaration section
1241
+ export interface MovePlayerToRequest {
1242
+ newRelativePosition: Vector3 | undefined;
1243
+ cameraTarget?: Vector3 | undefined;
1244
+ }
1245
+ export interface TeleportToRequest {
1246
+ worldCoordinates: Vector2 | undefined;
1247
+ }
1248
+ export interface TriggerEmoteRequest {
1249
+ predefinedEmote: string;
1250
+ }
1251
+ export interface ChangeRealmRequest {
1252
+ realm: string;
1253
+ message?: string | undefined;
1254
+ }
1255
+ export interface OpenExternalUrlRequest {
1256
+ url: string;
1257
+ }
1258
+ export interface OpenNftDialogRequest {
1259
+ urn: string;
1260
+ }
1261
+ export interface UnblockPointerRequest {
1262
+ }
1263
+ export interface CommsAdapterRequest {
1264
+ connectionString: string;
1265
+ }
1266
+ export interface TriggerSceneEmoteRequest {
1267
+ src: string;
1268
+ loop?: boolean | undefined;
1269
+ }
1270
+ export interface SuccessResponse {
1271
+ success: boolean;
1272
+ }
1273
+ export interface TriggerEmoteResponse {
1274
+ }
1275
+ export interface MovePlayerToResponse {
1276
+ }
1277
+ export interface TeleportToResponse {
1278
+ }
1279
+
1280
+ // Function declaration section
1281
+ /** MovePlayerTo will move the player in a position relative to the current scene */
1282
+ export function movePlayerTo(body: MovePlayerToRequest): Promise<MovePlayerToResponse>;
1283
+ /** TeleportTo will move the user to the specified world LAND parcel coordinates */
1284
+ export function teleportTo(body: TeleportToRequest): Promise<TeleportToResponse>;
1285
+ /** TriggerEmote will trigger an emote in this current user */
1286
+ export function triggerEmote(body: TriggerEmoteRequest): Promise<TriggerEmoteResponse>;
1287
+ /** ChangeRealm prompts the user to change to a specific realm */
1288
+ export function changeRealm(body: ChangeRealmRequest): Promise<SuccessResponse>;
1289
+ /** OpenExternalUrl prompts the user to open an external link */
1290
+ export function openExternalUrl(body: OpenExternalUrlRequest): Promise<SuccessResponse>;
1291
+ /** OpenNftDialog opens an NFT dialog. */
1292
+ export function openNftDialog(body: OpenNftDialogRequest): Promise<SuccessResponse>;
1293
+ /**
1294
+ * Asks the explorer to connect to other communications adapter, this feature
1295
+ * can be used to join private game servers
1296
+ */
1297
+ export function setCommunicationsAdapter(body: CommsAdapterRequest): Promise<SuccessResponse>;
1298
+ /** TriggerSceneEmote will trigger an scene emote file in this current user */
1299
+ export function triggerSceneEmote(body: TriggerSceneEmoteRequest): Promise<SuccessResponse>;
1300
+
1301
+ }
1302
+ /**
1303
+ * Runtime
1304
+ */
1305
+ declare module "~system/Runtime" {
1306
+
1307
+ export interface ContentMapping {
1308
+ file: string;
1309
+ hash: string;
1310
+ }
1311
+
1312
+ // Function declaration section
1313
+ export interface PBRealmInfo {
1314
+ baseUrl: string;
1315
+ realmName: string;
1316
+ networkId: number;
1317
+ commsAdapter: string;
1318
+ isPreview: boolean;
1319
+ room?: string | undefined;
1320
+ }
1321
+
1322
+ // Function declaration section
1323
+ export interface GetRealmResponse {
1324
+ realmInfo?: PBRealmInfo | undefined;
1325
+ }
1326
+ export interface GetWorldTimeResponse {
1327
+ seconds: number;
1328
+ }
1329
+ export interface GetRealmRequest {
1330
+ }
1331
+ export interface GetWorldTimeRequest {
1332
+ }
1333
+ export interface ReadFileRequest {
1334
+ /** name of the deployed file */
1335
+ fileName: string;
1336
+ }
1337
+ export interface ReadFileResponse {
1338
+ /** contents of the file */
1339
+ content: Uint8Array;
1340
+ /** deployed hash/CID */
1341
+ hash: string;
1342
+ }
1343
+ export interface CurrentSceneEntityRequest {
1344
+ }
1345
+ export interface CurrentSceneEntityResponse {
1346
+ /** this is either the entityId or the full URN of the scene that is running */
1347
+ urn: string;
1348
+ /** contents of the deployed entities */
1349
+ content: ContentMapping[];
1350
+ /** JSON serialization of the entity.metadata field */
1351
+ metadataJson: string;
1352
+ /** baseUrl used to resolve all content files */
1353
+ baseUrl: string;
1354
+ }
1355
+ export interface GetExplorerInformationRequest {
1356
+ }
1357
+ export interface GetExplorerInformationResponse {
1358
+ /** the agent that current explorer is identified as */
1359
+ agent: string;
1360
+ /** options: "desktop", "mobile", "vr", "web" */
1361
+ platform: string;
1362
+ /** custom configurations set in the explorer */
1363
+ configurations: {
1364
+ [key: string]: string;
1365
+ };
1366
+ }
1367
+ export interface GetExplorerInformationResponse_ConfigurationsEntry {
1368
+ key: string;
1369
+ value: string;
1370
+ }
1371
+
1372
+ // Function declaration section
1373
+ /** Provides information about the current realm */
1374
+ export function getRealm(body: GetRealmRequest): Promise<GetRealmResponse>;
1375
+ /**
1376
+ * Provides information about the Decentraland Time, which is coordinated
1377
+ * across players.
1378
+ */
1379
+ export function getWorldTime(body: GetWorldTimeRequest): Promise<GetWorldTimeResponse>;
1380
+ /**
1381
+ * Returns the file content of a deployed asset. If the file doesn't
1382
+ * exist or cannot be retrieved, the RPC call throws an error.
1383
+ * This method is called to load any assets deployed among the scene,
1384
+ * runtime may cache this response much more than the provided "fetch" function.
1385
+ */
1386
+ export function readFile(body: ReadFileRequest): Promise<ReadFileResponse>;
1387
+ /** Returns information about the current scene. This is the replacement of GetBootstrapData */
1388
+ export function getSceneInformation(body: CurrentSceneEntityRequest): Promise<CurrentSceneEntityResponse>;
1389
+ /** Provides information about the explorer */
1390
+ export function getExplorerInformation(body: GetExplorerInformationRequest): Promise<GetExplorerInformationResponse>;
1391
+
1392
+ }
1393
+ /**
1394
+ * Scene
1395
+ */
1396
+ declare module "~system/Scene" {
1397
+
1398
+ export interface ContentMapping {
1399
+ file: string;
1400
+ hash: string;
1401
+ }
1402
+
1403
+ // Function declaration section
1404
+ export interface GetSceneRequest {
1405
+ }
1406
+ export interface GetSceneResponse {
1407
+ cid: string;
1408
+ metadata: string;
1409
+ baseUrl: string;
1410
+ contents: ContentMapping[];
1411
+ }
1412
+
1413
+ // Function declaration section
1414
+ export function getSceneInfo(body: GetSceneRequest): Promise<GetSceneResponse>;
1415
+
1416
+ }
1417
+ /**
1418
+ * SignedFetch
1419
+ */
1420
+ declare module "~system/SignedFetch" {
1421
+
1422
+ export interface FlatFetchInit {
1423
+ method?: string | undefined;
1424
+ body?: string | undefined;
1425
+ headers: {
1426
+ [key: string]: string;
1427
+ };
1428
+ }
1429
+ export interface FlatFetchInit_HeadersEntry {
1430
+ key: string;
1431
+ value: string;
1432
+ }
1433
+ export interface FlatFetchResponse {
1434
+ ok: boolean;
1435
+ status: number;
1436
+ statusText: string;
1437
+ headers: {
1438
+ [key: string]: string;
1439
+ };
1440
+ body: string;
1441
+ }
1442
+ export interface FlatFetchResponse_HeadersEntry {
1443
+ key: string;
1444
+ value: string;
1445
+ }
1446
+ export interface SignedFetchRequest {
1447
+ url: string;
1448
+ init?: FlatFetchInit | undefined;
1449
+ }
1450
+ export interface GetHeadersResponse {
1451
+ headers: {
1452
+ [key: string]: string;
1453
+ };
1454
+ }
1455
+ export interface GetHeadersResponse_HeadersEntry {
1456
+ key: string;
1457
+ value: string;
1458
+ }
1459
+
1460
+ // Function declaration section
1461
+ /**
1462
+ * SignedFetch is used to authenticate JSON requests in name of the users,
1463
+ * a special scoped signature is generated following the https://adr.decentraland.org/adr/ADR-44
1464
+ */
1465
+ export function signedFetch(body: SignedFetchRequest): Promise<FlatFetchResponse>;
1466
+ export function getHeaders(body: SignedFetchRequest): Promise<GetHeadersResponse>;
1467
+
1468
+ }
1469
+ /**
1470
+ * Testing
1471
+ */
1472
+ declare module "~system/Testing" {
1473
+
1474
+ export interface Position {
1475
+ x: number;
1476
+ y: number;
1477
+ z: number;
1478
+ }
1479
+ export interface Vector3 {
1480
+ x: number;
1481
+ y: number;
1482
+ z: number;
1483
+ }
1484
+ export interface Vector2 {
1485
+ x: number;
1486
+ y: number;
1487
+ }
1488
+ export interface Quaternion {
1489
+ x: number;
1490
+ y: number;
1491
+ z: number;
1492
+ w: number;
1493
+ }
1494
+
1495
+ // Function declaration section
1496
+ export enum TakeAndCompareScreenshotRequest_SnapshotMode {
1497
+ /** SM_3D_AND_UI - only visible 3d scene and ui scene */
1498
+ SM_3D_AND_UI = 0,
1499
+ /** SM_3D_ONLY - only visible 3d scene */
1500
+ SM_3D_ONLY = 1,
1501
+ /** SM_UI_ONLY - only visible ui scene */
1502
+ SM_UI_ONLY = 2,
1503
+ UNRECOGNIZED = -1
1504
+ }
1505
+ export interface TakeAndCompareScreenshotRequest_ComparisonMethodGreyPixelDiff {
1506
+ }
1507
+ export interface TakeAndCompareScreenshotResponse_ComparisonMethodGreyPixelDiffResult {
1508
+ similarity: number;
1509
+ }
1510
+ export interface TestResult {
1511
+ name: string;
1512
+ ok: boolean;
1513
+ error?: string | undefined;
1514
+ stack?: string | undefined;
1515
+ /** how many ADR-148 ticks were spent running this test */
1516
+ totalFrames: number;
1517
+ /** total time in seconds spent running this test */
1518
+ totalTime: number;
1519
+ }
1520
+ export interface TestResultResponse {
1521
+ }
1522
+ export interface TestPlan {
1523
+ tests: TestPlan_TestPlanEntry[];
1524
+ }
1525
+ export interface TestPlan_TestPlanEntry {
1526
+ name: string;
1527
+ }
1528
+ export interface TestPlanResponse {
1529
+ }
1530
+ export interface SetCameraTransformTestCommand {
1531
+ position: SetCameraTransformTestCommand_Vector3 | undefined;
1532
+ rotation: SetCameraTransformTestCommand_Quaternion | undefined;
1533
+ }
1534
+ export interface SetCameraTransformTestCommand_Vector3 {
1535
+ x: number;
1536
+ y: number;
1537
+ z: number;
1538
+ }
1539
+ export interface SetCameraTransformTestCommand_Quaternion {
1540
+ x: number;
1541
+ y: number;
1542
+ z: number;
1543
+ w: number;
1544
+ }
1545
+ export interface SetCameraTransformTestCommandResponse {
1546
+ }
1547
+
1548
+ // Function declaration section
1549
+ /** sends a test result to the test runner */
1550
+ export function logTestResult(body: TestResult): Promise<TestResultResponse>;
1551
+ /** send a list of all planned tests to the test runner */
1552
+ export function plan(body: TestPlan): Promise<TestPlanResponse>;
1553
+ /** sets the camera position and rotation in the engine */
1554
+ export function setCameraTransform(body: SetCameraTransformTestCommand): Promise<SetCameraTransformTestCommandResponse>;
1555
+
1556
+ }
1557
+ /**
1558
+ * UserActionModule
1559
+ */
1560
+ declare module "~system/UserActionModule" {
1561
+
1562
+ export interface RequestTeleportRequest {
1563
+ destination: string;
1564
+ }
1565
+ export interface RequestTeleportResponse {
1566
+ }
1567
+
1568
+ // Function declaration section
1569
+ /** @deprecated, only available for SDK6 compatibility. Use RestrictedActions/TeleportTo */
1570
+ export function requestTeleport(body: RequestTeleportRequest): Promise<RequestTeleportResponse>;
1571
+
1572
+ }
1573
+ /**
1574
+ * UserIdentity
1575
+ */
1576
+ declare module "~system/UserIdentity" {
1577
+
1578
+ export interface Snapshots {
1579
+ face256: string;
1580
+ body: string;
1581
+ }
1582
+ export interface AvatarForUserData {
1583
+ bodyShape: string;
1584
+ skinColor: string;
1585
+ hairColor: string;
1586
+ eyeColor: string;
1587
+ wearables: string[];
1588
+ snapshots: Snapshots | undefined;
1589
+ }
1590
+ export interface UserData {
1591
+ displayName: string;
1592
+ publicKey?: string | undefined;
1593
+ hasConnectedWeb3: boolean;
1594
+ userId: string;
1595
+ version: number;
1596
+ avatar: AvatarForUserData | undefined;
1597
+ }
1598
+
1599
+ // Function declaration section
1600
+ export interface GetUserDataRequest {
1601
+ }
1602
+ export interface GetUserDataResponse {
1603
+ data?: UserData | undefined;
1604
+ }
1605
+ export interface GetUserPublicKeyRequest {
1606
+ }
1607
+ export interface GetUserPublicKeyResponse {
1608
+ address?: string | undefined;
1609
+ }
1610
+
1611
+ // Function declaration section
1612
+ /** @deprecated, only available for SDK6 compatibility. UseGetUserData */
1613
+ export function getUserPublicKey(body: GetUserPublicKeyRequest): Promise<GetUserPublicKeyResponse>;
1614
+ export function getUserData(body: GetUserDataRequest): Promise<GetUserDataResponse>;
1615
+
1616
+ }