@dcl/playground-assets 7.20.1 → 7.20.2-22104870534.commit-0df3cc0
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 +134 -1
- package/dist/beta.d.ts +134 -1
- package/dist/index.bundled.d.ts +134 -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 +134 -1
- package/etc/playground-assets.api.json +1435 -1
- package/etc/playground-assets.api.md +91 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
+
|
|
120
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
+
/**
|
|
122
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
+
*
|
|
124
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
+
*/
|
|
128
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
+
/**
|
|
130
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
+
*
|
|
132
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
+
*/
|
|
137
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
+
*
|
|
141
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
+
*
|
|
143
|
+
* @param entity - The entity to attach the component to.
|
|
144
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
+
*/
|
|
148
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
+
/**
|
|
151
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
+
*
|
|
153
|
+
* @param entity - The target entity.
|
|
154
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
+
*/
|
|
158
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
+
*
|
|
165
|
+
* `amplitude` represents the aggregated signal strength.
|
|
166
|
+
* `bands` represents the processed frequency bands.
|
|
167
|
+
*/
|
|
168
|
+
export declare type AudioAnalysisView = {
|
|
169
|
+
amplitude: number;
|
|
170
|
+
bands: number[];
|
|
171
|
+
};
|
|
172
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2685,7 +2745,8 @@ export declare const enum InputAction {
|
|
|
2685
2745
|
IA_ACTION_3 = 10,
|
|
2686
2746
|
IA_ACTION_4 = 11,
|
|
2687
2747
|
IA_ACTION_5 = 12,
|
|
2688
|
-
IA_ACTION_6 = 13
|
|
2748
|
+
IA_ACTION_6 = 13,
|
|
2749
|
+
IA_MODIFIER = 14
|
|
2689
2750
|
}
|
|
2690
2751
|
|
|
2691
2752
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4389,6 +4450,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4389
4450
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4390
4451
|
}
|
|
4391
4452
|
|
|
4453
|
+
/**
|
|
4454
|
+
* @public
|
|
4455
|
+
*/
|
|
4456
|
+
export declare interface PBAudioAnalysis {
|
|
4457
|
+
/** Parameters section */
|
|
4458
|
+
mode: PBAudioAnalysisMode;
|
|
4459
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4460
|
+
amplitudeGain?: number | undefined;
|
|
4461
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4462
|
+
bandsGain?: number | undefined;
|
|
4463
|
+
/** Result section */
|
|
4464
|
+
amplitude: number;
|
|
4465
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4466
|
+
band0: number;
|
|
4467
|
+
band1: number;
|
|
4468
|
+
band2: number;
|
|
4469
|
+
band3: number;
|
|
4470
|
+
band4: number;
|
|
4471
|
+
band5: number;
|
|
4472
|
+
band6: number;
|
|
4473
|
+
band7: number;
|
|
4474
|
+
}
|
|
4475
|
+
|
|
4476
|
+
/**
|
|
4477
|
+
* @public
|
|
4478
|
+
*/
|
|
4479
|
+
export declare namespace PBAudioAnalysis {
|
|
4480
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4481
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4482
|
+
}
|
|
4483
|
+
|
|
4484
|
+
/**
|
|
4485
|
+
* @public
|
|
4486
|
+
*/
|
|
4487
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4488
|
+
MODE_RAW = 0,
|
|
4489
|
+
MODE_LOGARITHMIC = 1
|
|
4490
|
+
}
|
|
4491
|
+
|
|
4392
4492
|
/**
|
|
4393
4493
|
* @public
|
|
4394
4494
|
*/
|
|
@@ -4578,6 +4678,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4578
4678
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4579
4679
|
}
|
|
4580
4680
|
|
|
4681
|
+
/**
|
|
4682
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4683
|
+
* as the avatar movement speed, jump height etc.
|
|
4684
|
+
*/
|
|
4685
|
+
/**
|
|
4686
|
+
* @public
|
|
4687
|
+
*/
|
|
4688
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4689
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4690
|
+
walkSpeed?: number | undefined;
|
|
4691
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4692
|
+
jogSpeed?: number | undefined;
|
|
4693
|
+
/** Maximum speed when running (in meters per second) */
|
|
4694
|
+
runSpeed?: number | undefined;
|
|
4695
|
+
/** Height of a regular jump (in meters) */
|
|
4696
|
+
jumpHeight?: number | undefined;
|
|
4697
|
+
/** Height of a jump while running (in meters) */
|
|
4698
|
+
runJumpHeight?: number | undefined;
|
|
4699
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4700
|
+
hardLandingCooldown?: number | undefined;
|
|
4701
|
+
}
|
|
4702
|
+
|
|
4703
|
+
/**
|
|
4704
|
+
* @public
|
|
4705
|
+
*/
|
|
4706
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4707
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4708
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4709
|
+
}
|
|
4710
|
+
|
|
4581
4711
|
/**
|
|
4582
4712
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4583
4713
|
* avatar behavior changes.
|
|
@@ -6329,6 +6459,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6329
6459
|
* an 'instant' transition (like using speed/time = 0)
|
|
6330
6460
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6331
6461
|
* the holding entity transform).
|
|
6462
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6332
6463
|
*/
|
|
6333
6464
|
/**
|
|
6334
6465
|
* @public
|
|
@@ -6336,6 +6467,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6336
6467
|
export declare interface PBVirtualCamera {
|
|
6337
6468
|
defaultTransition?: CameraTransition | undefined;
|
|
6338
6469
|
lookAtEntity?: number | undefined;
|
|
6470
|
+
/** default: 60 */
|
|
6471
|
+
fov?: number | undefined;
|
|
6339
6472
|
}
|
|
6340
6473
|
|
|
6341
6474
|
/**
|
package/dist/beta.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
+
|
|
120
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
+
/**
|
|
122
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
+
*
|
|
124
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
+
*/
|
|
128
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
+
/**
|
|
130
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
+
*
|
|
132
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
+
*/
|
|
137
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
+
*
|
|
141
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
+
*
|
|
143
|
+
* @param entity - The entity to attach the component to.
|
|
144
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
+
*/
|
|
148
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
+
/**
|
|
151
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
+
*
|
|
153
|
+
* @param entity - The target entity.
|
|
154
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
+
*/
|
|
158
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
+
*
|
|
165
|
+
* `amplitude` represents the aggregated signal strength.
|
|
166
|
+
* `bands` represents the processed frequency bands.
|
|
167
|
+
*/
|
|
168
|
+
export declare type AudioAnalysisView = {
|
|
169
|
+
amplitude: number;
|
|
170
|
+
bands: number[];
|
|
171
|
+
};
|
|
172
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2676,7 +2736,8 @@ export declare const enum InputAction {
|
|
|
2676
2736
|
IA_ACTION_3 = 10,
|
|
2677
2737
|
IA_ACTION_4 = 11,
|
|
2678
2738
|
IA_ACTION_5 = 12,
|
|
2679
|
-
IA_ACTION_6 = 13
|
|
2739
|
+
IA_ACTION_6 = 13,
|
|
2740
|
+
IA_MODIFIER = 14
|
|
2680
2741
|
}
|
|
2681
2742
|
|
|
2682
2743
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4361,6 +4422,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4361
4422
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4362
4423
|
}
|
|
4363
4424
|
|
|
4425
|
+
/**
|
|
4426
|
+
* @public
|
|
4427
|
+
*/
|
|
4428
|
+
export declare interface PBAudioAnalysis {
|
|
4429
|
+
/** Parameters section */
|
|
4430
|
+
mode: PBAudioAnalysisMode;
|
|
4431
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4432
|
+
amplitudeGain?: number | undefined;
|
|
4433
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4434
|
+
bandsGain?: number | undefined;
|
|
4435
|
+
/** Result section */
|
|
4436
|
+
amplitude: number;
|
|
4437
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4438
|
+
band0: number;
|
|
4439
|
+
band1: number;
|
|
4440
|
+
band2: number;
|
|
4441
|
+
band3: number;
|
|
4442
|
+
band4: number;
|
|
4443
|
+
band5: number;
|
|
4444
|
+
band6: number;
|
|
4445
|
+
band7: number;
|
|
4446
|
+
}
|
|
4447
|
+
|
|
4448
|
+
/**
|
|
4449
|
+
* @public
|
|
4450
|
+
*/
|
|
4451
|
+
export declare namespace PBAudioAnalysis {
|
|
4452
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4453
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4454
|
+
}
|
|
4455
|
+
|
|
4456
|
+
/**
|
|
4457
|
+
* @public
|
|
4458
|
+
*/
|
|
4459
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4460
|
+
MODE_RAW = 0,
|
|
4461
|
+
MODE_LOGARITHMIC = 1
|
|
4462
|
+
}
|
|
4463
|
+
|
|
4364
4464
|
/**
|
|
4365
4465
|
* @public
|
|
4366
4466
|
*/
|
|
@@ -4550,6 +4650,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4550
4650
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4551
4651
|
}
|
|
4552
4652
|
|
|
4653
|
+
/**
|
|
4654
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4655
|
+
* as the avatar movement speed, jump height etc.
|
|
4656
|
+
*/
|
|
4657
|
+
/**
|
|
4658
|
+
* @public
|
|
4659
|
+
*/
|
|
4660
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4661
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4662
|
+
walkSpeed?: number | undefined;
|
|
4663
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4664
|
+
jogSpeed?: number | undefined;
|
|
4665
|
+
/** Maximum speed when running (in meters per second) */
|
|
4666
|
+
runSpeed?: number | undefined;
|
|
4667
|
+
/** Height of a regular jump (in meters) */
|
|
4668
|
+
jumpHeight?: number | undefined;
|
|
4669
|
+
/** Height of a jump while running (in meters) */
|
|
4670
|
+
runJumpHeight?: number | undefined;
|
|
4671
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4672
|
+
hardLandingCooldown?: number | undefined;
|
|
4673
|
+
}
|
|
4674
|
+
|
|
4675
|
+
/**
|
|
4676
|
+
* @public
|
|
4677
|
+
*/
|
|
4678
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4679
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4680
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4681
|
+
}
|
|
4682
|
+
|
|
4553
4683
|
/**
|
|
4554
4684
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4555
4685
|
* avatar behavior changes.
|
|
@@ -6301,6 +6431,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6301
6431
|
* an 'instant' transition (like using speed/time = 0)
|
|
6302
6432
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6303
6433
|
* the holding entity transform).
|
|
6434
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6304
6435
|
*/
|
|
6305
6436
|
/**
|
|
6306
6437
|
* @public
|
|
@@ -6308,6 +6439,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6308
6439
|
export declare interface PBVirtualCamera {
|
|
6309
6440
|
defaultTransition?: CameraTransition | undefined;
|
|
6310
6441
|
lookAtEntity?: number | undefined;
|
|
6442
|
+
/** default: 60 */
|
|
6443
|
+
fov?: number | undefined;
|
|
6311
6444
|
}
|
|
6312
6445
|
|
|
6313
6446
|
/**
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
+
|
|
120
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
+
/**
|
|
122
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
+
*
|
|
124
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
+
*/
|
|
128
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
+
/**
|
|
130
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
+
*
|
|
132
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
+
*/
|
|
137
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
+
*
|
|
141
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
+
*
|
|
143
|
+
* @param entity - The entity to attach the component to.
|
|
144
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
+
*/
|
|
148
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
+
/**
|
|
151
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
+
*
|
|
153
|
+
* @param entity - The target entity.
|
|
154
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
+
*/
|
|
158
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
+
*
|
|
165
|
+
* `amplitude` represents the aggregated signal strength.
|
|
166
|
+
* `bands` represents the processed frequency bands.
|
|
167
|
+
*/
|
|
168
|
+
export declare type AudioAnalysisView = {
|
|
169
|
+
amplitude: number;
|
|
170
|
+
bands: number[];
|
|
171
|
+
};
|
|
172
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2676,7 +2736,8 @@ export declare const enum InputAction {
|
|
|
2676
2736
|
IA_ACTION_3 = 10,
|
|
2677
2737
|
IA_ACTION_4 = 11,
|
|
2678
2738
|
IA_ACTION_5 = 12,
|
|
2679
|
-
IA_ACTION_6 = 13
|
|
2739
|
+
IA_ACTION_6 = 13,
|
|
2740
|
+
IA_MODIFIER = 14
|
|
2680
2741
|
}
|
|
2681
2742
|
|
|
2682
2743
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4361,6 +4422,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4361
4422
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4362
4423
|
}
|
|
4363
4424
|
|
|
4425
|
+
/**
|
|
4426
|
+
* @public
|
|
4427
|
+
*/
|
|
4428
|
+
export declare interface PBAudioAnalysis {
|
|
4429
|
+
/** Parameters section */
|
|
4430
|
+
mode: PBAudioAnalysisMode;
|
|
4431
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4432
|
+
amplitudeGain?: number | undefined;
|
|
4433
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4434
|
+
bandsGain?: number | undefined;
|
|
4435
|
+
/** Result section */
|
|
4436
|
+
amplitude: number;
|
|
4437
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4438
|
+
band0: number;
|
|
4439
|
+
band1: number;
|
|
4440
|
+
band2: number;
|
|
4441
|
+
band3: number;
|
|
4442
|
+
band4: number;
|
|
4443
|
+
band5: number;
|
|
4444
|
+
band6: number;
|
|
4445
|
+
band7: number;
|
|
4446
|
+
}
|
|
4447
|
+
|
|
4448
|
+
/**
|
|
4449
|
+
* @public
|
|
4450
|
+
*/
|
|
4451
|
+
export declare namespace PBAudioAnalysis {
|
|
4452
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4453
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4454
|
+
}
|
|
4455
|
+
|
|
4456
|
+
/**
|
|
4457
|
+
* @public
|
|
4458
|
+
*/
|
|
4459
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4460
|
+
MODE_RAW = 0,
|
|
4461
|
+
MODE_LOGARITHMIC = 1
|
|
4462
|
+
}
|
|
4463
|
+
|
|
4364
4464
|
/**
|
|
4365
4465
|
* @public
|
|
4366
4466
|
*/
|
|
@@ -4550,6 +4650,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4550
4650
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4551
4651
|
}
|
|
4552
4652
|
|
|
4653
|
+
/**
|
|
4654
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4655
|
+
* as the avatar movement speed, jump height etc.
|
|
4656
|
+
*/
|
|
4657
|
+
/**
|
|
4658
|
+
* @public
|
|
4659
|
+
*/
|
|
4660
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4661
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4662
|
+
walkSpeed?: number | undefined;
|
|
4663
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4664
|
+
jogSpeed?: number | undefined;
|
|
4665
|
+
/** Maximum speed when running (in meters per second) */
|
|
4666
|
+
runSpeed?: number | undefined;
|
|
4667
|
+
/** Height of a regular jump (in meters) */
|
|
4668
|
+
jumpHeight?: number | undefined;
|
|
4669
|
+
/** Height of a jump while running (in meters) */
|
|
4670
|
+
runJumpHeight?: number | undefined;
|
|
4671
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4672
|
+
hardLandingCooldown?: number | undefined;
|
|
4673
|
+
}
|
|
4674
|
+
|
|
4675
|
+
/**
|
|
4676
|
+
* @public
|
|
4677
|
+
*/
|
|
4678
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4679
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4680
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4681
|
+
}
|
|
4682
|
+
|
|
4553
4683
|
/**
|
|
4554
4684
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4555
4685
|
* avatar behavior changes.
|
|
@@ -6301,6 +6431,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6301
6431
|
* an 'instant' transition (like using speed/time = 0)
|
|
6302
6432
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6303
6433
|
* the holding entity transform).
|
|
6434
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6304
6435
|
*/
|
|
6305
6436
|
/**
|
|
6306
6437
|
* @public
|
|
@@ -6308,6 +6439,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6308
6439
|
export declare interface PBVirtualCamera {
|
|
6309
6440
|
defaultTransition?: CameraTransition | undefined;
|
|
6310
6441
|
lookAtEntity?: number | undefined;
|
|
6442
|
+
/** default: 60 */
|
|
6443
|
+
fov?: number | undefined;
|
|
6311
6444
|
}
|
|
6312
6445
|
|
|
6313
6446
|
/**
|