@dcl/playground-assets 7.18.2-21453292414.commit-1da934f → 7.18.2-21458377493.commit-ea4f3b6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alpha.d.ts +160 -1
- package/dist/beta.d.ts +160 -1
- package/dist/index.bundled.d.ts +160 -1
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +160 -1
- package/etc/playground-assets.api.json +2075 -614
- package/etc/playground-assets.api.md +93 -0
- package/package.json +4 -4
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dcl/sdk",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "7.18.2-
|
|
4
|
+
"version": "7.18.2-21458377493.commit-ea4f3b6",
|
|
5
5
|
"author": "Decentraland",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@dcl/ecs": "file:../ecs",
|
|
@@ -35,5 +35,5 @@
|
|
|
35
35
|
},
|
|
36
36
|
"types": "./index.d.ts",
|
|
37
37
|
"typings": "./index.d.ts",
|
|
38
|
-
"commit": "
|
|
38
|
+
"commit": "ea4f3b6e07da35b43506558fd0038b660475a0f9"
|
|
39
39
|
}
|
|
@@ -90,6 +90,61 @@ export declare namespace AppendValueOperation {
|
|
|
90
90
|
*/
|
|
91
91
|
export declare function areConnected(parcels: Coords[]): boolean;
|
|
92
92
|
|
|
93
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
94
|
+
|
|
95
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
96
|
+
/**
|
|
97
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
98
|
+
*
|
|
99
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
100
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
101
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
102
|
+
*/
|
|
103
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
104
|
+
/**
|
|
105
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
106
|
+
*
|
|
107
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
108
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
109
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
110
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
111
|
+
*/
|
|
112
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
115
|
+
*
|
|
116
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
117
|
+
*
|
|
118
|
+
* @param entity - The entity to attach the component to.
|
|
119
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
120
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
121
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
122
|
+
*/
|
|
123
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
124
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
125
|
+
/**
|
|
126
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
127
|
+
*
|
|
128
|
+
* @param entity - The target entity.
|
|
129
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
130
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
131
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
132
|
+
*/
|
|
133
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
134
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
139
|
+
*
|
|
140
|
+
* `amplitude` represents the aggregated signal strength.
|
|
141
|
+
* `bands` represents the processed frequency bands.
|
|
142
|
+
*/
|
|
143
|
+
export declare type AudioAnalysisView = {
|
|
144
|
+
amplitude: number;
|
|
145
|
+
bands: number[];
|
|
146
|
+
};
|
|
147
|
+
|
|
93
148
|
/** @public */
|
|
94
149
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
95
150
|
|
|
@@ -184,6 +239,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
184
239
|
/** @public */
|
|
185
240
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
186
241
|
|
|
242
|
+
/** @public */
|
|
243
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
244
|
+
|
|
187
245
|
/** @public */
|
|
188
246
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
189
247
|
|
|
@@ -1294,6 +1352,7 @@ export declare type ComponentDefinition<T> = LastWriteWinElementSetComponentDefi
|
|
|
1294
1352
|
/** public */
|
|
1295
1353
|
export declare const componentDefinitionByName: {
|
|
1296
1354
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1355
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1297
1356
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1298
1357
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1299
1358
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1301,6 +1360,7 @@ export declare const componentDefinitionByName: {
|
|
|
1301
1360
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1302
1361
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1303
1362
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1363
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1304
1364
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1305
1365
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1306
1366
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2004,6 +2064,7 @@ export declare type EventSystemOptions = {
|
|
|
2004
2064
|
maxDistance?: number;
|
|
2005
2065
|
showFeedback?: boolean;
|
|
2006
2066
|
showHighlight?: boolean;
|
|
2067
|
+
maxPlayerDistance?: number;
|
|
2007
2068
|
};
|
|
2008
2069
|
|
|
2009
2070
|
/**
|
|
@@ -2657,7 +2718,8 @@ export declare const enum InputAction {
|
|
|
2657
2718
|
IA_ACTION_3 = 10,
|
|
2658
2719
|
IA_ACTION_4 = 11,
|
|
2659
2720
|
IA_ACTION_5 = 12,
|
|
2660
|
-
IA_ACTION_6 = 13
|
|
2721
|
+
IA_ACTION_6 = 13,
|
|
2722
|
+
IA_MODIFIER = 14
|
|
2661
2723
|
}
|
|
2662
2724
|
|
|
2663
2725
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4320,6 +4382,45 @@ export declare namespace PBAnimator {
|
|
|
4320
4382
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4321
4383
|
}
|
|
4322
4384
|
|
|
4385
|
+
/**
|
|
4386
|
+
* @public
|
|
4387
|
+
*/
|
|
4388
|
+
export declare interface PBAudioAnalysis {
|
|
4389
|
+
/** Parameters section */
|
|
4390
|
+
mode: PBAudioAnalysisMode;
|
|
4391
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4392
|
+
amplitudeGain?: number | undefined;
|
|
4393
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4394
|
+
bandsGain?: number | undefined;
|
|
4395
|
+
/** Result section */
|
|
4396
|
+
amplitude: number;
|
|
4397
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4398
|
+
band0: number;
|
|
4399
|
+
band1: number;
|
|
4400
|
+
band2: number;
|
|
4401
|
+
band3: number;
|
|
4402
|
+
band4: number;
|
|
4403
|
+
band5: number;
|
|
4404
|
+
band6: number;
|
|
4405
|
+
band7: number;
|
|
4406
|
+
}
|
|
4407
|
+
|
|
4408
|
+
/**
|
|
4409
|
+
* @public
|
|
4410
|
+
*/
|
|
4411
|
+
export declare namespace PBAudioAnalysis {
|
|
4412
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4413
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4414
|
+
}
|
|
4415
|
+
|
|
4416
|
+
/**
|
|
4417
|
+
* @public
|
|
4418
|
+
*/
|
|
4419
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4420
|
+
MODE_RAW = 0,
|
|
4421
|
+
MODE_LOGARITHMIC = 1
|
|
4422
|
+
}
|
|
4423
|
+
|
|
4323
4424
|
/**
|
|
4324
4425
|
* @public
|
|
4325
4426
|
*/
|
|
@@ -4509,6 +4610,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4509
4610
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4510
4611
|
}
|
|
4511
4612
|
|
|
4613
|
+
/**
|
|
4614
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4615
|
+
* as the avatar movement speed, jump height etc.
|
|
4616
|
+
*/
|
|
4617
|
+
/**
|
|
4618
|
+
* @public
|
|
4619
|
+
*/
|
|
4620
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4621
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4622
|
+
walkSpeed?: number | undefined;
|
|
4623
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4624
|
+
jogSpeed?: number | undefined;
|
|
4625
|
+
/** Maximum speed when running (in meters per second) */
|
|
4626
|
+
runSpeed?: number | undefined;
|
|
4627
|
+
/** Height of a regular jump (in meters) */
|
|
4628
|
+
jumpHeight?: number | undefined;
|
|
4629
|
+
/** Height of a jump while running (in meters) */
|
|
4630
|
+
runJumpHeight?: number | undefined;
|
|
4631
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4632
|
+
hardLandingCooldown?: number | undefined;
|
|
4633
|
+
}
|
|
4634
|
+
|
|
4635
|
+
/**
|
|
4636
|
+
* @public
|
|
4637
|
+
*/
|
|
4638
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4639
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4640
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4641
|
+
}
|
|
4642
|
+
|
|
4512
4643
|
/**
|
|
4513
4644
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4514
4645
|
* avatar behavior changes.
|
|
@@ -5313,6 +5444,29 @@ export declare namespace PBPlayerIdentityData {
|
|
|
5313
5444
|
*
|
|
5314
5445
|
* It also supports simple visual feedback when interactions occur, by showing floating text.
|
|
5315
5446
|
* More sophisticated feedback requires the use of other components.
|
|
5447
|
+
*
|
|
5448
|
+
* Distance rules
|
|
5449
|
+
* --------------
|
|
5450
|
+
* PointerEvents can enforce interaction range using two independent distance checks:
|
|
5451
|
+
*
|
|
5452
|
+
* - Camera distance (`max_distance`): distance from the active camera to the target entity.
|
|
5453
|
+
* - Player distance (`max_player_distance`): distance from the avatar/player position to the target entity.
|
|
5454
|
+
*
|
|
5455
|
+
* How the interaction checks are combined:
|
|
5456
|
+
*
|
|
5457
|
+
* 1) Only `max_distance` is present
|
|
5458
|
+
* - The interaction is allowed only if the camera distance is <= `max_distance`.
|
|
5459
|
+
*
|
|
5460
|
+
* 2) Only `max_player_distance` is present
|
|
5461
|
+
* - The interaction is allowed only if the player distance is <= `max_player_distance`.
|
|
5462
|
+
*
|
|
5463
|
+
* 3) Both `max_distance` and `max_player_distance` are present
|
|
5464
|
+
* - The interaction is allowed if ANY of the checks passes (OR logic):
|
|
5465
|
+
* (camera distance <= `max_distance`) OR (player distance <= `max_player_distance`).
|
|
5466
|
+
*
|
|
5467
|
+
* 4) Neither `max_distance` nor `max_player_distance` is present
|
|
5468
|
+
* - The system behaves as if `max_distance` were set to its default value (10),
|
|
5469
|
+
* i.e., it uses the camera distance check with a threshold of 10.
|
|
5316
5470
|
*/
|
|
5317
5471
|
/**
|
|
5318
5472
|
* @public
|
|
@@ -5362,6 +5516,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5362
5516
|
showFeedback?: boolean | undefined;
|
|
5363
5517
|
/** enable or disable hover highlight (default true) */
|
|
5364
5518
|
showHighlight?: boolean | undefined;
|
|
5519
|
+
/** range of interaction from the avatar's position (default 0) */
|
|
5520
|
+
maxPlayerDistance?: number | undefined;
|
|
5365
5521
|
}
|
|
5366
5522
|
|
|
5367
5523
|
/**
|
|
@@ -6235,6 +6391,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6235
6391
|
* an 'instant' transition (like using speed/time = 0)
|
|
6236
6392
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6237
6393
|
* the holding entity transform).
|
|
6394
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6238
6395
|
*/
|
|
6239
6396
|
/**
|
|
6240
6397
|
* @public
|
|
@@ -6242,6 +6399,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6242
6399
|
export declare interface PBVirtualCamera {
|
|
6243
6400
|
defaultTransition?: CameraTransition | undefined;
|
|
6244
6401
|
lookAtEntity?: number | undefined;
|
|
6402
|
+
/** default: 60 */
|
|
6403
|
+
fov?: number | undefined;
|
|
6245
6404
|
}
|
|
6246
6405
|
|
|
6247
6406
|
/**
|