@dcl/playground-assets 7.22.2-23600507492.commit-5f7f8a0 → 7.22.2-23601767788.commit-ff97f2f
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 +140 -1
- package/dist/beta.d.ts +140 -1
- package/dist/index.bundled.d.ts +140 -1
- package/dist/index.js +6 -6
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +140 -1
- package/etc/playground-assets.api.json +2100 -585
- package/etc/playground-assets.api.md +94 -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>>;
|
|
@@ -2697,7 +2757,8 @@ export declare const enum InputAction {
|
|
|
2697
2757
|
IA_ACTION_3 = 10,
|
|
2698
2758
|
IA_ACTION_4 = 11,
|
|
2699
2759
|
IA_ACTION_5 = 12,
|
|
2700
|
-
IA_ACTION_6 = 13
|
|
2760
|
+
IA_ACTION_6 = 13,
|
|
2761
|
+
IA_MODIFIER = 14
|
|
2701
2762
|
}
|
|
2702
2763
|
|
|
2703
2764
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4465,6 +4526,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4465
4526
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4466
4527
|
}
|
|
4467
4528
|
|
|
4529
|
+
/**
|
|
4530
|
+
* @public
|
|
4531
|
+
*/
|
|
4532
|
+
export declare interface PBAudioAnalysis {
|
|
4533
|
+
/** Parameters section */
|
|
4534
|
+
mode: PBAudioAnalysisMode;
|
|
4535
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4536
|
+
amplitudeGain?: number | undefined;
|
|
4537
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4538
|
+
bandsGain?: number | undefined;
|
|
4539
|
+
/** Result section */
|
|
4540
|
+
amplitude: number;
|
|
4541
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4542
|
+
band0: number;
|
|
4543
|
+
band1: number;
|
|
4544
|
+
band2: number;
|
|
4545
|
+
band3: number;
|
|
4546
|
+
band4: number;
|
|
4547
|
+
band5: number;
|
|
4548
|
+
band6: number;
|
|
4549
|
+
band7: number;
|
|
4550
|
+
}
|
|
4551
|
+
|
|
4552
|
+
/**
|
|
4553
|
+
* @public
|
|
4554
|
+
*/
|
|
4555
|
+
export declare namespace PBAudioAnalysis {
|
|
4556
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4557
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4558
|
+
}
|
|
4559
|
+
|
|
4560
|
+
/**
|
|
4561
|
+
* @public
|
|
4562
|
+
*/
|
|
4563
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4564
|
+
MODE_RAW = 0,
|
|
4565
|
+
MODE_LOGARITHMIC = 1
|
|
4566
|
+
}
|
|
4567
|
+
|
|
4468
4568
|
/**
|
|
4469
4569
|
* @public
|
|
4470
4570
|
*/
|
|
@@ -4654,6 +4754,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4654
4754
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4655
4755
|
}
|
|
4656
4756
|
|
|
4757
|
+
/**
|
|
4758
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4759
|
+
* as the avatar movement speed, jump height etc.
|
|
4760
|
+
*/
|
|
4761
|
+
/**
|
|
4762
|
+
* @public
|
|
4763
|
+
*/
|
|
4764
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4765
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4766
|
+
walkSpeed?: number | undefined;
|
|
4767
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4768
|
+
jogSpeed?: number | undefined;
|
|
4769
|
+
/** Maximum speed when running (in meters per second) */
|
|
4770
|
+
runSpeed?: number | undefined;
|
|
4771
|
+
/** Height of a regular jump (in meters) */
|
|
4772
|
+
jumpHeight?: number | undefined;
|
|
4773
|
+
/** Height of a jump while running (in meters) */
|
|
4774
|
+
runJumpHeight?: number | undefined;
|
|
4775
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4776
|
+
hardLandingCooldown?: number | undefined;
|
|
4777
|
+
/** Height of the double jump (in meters) */
|
|
4778
|
+
doubleJumpHeight?: number | undefined;
|
|
4779
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4780
|
+
glidingSpeed?: number | undefined;
|
|
4781
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4782
|
+
glidingFallingSpeed?: number | undefined;
|
|
4783
|
+
}
|
|
4784
|
+
|
|
4785
|
+
/**
|
|
4786
|
+
* @public
|
|
4787
|
+
*/
|
|
4788
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4789
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4790
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4791
|
+
}
|
|
4792
|
+
|
|
4657
4793
|
/**
|
|
4658
4794
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4659
4795
|
* avatar behavior changes.
|
|
@@ -6467,6 +6603,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6467
6603
|
* an 'instant' transition (like using speed/time = 0)
|
|
6468
6604
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6469
6605
|
* the holding entity transform).
|
|
6606
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6470
6607
|
*/
|
|
6471
6608
|
/**
|
|
6472
6609
|
* @public
|
|
@@ -6474,6 +6611,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6474
6611
|
export declare interface PBVirtualCamera {
|
|
6475
6612
|
defaultTransition?: CameraTransition | undefined;
|
|
6476
6613
|
lookAtEntity?: number | undefined;
|
|
6614
|
+
/** default: 60 */
|
|
6615
|
+
fov?: number | undefined;
|
|
6477
6616
|
}
|
|
6478
6617
|
|
|
6479
6618
|
/**
|
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>>;
|
|
@@ -2688,7 +2748,8 @@ export declare const enum InputAction {
|
|
|
2688
2748
|
IA_ACTION_3 = 10,
|
|
2689
2749
|
IA_ACTION_4 = 11,
|
|
2690
2750
|
IA_ACTION_5 = 12,
|
|
2691
|
-
IA_ACTION_6 = 13
|
|
2751
|
+
IA_ACTION_6 = 13,
|
|
2752
|
+
IA_MODIFIER = 14
|
|
2692
2753
|
}
|
|
2693
2754
|
|
|
2694
2755
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4437,6 +4498,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4437
4498
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4438
4499
|
}
|
|
4439
4500
|
|
|
4501
|
+
/**
|
|
4502
|
+
* @public
|
|
4503
|
+
*/
|
|
4504
|
+
export declare interface PBAudioAnalysis {
|
|
4505
|
+
/** Parameters section */
|
|
4506
|
+
mode: PBAudioAnalysisMode;
|
|
4507
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4508
|
+
amplitudeGain?: number | undefined;
|
|
4509
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4510
|
+
bandsGain?: number | undefined;
|
|
4511
|
+
/** Result section */
|
|
4512
|
+
amplitude: number;
|
|
4513
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4514
|
+
band0: number;
|
|
4515
|
+
band1: number;
|
|
4516
|
+
band2: number;
|
|
4517
|
+
band3: number;
|
|
4518
|
+
band4: number;
|
|
4519
|
+
band5: number;
|
|
4520
|
+
band6: number;
|
|
4521
|
+
band7: number;
|
|
4522
|
+
}
|
|
4523
|
+
|
|
4524
|
+
/**
|
|
4525
|
+
* @public
|
|
4526
|
+
*/
|
|
4527
|
+
export declare namespace PBAudioAnalysis {
|
|
4528
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4529
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4530
|
+
}
|
|
4531
|
+
|
|
4532
|
+
/**
|
|
4533
|
+
* @public
|
|
4534
|
+
*/
|
|
4535
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4536
|
+
MODE_RAW = 0,
|
|
4537
|
+
MODE_LOGARITHMIC = 1
|
|
4538
|
+
}
|
|
4539
|
+
|
|
4440
4540
|
/**
|
|
4441
4541
|
* @public
|
|
4442
4542
|
*/
|
|
@@ -4626,6 +4726,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4626
4726
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4627
4727
|
}
|
|
4628
4728
|
|
|
4729
|
+
/**
|
|
4730
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4731
|
+
* as the avatar movement speed, jump height etc.
|
|
4732
|
+
*/
|
|
4733
|
+
/**
|
|
4734
|
+
* @public
|
|
4735
|
+
*/
|
|
4736
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4737
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4738
|
+
walkSpeed?: number | undefined;
|
|
4739
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4740
|
+
jogSpeed?: number | undefined;
|
|
4741
|
+
/** Maximum speed when running (in meters per second) */
|
|
4742
|
+
runSpeed?: number | undefined;
|
|
4743
|
+
/** Height of a regular jump (in meters) */
|
|
4744
|
+
jumpHeight?: number | undefined;
|
|
4745
|
+
/** Height of a jump while running (in meters) */
|
|
4746
|
+
runJumpHeight?: number | undefined;
|
|
4747
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4748
|
+
hardLandingCooldown?: number | undefined;
|
|
4749
|
+
/** Height of the double jump (in meters) */
|
|
4750
|
+
doubleJumpHeight?: number | undefined;
|
|
4751
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4752
|
+
glidingSpeed?: number | undefined;
|
|
4753
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4754
|
+
glidingFallingSpeed?: number | undefined;
|
|
4755
|
+
}
|
|
4756
|
+
|
|
4757
|
+
/**
|
|
4758
|
+
* @public
|
|
4759
|
+
*/
|
|
4760
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4761
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4762
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4763
|
+
}
|
|
4764
|
+
|
|
4629
4765
|
/**
|
|
4630
4766
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4631
4767
|
* avatar behavior changes.
|
|
@@ -6439,6 +6575,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6439
6575
|
* an 'instant' transition (like using speed/time = 0)
|
|
6440
6576
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6441
6577
|
* the holding entity transform).
|
|
6578
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6442
6579
|
*/
|
|
6443
6580
|
/**
|
|
6444
6581
|
* @public
|
|
@@ -6446,6 +6583,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6446
6583
|
export declare interface PBVirtualCamera {
|
|
6447
6584
|
defaultTransition?: CameraTransition | undefined;
|
|
6448
6585
|
lookAtEntity?: number | undefined;
|
|
6586
|
+
/** default: 60 */
|
|
6587
|
+
fov?: number | undefined;
|
|
6449
6588
|
}
|
|
6450
6589
|
|
|
6451
6590
|
/**
|
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>>;
|
|
@@ -2688,7 +2748,8 @@ export declare const enum InputAction {
|
|
|
2688
2748
|
IA_ACTION_3 = 10,
|
|
2689
2749
|
IA_ACTION_4 = 11,
|
|
2690
2750
|
IA_ACTION_5 = 12,
|
|
2691
|
-
IA_ACTION_6 = 13
|
|
2751
|
+
IA_ACTION_6 = 13,
|
|
2752
|
+
IA_MODIFIER = 14
|
|
2692
2753
|
}
|
|
2693
2754
|
|
|
2694
2755
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4437,6 +4498,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4437
4498
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4438
4499
|
}
|
|
4439
4500
|
|
|
4501
|
+
/**
|
|
4502
|
+
* @public
|
|
4503
|
+
*/
|
|
4504
|
+
export declare interface PBAudioAnalysis {
|
|
4505
|
+
/** Parameters section */
|
|
4506
|
+
mode: PBAudioAnalysisMode;
|
|
4507
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4508
|
+
amplitudeGain?: number | undefined;
|
|
4509
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4510
|
+
bandsGain?: number | undefined;
|
|
4511
|
+
/** Result section */
|
|
4512
|
+
amplitude: number;
|
|
4513
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4514
|
+
band0: number;
|
|
4515
|
+
band1: number;
|
|
4516
|
+
band2: number;
|
|
4517
|
+
band3: number;
|
|
4518
|
+
band4: number;
|
|
4519
|
+
band5: number;
|
|
4520
|
+
band6: number;
|
|
4521
|
+
band7: number;
|
|
4522
|
+
}
|
|
4523
|
+
|
|
4524
|
+
/**
|
|
4525
|
+
* @public
|
|
4526
|
+
*/
|
|
4527
|
+
export declare namespace PBAudioAnalysis {
|
|
4528
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4529
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4530
|
+
}
|
|
4531
|
+
|
|
4532
|
+
/**
|
|
4533
|
+
* @public
|
|
4534
|
+
*/
|
|
4535
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4536
|
+
MODE_RAW = 0,
|
|
4537
|
+
MODE_LOGARITHMIC = 1
|
|
4538
|
+
}
|
|
4539
|
+
|
|
4440
4540
|
/**
|
|
4441
4541
|
* @public
|
|
4442
4542
|
*/
|
|
@@ -4626,6 +4726,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4626
4726
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4627
4727
|
}
|
|
4628
4728
|
|
|
4729
|
+
/**
|
|
4730
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4731
|
+
* as the avatar movement speed, jump height etc.
|
|
4732
|
+
*/
|
|
4733
|
+
/**
|
|
4734
|
+
* @public
|
|
4735
|
+
*/
|
|
4736
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4737
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4738
|
+
walkSpeed?: number | undefined;
|
|
4739
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4740
|
+
jogSpeed?: number | undefined;
|
|
4741
|
+
/** Maximum speed when running (in meters per second) */
|
|
4742
|
+
runSpeed?: number | undefined;
|
|
4743
|
+
/** Height of a regular jump (in meters) */
|
|
4744
|
+
jumpHeight?: number | undefined;
|
|
4745
|
+
/** Height of a jump while running (in meters) */
|
|
4746
|
+
runJumpHeight?: number | undefined;
|
|
4747
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4748
|
+
hardLandingCooldown?: number | undefined;
|
|
4749
|
+
/** Height of the double jump (in meters) */
|
|
4750
|
+
doubleJumpHeight?: number | undefined;
|
|
4751
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4752
|
+
glidingSpeed?: number | undefined;
|
|
4753
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4754
|
+
glidingFallingSpeed?: number | undefined;
|
|
4755
|
+
}
|
|
4756
|
+
|
|
4757
|
+
/**
|
|
4758
|
+
* @public
|
|
4759
|
+
*/
|
|
4760
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4761
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4762
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4763
|
+
}
|
|
4764
|
+
|
|
4629
4765
|
/**
|
|
4630
4766
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4631
4767
|
* avatar behavior changes.
|
|
@@ -6439,6 +6575,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6439
6575
|
* an 'instant' transition (like using speed/time = 0)
|
|
6440
6576
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6441
6577
|
* the holding entity transform).
|
|
6578
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6442
6579
|
*/
|
|
6443
6580
|
/**
|
|
6444
6581
|
* @public
|
|
@@ -6446,6 +6583,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6446
6583
|
export declare interface PBVirtualCamera {
|
|
6447
6584
|
defaultTransition?: CameraTransition | undefined;
|
|
6448
6585
|
lookAtEntity?: number | undefined;
|
|
6586
|
+
/** default: 60 */
|
|
6587
|
+
fov?: number | undefined;
|
|
6449
6588
|
}
|
|
6450
6589
|
|
|
6451
6590
|
/**
|