@dcl/playground-assets 7.22.3-24081083817.commit-714809b → 7.22.3-24082946861.commit-0d8c4f2
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
|
|
|
@@ -1338,6 +1396,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1396
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1397
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1398
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1399
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1400
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1401
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1402
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1404,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1404
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1405
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1406
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1407
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1408
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1409
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1410
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2732,7 +2792,8 @@ export declare const enum InputAction {
|
|
|
2732
2792
|
IA_ACTION_3 = 10,
|
|
2733
2793
|
IA_ACTION_4 = 11,
|
|
2734
2794
|
IA_ACTION_5 = 12,
|
|
2735
|
-
IA_ACTION_6 = 13
|
|
2795
|
+
IA_ACTION_6 = 13,
|
|
2796
|
+
IA_MODIFIER = 14
|
|
2736
2797
|
}
|
|
2737
2798
|
|
|
2738
2799
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4524,6 +4585,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4524
4585
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4525
4586
|
}
|
|
4526
4587
|
|
|
4588
|
+
/**
|
|
4589
|
+
* @public
|
|
4590
|
+
*/
|
|
4591
|
+
export declare interface PBAudioAnalysis {
|
|
4592
|
+
/** Parameters section */
|
|
4593
|
+
mode: PBAudioAnalysisMode;
|
|
4594
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4595
|
+
amplitudeGain?: number | undefined;
|
|
4596
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4597
|
+
bandsGain?: number | undefined;
|
|
4598
|
+
/** Result section */
|
|
4599
|
+
amplitude: number;
|
|
4600
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4601
|
+
band0: number;
|
|
4602
|
+
band1: number;
|
|
4603
|
+
band2: number;
|
|
4604
|
+
band3: number;
|
|
4605
|
+
band4: number;
|
|
4606
|
+
band5: number;
|
|
4607
|
+
band6: number;
|
|
4608
|
+
band7: number;
|
|
4609
|
+
}
|
|
4610
|
+
|
|
4611
|
+
/**
|
|
4612
|
+
* @public
|
|
4613
|
+
*/
|
|
4614
|
+
export declare namespace PBAudioAnalysis {
|
|
4615
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4616
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4617
|
+
}
|
|
4618
|
+
|
|
4619
|
+
/**
|
|
4620
|
+
* @public
|
|
4621
|
+
*/
|
|
4622
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4623
|
+
MODE_RAW = 0,
|
|
4624
|
+
MODE_LOGARITHMIC = 1
|
|
4625
|
+
}
|
|
4626
|
+
|
|
4527
4627
|
/**
|
|
4528
4628
|
* @public
|
|
4529
4629
|
*/
|
|
@@ -4713,6 +4813,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4713
4813
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4714
4814
|
}
|
|
4715
4815
|
|
|
4816
|
+
/**
|
|
4817
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4818
|
+
* as the avatar movement speed, jump height etc.
|
|
4819
|
+
*/
|
|
4820
|
+
/**
|
|
4821
|
+
* @public
|
|
4822
|
+
*/
|
|
4823
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4824
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4825
|
+
walkSpeed?: number | undefined;
|
|
4826
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4827
|
+
jogSpeed?: number | undefined;
|
|
4828
|
+
/** Maximum speed when running (in meters per second) */
|
|
4829
|
+
runSpeed?: number | undefined;
|
|
4830
|
+
/** Height of a regular jump (in meters) */
|
|
4831
|
+
jumpHeight?: number | undefined;
|
|
4832
|
+
/** Height of a jump while running (in meters) */
|
|
4833
|
+
runJumpHeight?: number | undefined;
|
|
4834
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4835
|
+
hardLandingCooldown?: number | undefined;
|
|
4836
|
+
/** Height of the double jump (in meters) */
|
|
4837
|
+
doubleJumpHeight?: number | undefined;
|
|
4838
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4839
|
+
glidingSpeed?: number | undefined;
|
|
4840
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4841
|
+
glidingFallingSpeed?: number | undefined;
|
|
4842
|
+
}
|
|
4843
|
+
|
|
4844
|
+
/**
|
|
4845
|
+
* @public
|
|
4846
|
+
*/
|
|
4847
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4848
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4849
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4850
|
+
}
|
|
4851
|
+
|
|
4716
4852
|
/**
|
|
4717
4853
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4718
4854
|
* avatar behavior changes.
|
|
@@ -6772,6 +6908,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6772
6908
|
* an 'instant' transition (like using speed/time = 0)
|
|
6773
6909
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6774
6910
|
* the holding entity transform).
|
|
6911
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6775
6912
|
*/
|
|
6776
6913
|
/**
|
|
6777
6914
|
* @public
|
|
@@ -6779,6 +6916,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6779
6916
|
export declare interface PBVirtualCamera {
|
|
6780
6917
|
defaultTransition?: CameraTransition | undefined;
|
|
6781
6918
|
lookAtEntity?: number | undefined;
|
|
6919
|
+
/** default: 60 */
|
|
6920
|
+
fov?: number | undefined;
|
|
6782
6921
|
}
|
|
6783
6922
|
|
|
6784
6923
|
/**
|
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
|
|
|
@@ -1338,6 +1396,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1396
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1397
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1398
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1399
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1400
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1401
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1402
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1404,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1404
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1405
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1406
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1407
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1408
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1409
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1410
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2723,7 +2783,8 @@ export declare const enum InputAction {
|
|
|
2723
2783
|
IA_ACTION_3 = 10,
|
|
2724
2784
|
IA_ACTION_4 = 11,
|
|
2725
2785
|
IA_ACTION_5 = 12,
|
|
2726
|
-
IA_ACTION_6 = 13
|
|
2786
|
+
IA_ACTION_6 = 13,
|
|
2787
|
+
IA_MODIFIER = 14
|
|
2727
2788
|
}
|
|
2728
2789
|
|
|
2729
2790
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4496,6 +4557,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4496
4557
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4497
4558
|
}
|
|
4498
4559
|
|
|
4560
|
+
/**
|
|
4561
|
+
* @public
|
|
4562
|
+
*/
|
|
4563
|
+
export declare interface PBAudioAnalysis {
|
|
4564
|
+
/** Parameters section */
|
|
4565
|
+
mode: PBAudioAnalysisMode;
|
|
4566
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4567
|
+
amplitudeGain?: number | undefined;
|
|
4568
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4569
|
+
bandsGain?: number | undefined;
|
|
4570
|
+
/** Result section */
|
|
4571
|
+
amplitude: number;
|
|
4572
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4573
|
+
band0: number;
|
|
4574
|
+
band1: number;
|
|
4575
|
+
band2: number;
|
|
4576
|
+
band3: number;
|
|
4577
|
+
band4: number;
|
|
4578
|
+
band5: number;
|
|
4579
|
+
band6: number;
|
|
4580
|
+
band7: number;
|
|
4581
|
+
}
|
|
4582
|
+
|
|
4583
|
+
/**
|
|
4584
|
+
* @public
|
|
4585
|
+
*/
|
|
4586
|
+
export declare namespace PBAudioAnalysis {
|
|
4587
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4588
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4589
|
+
}
|
|
4590
|
+
|
|
4591
|
+
/**
|
|
4592
|
+
* @public
|
|
4593
|
+
*/
|
|
4594
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4595
|
+
MODE_RAW = 0,
|
|
4596
|
+
MODE_LOGARITHMIC = 1
|
|
4597
|
+
}
|
|
4598
|
+
|
|
4499
4599
|
/**
|
|
4500
4600
|
* @public
|
|
4501
4601
|
*/
|
|
@@ -4685,6 +4785,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4685
4785
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4686
4786
|
}
|
|
4687
4787
|
|
|
4788
|
+
/**
|
|
4789
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4790
|
+
* as the avatar movement speed, jump height etc.
|
|
4791
|
+
*/
|
|
4792
|
+
/**
|
|
4793
|
+
* @public
|
|
4794
|
+
*/
|
|
4795
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4796
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4797
|
+
walkSpeed?: number | undefined;
|
|
4798
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4799
|
+
jogSpeed?: number | undefined;
|
|
4800
|
+
/** Maximum speed when running (in meters per second) */
|
|
4801
|
+
runSpeed?: number | undefined;
|
|
4802
|
+
/** Height of a regular jump (in meters) */
|
|
4803
|
+
jumpHeight?: number | undefined;
|
|
4804
|
+
/** Height of a jump while running (in meters) */
|
|
4805
|
+
runJumpHeight?: number | undefined;
|
|
4806
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4807
|
+
hardLandingCooldown?: number | undefined;
|
|
4808
|
+
/** Height of the double jump (in meters) */
|
|
4809
|
+
doubleJumpHeight?: number | undefined;
|
|
4810
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4811
|
+
glidingSpeed?: number | undefined;
|
|
4812
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4813
|
+
glidingFallingSpeed?: number | undefined;
|
|
4814
|
+
}
|
|
4815
|
+
|
|
4816
|
+
/**
|
|
4817
|
+
* @public
|
|
4818
|
+
*/
|
|
4819
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4820
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4821
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4822
|
+
}
|
|
4823
|
+
|
|
4688
4824
|
/**
|
|
4689
4825
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4690
4826
|
* avatar behavior changes.
|
|
@@ -6744,6 +6880,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6744
6880
|
* an 'instant' transition (like using speed/time = 0)
|
|
6745
6881
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6746
6882
|
* the holding entity transform).
|
|
6883
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6747
6884
|
*/
|
|
6748
6885
|
/**
|
|
6749
6886
|
* @public
|
|
@@ -6751,6 +6888,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6751
6888
|
export declare interface PBVirtualCamera {
|
|
6752
6889
|
defaultTransition?: CameraTransition | undefined;
|
|
6753
6890
|
lookAtEntity?: number | undefined;
|
|
6891
|
+
/** default: 60 */
|
|
6892
|
+
fov?: number | undefined;
|
|
6754
6893
|
}
|
|
6755
6894
|
|
|
6756
6895
|
/**
|
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
|
|
|
@@ -1338,6 +1396,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1396
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1397
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1398
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1399
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1400
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1401
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1402
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1404,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1404
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1405
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1406
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1407
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1408
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1409
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1410
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2723,7 +2783,8 @@ export declare const enum InputAction {
|
|
|
2723
2783
|
IA_ACTION_3 = 10,
|
|
2724
2784
|
IA_ACTION_4 = 11,
|
|
2725
2785
|
IA_ACTION_5 = 12,
|
|
2726
|
-
IA_ACTION_6 = 13
|
|
2786
|
+
IA_ACTION_6 = 13,
|
|
2787
|
+
IA_MODIFIER = 14
|
|
2727
2788
|
}
|
|
2728
2789
|
|
|
2729
2790
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4496,6 +4557,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4496
4557
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4497
4558
|
}
|
|
4498
4559
|
|
|
4560
|
+
/**
|
|
4561
|
+
* @public
|
|
4562
|
+
*/
|
|
4563
|
+
export declare interface PBAudioAnalysis {
|
|
4564
|
+
/** Parameters section */
|
|
4565
|
+
mode: PBAudioAnalysisMode;
|
|
4566
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4567
|
+
amplitudeGain?: number | undefined;
|
|
4568
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4569
|
+
bandsGain?: number | undefined;
|
|
4570
|
+
/** Result section */
|
|
4571
|
+
amplitude: number;
|
|
4572
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4573
|
+
band0: number;
|
|
4574
|
+
band1: number;
|
|
4575
|
+
band2: number;
|
|
4576
|
+
band3: number;
|
|
4577
|
+
band4: number;
|
|
4578
|
+
band5: number;
|
|
4579
|
+
band6: number;
|
|
4580
|
+
band7: number;
|
|
4581
|
+
}
|
|
4582
|
+
|
|
4583
|
+
/**
|
|
4584
|
+
* @public
|
|
4585
|
+
*/
|
|
4586
|
+
export declare namespace PBAudioAnalysis {
|
|
4587
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4588
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4589
|
+
}
|
|
4590
|
+
|
|
4591
|
+
/**
|
|
4592
|
+
* @public
|
|
4593
|
+
*/
|
|
4594
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4595
|
+
MODE_RAW = 0,
|
|
4596
|
+
MODE_LOGARITHMIC = 1
|
|
4597
|
+
}
|
|
4598
|
+
|
|
4499
4599
|
/**
|
|
4500
4600
|
* @public
|
|
4501
4601
|
*/
|
|
@@ -4685,6 +4785,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4685
4785
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4686
4786
|
}
|
|
4687
4787
|
|
|
4788
|
+
/**
|
|
4789
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4790
|
+
* as the avatar movement speed, jump height etc.
|
|
4791
|
+
*/
|
|
4792
|
+
/**
|
|
4793
|
+
* @public
|
|
4794
|
+
*/
|
|
4795
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4796
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4797
|
+
walkSpeed?: number | undefined;
|
|
4798
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4799
|
+
jogSpeed?: number | undefined;
|
|
4800
|
+
/** Maximum speed when running (in meters per second) */
|
|
4801
|
+
runSpeed?: number | undefined;
|
|
4802
|
+
/** Height of a regular jump (in meters) */
|
|
4803
|
+
jumpHeight?: number | undefined;
|
|
4804
|
+
/** Height of a jump while running (in meters) */
|
|
4805
|
+
runJumpHeight?: number | undefined;
|
|
4806
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4807
|
+
hardLandingCooldown?: number | undefined;
|
|
4808
|
+
/** Height of the double jump (in meters) */
|
|
4809
|
+
doubleJumpHeight?: number | undefined;
|
|
4810
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4811
|
+
glidingSpeed?: number | undefined;
|
|
4812
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4813
|
+
glidingFallingSpeed?: number | undefined;
|
|
4814
|
+
}
|
|
4815
|
+
|
|
4816
|
+
/**
|
|
4817
|
+
* @public
|
|
4818
|
+
*/
|
|
4819
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4820
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4821
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4822
|
+
}
|
|
4823
|
+
|
|
4688
4824
|
/**
|
|
4689
4825
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4690
4826
|
* avatar behavior changes.
|
|
@@ -6744,6 +6880,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6744
6880
|
* an 'instant' transition (like using speed/time = 0)
|
|
6745
6881
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6746
6882
|
* the holding entity transform).
|
|
6883
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6747
6884
|
*/
|
|
6748
6885
|
/**
|
|
6749
6886
|
* @public
|
|
@@ -6751,6 +6888,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6751
6888
|
export declare interface PBVirtualCamera {
|
|
6752
6889
|
defaultTransition?: CameraTransition | undefined;
|
|
6753
6890
|
lookAtEntity?: number | undefined;
|
|
6891
|
+
/** default: 60 */
|
|
6892
|
+
fov?: number | undefined;
|
|
6754
6893
|
}
|
|
6755
6894
|
|
|
6756
6895
|
/**
|