@dcl/playground-assets 7.4.16-8634981775.commit-0048266 → 7.4.16-8693217507.commit-f417f2c

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.
Files changed (10) hide show
  1. package/dist/alpha.d.ts +55 -5
  2. package/dist/beta.d.ts +55 -5
  3. package/dist/index.bundled.d.ts +55 -5
  4. package/dist/index.js +4 -4
  5. package/dist/index.js.map +4 -4
  6. package/dist/playground/sdk/dcl-sdk.package.json +2 -2
  7. package/dist/playground-assets.d.ts +55 -5
  8. package/etc/playground-assets.api.json +568 -12
  9. package/etc/playground-assets.api.md +47 -1
  10. package/package.json +4 -4
package/etc/playground-assets.api.json CHANGED
@@ -880,6 +880,43 @@
880
880
  ],
881
881
  "name": "areConnected"
882
882
  },
883
+ {
884
+ "kind": "Variable",
885
+ "canonicalReference": "@dcl/playground-assets!AudioEvent:var",
886
+ "docComment": "/**\n * @public\n */\n",
887
+ "excerptTokens": [
888
+ {
889
+ "kind": "Content",
890
+ "text": "AudioEvent: "
891
+ },
892
+ {
893
+ "kind": "Reference",
894
+ "text": "GrowOnlyValueSetComponentDefinition",
895
+ "canonicalReference": "@dcl/playground-assets!GrowOnlyValueSetComponentDefinition:interface"
896
+ },
897
+ {
898
+ "kind": "Content",
899
+ "text": "<"
900
+ },
901
+ {
902
+ "kind": "Reference",
903
+ "text": "PBAudioEvent",
904
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent"
905
+ },
906
+ {
907
+ "kind": "Content",
908
+ "text": ">"
909
+ }
910
+ ],
911
+ "fileUrlPath": "../ecs/dist/components/generated/global.gen.d.ts",
912
+ "isReadonly": true,
913
+ "releaseTag": "Public",
914
+ "name": "AudioEvent",
915
+ "variableTypeTokenRange": {
916
+ "startIndex": 1,
917
+ "endIndex": 5
918
+ }
919
+ },
883
920
  {
884
921
  "kind": "Variable",
885
922
  "canonicalReference": "@dcl/playground-assets!AudioSource:var",
@@ -1092,12 +1129,36 @@
1092
1129
  {
1093
1130
  "kind": "Variable",
1094
1131
  "canonicalReference": "@dcl/playground-assets!AudioStream:var",
1095
- "docComment": "/**\n * @public\n */\n",
1132
+ "docComment": "",
1096
1133
  "excerptTokens": [
1097
1134
  {
1098
1135
  "kind": "Content",
1099
1136
  "text": "AudioStream: "
1100
1137
  },
1138
+ {
1139
+ "kind": "Reference",
1140
+ "text": "AudioStreamComponentDefinitionExtended",
1141
+ "canonicalReference": "@dcl/playground-assets!AudioStreamComponentDefinitionExtended:interface"
1142
+ }
1143
+ ],
1144
+ "fileUrlPath": "../ecs/dist/index.d.ts",
1145
+ "isReadonly": true,
1146
+ "releaseTag": "Public",
1147
+ "name": "AudioStream",
1148
+ "variableTypeTokenRange": {
1149
+ "startIndex": 1,
1150
+ "endIndex": 2
1151
+ }
1152
+ },
1153
+ {
1154
+ "kind": "Interface",
1155
+ "canonicalReference": "@dcl/playground-assets!AudioStreamComponentDefinitionExtended:interface",
1156
+ "docComment": "/**\n * @public\n */\n",
1157
+ "excerptTokens": [
1158
+ {
1159
+ "kind": "Content",
1160
+ "text": "export interface AudioStreamComponentDefinitionExtended extends "
1161
+ },
1101
1162
  {
1102
1163
  "kind": "Reference",
1103
1164
  "text": "LastWriteWinElementSetComponentDefinition",
@@ -1115,16 +1176,75 @@
1115
1176
  {
1116
1177
  "kind": "Content",
1117
1178
  "text": ">"
1179
+ },
1180
+ {
1181
+ "kind": "Content",
1182
+ "text": " "
1118
1183
  }
1119
1184
  ],
1120
- "fileUrlPath": "../ecs/dist/components/generated/global.gen.d.ts",
1121
- "isReadonly": true,
1185
+ "fileUrlPath": "../ecs/dist/components/extended/AudioStream.d.ts",
1122
1186
  "releaseTag": "Public",
1123
- "name": "AudioStream",
1124
- "variableTypeTokenRange": {
1125
- "startIndex": 1,
1126
- "endIndex": 5
1127
- }
1187
+ "name": "AudioStreamComponentDefinitionExtended",
1188
+ "preserveMemberOrder": false,
1189
+ "members": [
1190
+ {
1191
+ "kind": "MethodSignature",
1192
+ "canonicalReference": "@dcl/playground-assets!AudioStreamComponentDefinitionExtended#getAudioState:member(1)",
1193
+ "docComment": "/**\n * Set playing=true the sound `$name`\n *\n * @param entity - entity with AudioStream component\n *\n * @param src - the path to the sound to play\n *\n * @param resetCursor - the sound starts at 0 or continues from the current cursor position\n *\n * @returns true in successful playing, false if it doesn't find the AudioStream component\n *\n * @public\n */\n",
1194
+ "excerptTokens": [
1195
+ {
1196
+ "kind": "Content",
1197
+ "text": "getAudioState(entity: "
1198
+ },
1199
+ {
1200
+ "kind": "Reference",
1201
+ "text": "Entity",
1202
+ "canonicalReference": "@dcl/playground-assets!Entity:type"
1203
+ },
1204
+ {
1205
+ "kind": "Content",
1206
+ "text": "): "
1207
+ },
1208
+ {
1209
+ "kind": "Reference",
1210
+ "text": "PBAudioEvent",
1211
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent"
1212
+ },
1213
+ {
1214
+ "kind": "Content",
1215
+ "text": " | undefined"
1216
+ },
1217
+ {
1218
+ "kind": "Content",
1219
+ "text": ";"
1220
+ }
1221
+ ],
1222
+ "isOptional": false,
1223
+ "returnTypeTokenRange": {
1224
+ "startIndex": 3,
1225
+ "endIndex": 5
1226
+ },
1227
+ "releaseTag": "Public",
1228
+ "overloadIndex": 1,
1229
+ "parameters": [
1230
+ {
1231
+ "parameterName": "entity",
1232
+ "parameterTypeTokenRange": {
1233
+ "startIndex": 1,
1234
+ "endIndex": 2
1235
+ },
1236
+ "isOptional": false
1237
+ }
1238
+ ],
1239
+ "name": "getAudioState"
1240
+ }
1241
+ ],
1242
+ "extendsTokenRanges": [
1243
+ {
1244
+ "startIndex": 1,
1245
+ "endIndex": 5
1246
+ }
1247
+ ]
1128
1248
  },
1129
1249
  {
1130
1250
  "kind": "Enum",
@@ -11331,6 +11451,33 @@
11331
11451
  "text": "PBAnimator",
11332
11452
  "canonicalReference": "@dcl/playground-assets!PBAnimator"
11333
11453
  },
11454
+ {
11455
+ "kind": "Content",
11456
+ "text": ">>;\n \"core::AudioEvent\": "
11457
+ },
11458
+ {
11459
+ "kind": "Reference",
11460
+ "text": "GSetComponentGetter",
11461
+ "canonicalReference": "@dcl/playground-assets!GSetComponentGetter:type"
11462
+ },
11463
+ {
11464
+ "kind": "Content",
11465
+ "text": "<"
11466
+ },
11467
+ {
11468
+ "kind": "Reference",
11469
+ "text": "GrowOnlyValueSetComponentDefinition",
11470
+ "canonicalReference": "@dcl/playground-assets!GrowOnlyValueSetComponentDefinition:interface"
11471
+ },
11472
+ {
11473
+ "kind": "Content",
11474
+ "text": "<"
11475
+ },
11476
+ {
11477
+ "kind": "Reference",
11478
+ "text": "PBAudioEvent",
11479
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent"
11480
+ },
11334
11481
  {
11335
11482
  "kind": "Content",
11336
11483
  "text": ">>;\n \"core::AudioSource\": "
@@ -12395,7 +12542,7 @@
12395
12542
  "name": "componentDefinitionByName",
12396
12543
  "variableTypeTokenRange": {
12397
12544
  "startIndex": 1,
12398
- "endIndex": 242
12545
+ "endIndex": 248
12399
12546
  }
12400
12547
  },
12401
12548
  {
@@ -32066,6 +32213,191 @@
32066
32213
  }
32067
32214
  ]
32068
32215
  },
32216
+ {
32217
+ "kind": "Enum",
32218
+ "canonicalReference": "@dcl/playground-assets!MediaState:enum",
32219
+ "docComment": "/**\n * @public\n */\n",
32220
+ "excerptTokens": [
32221
+ {
32222
+ "kind": "Content",
32223
+ "text": "export declare const enum MediaState "
32224
+ }
32225
+ ],
32226
+ "fileUrlPath": "../ecs/dist/components/generated/pb/decentraland/sdk/components/common/media_state.gen.d.ts",
32227
+ "releaseTag": "Public",
32228
+ "name": "MediaState",
32229
+ "preserveMemberOrder": false,
32230
+ "members": [
32231
+ {
32232
+ "kind": "EnumMember",
32233
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_BUFFERING:member",
32234
+ "docComment": "",
32235
+ "excerptTokens": [
32236
+ {
32237
+ "kind": "Content",
32238
+ "text": "MS_BUFFERING = "
32239
+ },
32240
+ {
32241
+ "kind": "Content",
32242
+ "text": "5"
32243
+ }
32244
+ ],
32245
+ "initializerTokenRange": {
32246
+ "startIndex": 1,
32247
+ "endIndex": 2
32248
+ },
32249
+ "releaseTag": "Public",
32250
+ "name": "MS_BUFFERING"
32251
+ },
32252
+ {
32253
+ "kind": "EnumMember",
32254
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_ERROR:member",
32255
+ "docComment": "",
32256
+ "excerptTokens": [
32257
+ {
32258
+ "kind": "Content",
32259
+ "text": "MS_ERROR = "
32260
+ },
32261
+ {
32262
+ "kind": "Content",
32263
+ "text": "1"
32264
+ }
32265
+ ],
32266
+ "initializerTokenRange": {
32267
+ "startIndex": 1,
32268
+ "endIndex": 2
32269
+ },
32270
+ "releaseTag": "Public",
32271
+ "name": "MS_ERROR"
32272
+ },
32273
+ {
32274
+ "kind": "EnumMember",
32275
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_LOADING:member",
32276
+ "docComment": "",
32277
+ "excerptTokens": [
32278
+ {
32279
+ "kind": "Content",
32280
+ "text": "MS_LOADING = "
32281
+ },
32282
+ {
32283
+ "kind": "Content",
32284
+ "text": "2"
32285
+ }
32286
+ ],
32287
+ "initializerTokenRange": {
32288
+ "startIndex": 1,
32289
+ "endIndex": 2
32290
+ },
32291
+ "releaseTag": "Public",
32292
+ "name": "MS_LOADING"
32293
+ },
32294
+ {
32295
+ "kind": "EnumMember",
32296
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_NONE:member",
32297
+ "docComment": "",
32298
+ "excerptTokens": [
32299
+ {
32300
+ "kind": "Content",
32301
+ "text": "MS_NONE = "
32302
+ },
32303
+ {
32304
+ "kind": "Content",
32305
+ "text": "0"
32306
+ }
32307
+ ],
32308
+ "initializerTokenRange": {
32309
+ "startIndex": 1,
32310
+ "endIndex": 2
32311
+ },
32312
+ "releaseTag": "Public",
32313
+ "name": "MS_NONE"
32314
+ },
32315
+ {
32316
+ "kind": "EnumMember",
32317
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_PAUSED:member",
32318
+ "docComment": "",
32319
+ "excerptTokens": [
32320
+ {
32321
+ "kind": "Content",
32322
+ "text": "MS_PAUSED = "
32323
+ },
32324
+ {
32325
+ "kind": "Content",
32326
+ "text": "7"
32327
+ }
32328
+ ],
32329
+ "initializerTokenRange": {
32330
+ "startIndex": 1,
32331
+ "endIndex": 2
32332
+ },
32333
+ "releaseTag": "Public",
32334
+ "name": "MS_PAUSED"
32335
+ },
32336
+ {
32337
+ "kind": "EnumMember",
32338
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_PLAYING:member",
32339
+ "docComment": "",
32340
+ "excerptTokens": [
32341
+ {
32342
+ "kind": "Content",
32343
+ "text": "MS_PLAYING = "
32344
+ },
32345
+ {
32346
+ "kind": "Content",
32347
+ "text": "4"
32348
+ }
32349
+ ],
32350
+ "initializerTokenRange": {
32351
+ "startIndex": 1,
32352
+ "endIndex": 2
32353
+ },
32354
+ "releaseTag": "Public",
32355
+ "name": "MS_PLAYING"
32356
+ },
32357
+ {
32358
+ "kind": "EnumMember",
32359
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_READY:member",
32360
+ "docComment": "",
32361
+ "excerptTokens": [
32362
+ {
32363
+ "kind": "Content",
32364
+ "text": "MS_READY = "
32365
+ },
32366
+ {
32367
+ "kind": "Content",
32368
+ "text": "3"
32369
+ }
32370
+ ],
32371
+ "initializerTokenRange": {
32372
+ "startIndex": 1,
32373
+ "endIndex": 2
32374
+ },
32375
+ "releaseTag": "Public",
32376
+ "name": "MS_READY"
32377
+ },
32378
+ {
32379
+ "kind": "EnumMember",
32380
+ "canonicalReference": "@dcl/playground-assets!MediaState.MS_SEEKING:member",
32381
+ "docComment": "",
32382
+ "excerptTokens": [
32383
+ {
32384
+ "kind": "Content",
32385
+ "text": "MS_SEEKING = "
32386
+ },
32387
+ {
32388
+ "kind": "Content",
32389
+ "text": "6"
32390
+ }
32391
+ ],
32392
+ "initializerTokenRange": {
32393
+ "startIndex": 1,
32394
+ "endIndex": 2
32395
+ },
32396
+ "releaseTag": "Public",
32397
+ "name": "MS_SEEKING"
32398
+ }
32399
+ ]
32400
+ },
32069
32401
  {
32070
32402
  "kind": "Variable",
32071
32403
  "canonicalReference": "@dcl/playground-assets!MeshCollider:var",
@@ -35837,7 +36169,7 @@
35837
36169
  {
35838
36170
  "kind": "PropertySignature",
35839
36171
  "canonicalReference": "@dcl/playground-assets!PBAnimationState#loop:member",
35840
- "docComment": "/**\n * whether the animation repeats until stopped (default: true)\n */\n",
36172
+ "docComment": "/**\n * whether the animation repeats (**) until is manually stopped (default: true)\n */\n",
35841
36173
  "excerptTokens": [
35842
36174
  {
35843
36175
  "kind": "Content",
@@ -35891,7 +36223,7 @@
35891
36223
  {
35892
36224
  "kind": "PropertySignature",
35893
36225
  "canonicalReference": "@dcl/playground-assets!PBAnimationState#shouldReset:member",
35894
- "docComment": "/**\n * whether the Entity is restored to its prior state when done\n */\n",
36226
+ "docComment": "/**\n * whether the animation is restored to the initial state (*) when it changes from stopped to playing (default: false)\n */\n",
35895
36227
  "excerptTokens": [
35896
36228
  {
35897
36229
  "kind": "Content",
@@ -35945,7 +36277,7 @@
35945
36277
  {
35946
36278
  "kind": "PropertySignature",
35947
36279
  "canonicalReference": "@dcl/playground-assets!PBAnimationState#weight:member",
35948
- "docComment": "/**\n * the \"weight\" of this animation (see below, default: 1.0)\n */\n",
36280
+ "docComment": "/**\n * the \"weight\" of this animation (see below, default: 1.0)\n *\n * @experimental\n */\n",
35949
36281
  "excerptTokens": [
35950
36282
  {
35951
36283
  "kind": "Content",
@@ -36324,6 +36656,230 @@
36324
36656
  }
36325
36657
  ]
36326
36658
  },
36659
+ {
36660
+ "kind": "Interface",
36661
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent:interface",
36662
+ "docComment": "/**\n * @public\n */\n",
36663
+ "excerptTokens": [
36664
+ {
36665
+ "kind": "Content",
36666
+ "text": "export interface PBAudioEvent "
36667
+ }
36668
+ ],
36669
+ "fileUrlPath": "../ecs/dist/components/generated/pb/decentraland/sdk/components/audio_event.gen.d.ts",
36670
+ "releaseTag": "Public",
36671
+ "name": "PBAudioEvent",
36672
+ "preserveMemberOrder": false,
36673
+ "members": [
36674
+ {
36675
+ "kind": "PropertySignature",
36676
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent#state:member",
36677
+ "docComment": "",
36678
+ "excerptTokens": [
36679
+ {
36680
+ "kind": "Content",
36681
+ "text": "state: "
36682
+ },
36683
+ {
36684
+ "kind": "Reference",
36685
+ "text": "MediaState",
36686
+ "canonicalReference": "@dcl/playground-assets!MediaState:enum"
36687
+ },
36688
+ {
36689
+ "kind": "Content",
36690
+ "text": ";"
36691
+ }
36692
+ ],
36693
+ "isReadonly": false,
36694
+ "isOptional": false,
36695
+ "releaseTag": "Public",
36696
+ "name": "state",
36697
+ "propertyTypeTokenRange": {
36698
+ "startIndex": 1,
36699
+ "endIndex": 2
36700
+ }
36701
+ },
36702
+ {
36703
+ "kind": "PropertySignature",
36704
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent#timestamp:member",
36705
+ "docComment": "/**\n * monotonic counter\n */\n",
36706
+ "excerptTokens": [
36707
+ {
36708
+ "kind": "Content",
36709
+ "text": "timestamp: "
36710
+ },
36711
+ {
36712
+ "kind": "Content",
36713
+ "text": "number"
36714
+ },
36715
+ {
36716
+ "kind": "Content",
36717
+ "text": ";"
36718
+ }
36719
+ ],
36720
+ "isReadonly": false,
36721
+ "isOptional": false,
36722
+ "releaseTag": "Public",
36723
+ "name": "timestamp",
36724
+ "propertyTypeTokenRange": {
36725
+ "startIndex": 1,
36726
+ "endIndex": 2
36727
+ }
36728
+ }
36729
+ ],
36730
+ "extendsTokenRanges": []
36731
+ },
36732
+ {
36733
+ "kind": "Namespace",
36734
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent:namespace",
36735
+ "docComment": "/**\n * @public\n */\n",
36736
+ "excerptTokens": [
36737
+ {
36738
+ "kind": "Content",
36739
+ "text": "export declare namespace PBAudioEvent "
36740
+ }
36741
+ ],
36742
+ "fileUrlPath": "../ecs/dist/components/generated/pb/decentraland/sdk/components/audio_event.gen.d.ts",
36743
+ "releaseTag": "Public",
36744
+ "name": "PBAudioEvent",
36745
+ "preserveMemberOrder": false,
36746
+ "members": [
36747
+ {
36748
+ "kind": "Function",
36749
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent.decode:function(1)",
36750
+ "docComment": "",
36751
+ "excerptTokens": [
36752
+ {
36753
+ "kind": "Content",
36754
+ "text": "function decode(input: "
36755
+ },
36756
+ {
36757
+ "kind": "Reference",
36758
+ "text": "_m0.Reader",
36759
+ "canonicalReference": "protobufjs!Reader:class"
36760
+ },
36761
+ {
36762
+ "kind": "Content",
36763
+ "text": " | "
36764
+ },
36765
+ {
36766
+ "kind": "Reference",
36767
+ "text": "Uint8Array",
36768
+ "canonicalReference": "!Uint8Array:interface"
36769
+ },
36770
+ {
36771
+ "kind": "Content",
36772
+ "text": ", length?: "
36773
+ },
36774
+ {
36775
+ "kind": "Content",
36776
+ "text": "number"
36777
+ },
36778
+ {
36779
+ "kind": "Content",
36780
+ "text": "): "
36781
+ },
36782
+ {
36783
+ "kind": "Reference",
36784
+ "text": "PBAudioEvent",
36785
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent:interface"
36786
+ },
36787
+ {
36788
+ "kind": "Content",
36789
+ "text": ";"
36790
+ }
36791
+ ],
36792
+ "returnTypeTokenRange": {
36793
+ "startIndex": 7,
36794
+ "endIndex": 8
36795
+ },
36796
+ "releaseTag": "Public",
36797
+ "overloadIndex": 1,
36798
+ "parameters": [
36799
+ {
36800
+ "parameterName": "input",
36801
+ "parameterTypeTokenRange": {
36802
+ "startIndex": 1,
36803
+ "endIndex": 4
36804
+ },
36805
+ "isOptional": false
36806
+ },
36807
+ {
36808
+ "parameterName": "length",
36809
+ "parameterTypeTokenRange": {
36810
+ "startIndex": 5,
36811
+ "endIndex": 6
36812
+ },
36813
+ "isOptional": true
36814
+ }
36815
+ ],
36816
+ "name": "decode"
36817
+ },
36818
+ {
36819
+ "kind": "Function",
36820
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent.encode:function(1)",
36821
+ "docComment": "",
36822
+ "excerptTokens": [
36823
+ {
36824
+ "kind": "Content",
36825
+ "text": "function encode(message: "
36826
+ },
36827
+ {
36828
+ "kind": "Reference",
36829
+ "text": "PBAudioEvent",
36830
+ "canonicalReference": "@dcl/playground-assets!PBAudioEvent:interface"
36831
+ },
36832
+ {
36833
+ "kind": "Content",
36834
+ "text": ", writer?: "
36835
+ },
36836
+ {
36837
+ "kind": "Reference",
36838
+ "text": "_m0.Writer",
36839
+ "canonicalReference": "protobufjs!Writer:class"
36840
+ },
36841
+ {
36842
+ "kind": "Content",
36843
+ "text": "): "
36844
+ },
36845
+ {
36846
+ "kind": "Reference",
36847
+ "text": "_m0.Writer",
36848
+ "canonicalReference": "protobufjs!Writer:class"
36849
+ },
36850
+ {
36851
+ "kind": "Content",
36852
+ "text": ";"
36853
+ }
36854
+ ],
36855
+ "returnTypeTokenRange": {
36856
+ "startIndex": 5,
36857
+ "endIndex": 6
36858
+ },
36859
+ "releaseTag": "Public",
36860
+ "overloadIndex": 1,
36861
+ "parameters": [
36862
+ {
36863
+ "parameterName": "message",
36864
+ "parameterTypeTokenRange": {
36865
+ "startIndex": 1,
36866
+ "endIndex": 2
36867
+ },
36868
+ "isOptional": false
36869
+ },
36870
+ {
36871
+ "parameterName": "writer",
36872
+ "parameterTypeTokenRange": {
36873
+ "startIndex": 3,
36874
+ "endIndex": 4
36875
+ },
36876
+ "isOptional": true
36877
+ }
36878
+ ],
36879
+ "name": "encode"
36880
+ }
36881
+ ]
36882
+ },
36327
36883
  {
36328
36884
  "kind": "Interface",
36329
36885
  "canonicalReference": "@dcl/playground-assets!PBAudioSource:interface",