@dcl/playground-assets 7.22.3 → 7.22.4-24244806167.commit-6559014
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 +149 -1
- package/dist/beta.d.ts +149 -1
- package/dist/index.bundled.d.ts +149 -1
- package/dist/index.js +5 -5
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +6 -0
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +149 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +2513 -939
- package/etc/playground-assets.api.md +102 -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
|
|
|
@@ -206,9 +261,21 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
206
261
|
/** @public */
|
|
207
262
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
208
263
|
|
|
264
|
+
/** Mask for which bones an animation applies to. */
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export declare const enum AvatarEmoteMask {
|
|
269
|
+
AEM_FULL_BODY = 0,
|
|
270
|
+
AEM_UPPER_BODY = 1
|
|
271
|
+
}
|
|
272
|
+
|
|
209
273
|
/** @public */
|
|
210
274
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
275
|
|
|
276
|
+
/** @public */
|
|
277
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
278
|
+
|
|
212
279
|
/** @public */
|
|
213
280
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
281
|
|
|
@@ -1338,6 +1405,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1405
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1406
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1407
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1408
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1409
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1410
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1411
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1413,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1413
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1414
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1415
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1416
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1417
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1418
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1419
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2732,7 +2801,8 @@ export declare const enum InputAction {
|
|
|
2732
2801
|
IA_ACTION_3 = 10,
|
|
2733
2802
|
IA_ACTION_4 = 11,
|
|
2734
2803
|
IA_ACTION_5 = 12,
|
|
2735
|
-
IA_ACTION_6 = 13
|
|
2804
|
+
IA_ACTION_6 = 13,
|
|
2805
|
+
IA_MODIFIER = 14
|
|
2736
2806
|
}
|
|
2737
2807
|
|
|
2738
2808
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4524,6 +4594,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4524
4594
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4525
4595
|
}
|
|
4526
4596
|
|
|
4597
|
+
/**
|
|
4598
|
+
* @public
|
|
4599
|
+
*/
|
|
4600
|
+
export declare interface PBAudioAnalysis {
|
|
4601
|
+
/** Parameters section */
|
|
4602
|
+
mode: PBAudioAnalysisMode;
|
|
4603
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4604
|
+
amplitudeGain?: number | undefined;
|
|
4605
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4606
|
+
bandsGain?: number | undefined;
|
|
4607
|
+
/** Result section */
|
|
4608
|
+
amplitude: number;
|
|
4609
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4610
|
+
band0: number;
|
|
4611
|
+
band1: number;
|
|
4612
|
+
band2: number;
|
|
4613
|
+
band3: number;
|
|
4614
|
+
band4: number;
|
|
4615
|
+
band5: number;
|
|
4616
|
+
band6: number;
|
|
4617
|
+
band7: number;
|
|
4618
|
+
}
|
|
4619
|
+
|
|
4620
|
+
/**
|
|
4621
|
+
* @public
|
|
4622
|
+
*/
|
|
4623
|
+
export declare namespace PBAudioAnalysis {
|
|
4624
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4625
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4626
|
+
}
|
|
4627
|
+
|
|
4628
|
+
/**
|
|
4629
|
+
* @public
|
|
4630
|
+
*/
|
|
4631
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4632
|
+
MODE_RAW = 0,
|
|
4633
|
+
MODE_LOGARITHMIC = 1
|
|
4634
|
+
}
|
|
4635
|
+
|
|
4527
4636
|
/**
|
|
4528
4637
|
* @public
|
|
4529
4638
|
*/
|
|
@@ -4713,6 +4822,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4713
4822
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4714
4823
|
}
|
|
4715
4824
|
|
|
4825
|
+
/**
|
|
4826
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4827
|
+
* as the avatar movement speed, jump height etc.
|
|
4828
|
+
*/
|
|
4829
|
+
/**
|
|
4830
|
+
* @public
|
|
4831
|
+
*/
|
|
4832
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4833
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4834
|
+
walkSpeed?: number | undefined;
|
|
4835
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4836
|
+
jogSpeed?: number | undefined;
|
|
4837
|
+
/** Maximum speed when running (in meters per second) */
|
|
4838
|
+
runSpeed?: number | undefined;
|
|
4839
|
+
/** Height of a regular jump (in meters) */
|
|
4840
|
+
jumpHeight?: number | undefined;
|
|
4841
|
+
/** Height of a jump while running (in meters) */
|
|
4842
|
+
runJumpHeight?: number | undefined;
|
|
4843
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4844
|
+
hardLandingCooldown?: number | undefined;
|
|
4845
|
+
/** Height of the double jump (in meters) */
|
|
4846
|
+
doubleJumpHeight?: number | undefined;
|
|
4847
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4848
|
+
glidingSpeed?: number | undefined;
|
|
4849
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4850
|
+
glidingFallingSpeed?: number | undefined;
|
|
4851
|
+
}
|
|
4852
|
+
|
|
4853
|
+
/**
|
|
4854
|
+
* @public
|
|
4855
|
+
*/
|
|
4856
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4857
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4858
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4859
|
+
}
|
|
4860
|
+
|
|
4716
4861
|
/**
|
|
4717
4862
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4718
4863
|
* avatar behavior changes.
|
|
@@ -6772,6 +6917,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6772
6917
|
* an 'instant' transition (like using speed/time = 0)
|
|
6773
6918
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6774
6919
|
* the holding entity transform).
|
|
6920
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6775
6921
|
*/
|
|
6776
6922
|
/**
|
|
6777
6923
|
* @public
|
|
@@ -6779,6 +6925,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6779
6925
|
export declare interface PBVirtualCamera {
|
|
6780
6926
|
defaultTransition?: CameraTransition | undefined;
|
|
6781
6927
|
lookAtEntity?: number | undefined;
|
|
6928
|
+
/** default: 60 */
|
|
6929
|
+
fov?: number | undefined;
|
|
6782
6930
|
}
|
|
6783
6931
|
|
|
6784
6932
|
/**
|
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
|
|
|
@@ -206,9 +261,21 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
206
261
|
/** @public */
|
|
207
262
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
208
263
|
|
|
264
|
+
/** Mask for which bones an animation applies to. */
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export declare const enum AvatarEmoteMask {
|
|
269
|
+
AEM_FULL_BODY = 0,
|
|
270
|
+
AEM_UPPER_BODY = 1
|
|
271
|
+
}
|
|
272
|
+
|
|
209
273
|
/** @public */
|
|
210
274
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
275
|
|
|
276
|
+
/** @public */
|
|
277
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
278
|
+
|
|
212
279
|
/** @public */
|
|
213
280
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
281
|
|
|
@@ -1338,6 +1405,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1405
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1406
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1407
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1408
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1409
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1410
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1411
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1413,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1413
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1414
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1415
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1416
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1417
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1418
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1419
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2723,7 +2792,8 @@ export declare const enum InputAction {
|
|
|
2723
2792
|
IA_ACTION_3 = 10,
|
|
2724
2793
|
IA_ACTION_4 = 11,
|
|
2725
2794
|
IA_ACTION_5 = 12,
|
|
2726
|
-
IA_ACTION_6 = 13
|
|
2795
|
+
IA_ACTION_6 = 13,
|
|
2796
|
+
IA_MODIFIER = 14
|
|
2727
2797
|
}
|
|
2728
2798
|
|
|
2729
2799
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4496,6 +4566,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4496
4566
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4497
4567
|
}
|
|
4498
4568
|
|
|
4569
|
+
/**
|
|
4570
|
+
* @public
|
|
4571
|
+
*/
|
|
4572
|
+
export declare interface PBAudioAnalysis {
|
|
4573
|
+
/** Parameters section */
|
|
4574
|
+
mode: PBAudioAnalysisMode;
|
|
4575
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4576
|
+
amplitudeGain?: number | undefined;
|
|
4577
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4578
|
+
bandsGain?: number | undefined;
|
|
4579
|
+
/** Result section */
|
|
4580
|
+
amplitude: number;
|
|
4581
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4582
|
+
band0: number;
|
|
4583
|
+
band1: number;
|
|
4584
|
+
band2: number;
|
|
4585
|
+
band3: number;
|
|
4586
|
+
band4: number;
|
|
4587
|
+
band5: number;
|
|
4588
|
+
band6: number;
|
|
4589
|
+
band7: number;
|
|
4590
|
+
}
|
|
4591
|
+
|
|
4592
|
+
/**
|
|
4593
|
+
* @public
|
|
4594
|
+
*/
|
|
4595
|
+
export declare namespace PBAudioAnalysis {
|
|
4596
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4597
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4598
|
+
}
|
|
4599
|
+
|
|
4600
|
+
/**
|
|
4601
|
+
* @public
|
|
4602
|
+
*/
|
|
4603
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4604
|
+
MODE_RAW = 0,
|
|
4605
|
+
MODE_LOGARITHMIC = 1
|
|
4606
|
+
}
|
|
4607
|
+
|
|
4499
4608
|
/**
|
|
4500
4609
|
* @public
|
|
4501
4610
|
*/
|
|
@@ -4685,6 +4794,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4685
4794
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4686
4795
|
}
|
|
4687
4796
|
|
|
4797
|
+
/**
|
|
4798
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4799
|
+
* as the avatar movement speed, jump height etc.
|
|
4800
|
+
*/
|
|
4801
|
+
/**
|
|
4802
|
+
* @public
|
|
4803
|
+
*/
|
|
4804
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4805
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4806
|
+
walkSpeed?: number | undefined;
|
|
4807
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4808
|
+
jogSpeed?: number | undefined;
|
|
4809
|
+
/** Maximum speed when running (in meters per second) */
|
|
4810
|
+
runSpeed?: number | undefined;
|
|
4811
|
+
/** Height of a regular jump (in meters) */
|
|
4812
|
+
jumpHeight?: number | undefined;
|
|
4813
|
+
/** Height of a jump while running (in meters) */
|
|
4814
|
+
runJumpHeight?: number | undefined;
|
|
4815
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4816
|
+
hardLandingCooldown?: number | undefined;
|
|
4817
|
+
/** Height of the double jump (in meters) */
|
|
4818
|
+
doubleJumpHeight?: number | undefined;
|
|
4819
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4820
|
+
glidingSpeed?: number | undefined;
|
|
4821
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4822
|
+
glidingFallingSpeed?: number | undefined;
|
|
4823
|
+
}
|
|
4824
|
+
|
|
4825
|
+
/**
|
|
4826
|
+
* @public
|
|
4827
|
+
*/
|
|
4828
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4829
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4830
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4831
|
+
}
|
|
4832
|
+
|
|
4688
4833
|
/**
|
|
4689
4834
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4690
4835
|
* avatar behavior changes.
|
|
@@ -6744,6 +6889,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6744
6889
|
* an 'instant' transition (like using speed/time = 0)
|
|
6745
6890
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6746
6891
|
* the holding entity transform).
|
|
6892
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6747
6893
|
*/
|
|
6748
6894
|
/**
|
|
6749
6895
|
* @public
|
|
@@ -6751,6 +6897,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6751
6897
|
export declare interface PBVirtualCamera {
|
|
6752
6898
|
defaultTransition?: CameraTransition | undefined;
|
|
6753
6899
|
lookAtEntity?: number | undefined;
|
|
6900
|
+
/** default: 60 */
|
|
6901
|
+
fov?: number | undefined;
|
|
6754
6902
|
}
|
|
6755
6903
|
|
|
6756
6904
|
/**
|
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
|
|
|
@@ -206,9 +261,21 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
206
261
|
/** @public */
|
|
207
262
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
208
263
|
|
|
264
|
+
/** Mask for which bones an animation applies to. */
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export declare const enum AvatarEmoteMask {
|
|
269
|
+
AEM_FULL_BODY = 0,
|
|
270
|
+
AEM_UPPER_BODY = 1
|
|
271
|
+
}
|
|
272
|
+
|
|
209
273
|
/** @public */
|
|
210
274
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
275
|
|
|
276
|
+
/** @public */
|
|
277
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
278
|
+
|
|
212
279
|
/** @public */
|
|
213
280
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
281
|
|
|
@@ -1338,6 +1405,7 @@ export declare const componentDefinitionByName: {
|
|
|
1338
1405
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1339
1406
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1340
1407
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1408
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1341
1409
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1342
1410
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1343
1411
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1345,6 +1413,7 @@ export declare const componentDefinitionByName: {
|
|
|
1345
1413
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1346
1414
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1347
1415
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1416
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1348
1417
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1349
1418
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1350
1419
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2723,7 +2792,8 @@ export declare const enum InputAction {
|
|
|
2723
2792
|
IA_ACTION_3 = 10,
|
|
2724
2793
|
IA_ACTION_4 = 11,
|
|
2725
2794
|
IA_ACTION_5 = 12,
|
|
2726
|
-
IA_ACTION_6 = 13
|
|
2795
|
+
IA_ACTION_6 = 13,
|
|
2796
|
+
IA_MODIFIER = 14
|
|
2727
2797
|
}
|
|
2728
2798
|
|
|
2729
2799
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4496,6 +4566,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4496
4566
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4497
4567
|
}
|
|
4498
4568
|
|
|
4569
|
+
/**
|
|
4570
|
+
* @public
|
|
4571
|
+
*/
|
|
4572
|
+
export declare interface PBAudioAnalysis {
|
|
4573
|
+
/** Parameters section */
|
|
4574
|
+
mode: PBAudioAnalysisMode;
|
|
4575
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4576
|
+
amplitudeGain?: number | undefined;
|
|
4577
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4578
|
+
bandsGain?: number | undefined;
|
|
4579
|
+
/** Result section */
|
|
4580
|
+
amplitude: number;
|
|
4581
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4582
|
+
band0: number;
|
|
4583
|
+
band1: number;
|
|
4584
|
+
band2: number;
|
|
4585
|
+
band3: number;
|
|
4586
|
+
band4: number;
|
|
4587
|
+
band5: number;
|
|
4588
|
+
band6: number;
|
|
4589
|
+
band7: number;
|
|
4590
|
+
}
|
|
4591
|
+
|
|
4592
|
+
/**
|
|
4593
|
+
* @public
|
|
4594
|
+
*/
|
|
4595
|
+
export declare namespace PBAudioAnalysis {
|
|
4596
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4597
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4598
|
+
}
|
|
4599
|
+
|
|
4600
|
+
/**
|
|
4601
|
+
* @public
|
|
4602
|
+
*/
|
|
4603
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4604
|
+
MODE_RAW = 0,
|
|
4605
|
+
MODE_LOGARITHMIC = 1
|
|
4606
|
+
}
|
|
4607
|
+
|
|
4499
4608
|
/**
|
|
4500
4609
|
* @public
|
|
4501
4610
|
*/
|
|
@@ -4685,6 +4794,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4685
4794
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4686
4795
|
}
|
|
4687
4796
|
|
|
4797
|
+
/**
|
|
4798
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4799
|
+
* as the avatar movement speed, jump height etc.
|
|
4800
|
+
*/
|
|
4801
|
+
/**
|
|
4802
|
+
* @public
|
|
4803
|
+
*/
|
|
4804
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4805
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4806
|
+
walkSpeed?: number | undefined;
|
|
4807
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4808
|
+
jogSpeed?: number | undefined;
|
|
4809
|
+
/** Maximum speed when running (in meters per second) */
|
|
4810
|
+
runSpeed?: number | undefined;
|
|
4811
|
+
/** Height of a regular jump (in meters) */
|
|
4812
|
+
jumpHeight?: number | undefined;
|
|
4813
|
+
/** Height of a jump while running (in meters) */
|
|
4814
|
+
runJumpHeight?: number | undefined;
|
|
4815
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4816
|
+
hardLandingCooldown?: number | undefined;
|
|
4817
|
+
/** Height of the double jump (in meters) */
|
|
4818
|
+
doubleJumpHeight?: number | undefined;
|
|
4819
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4820
|
+
glidingSpeed?: number | undefined;
|
|
4821
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4822
|
+
glidingFallingSpeed?: number | undefined;
|
|
4823
|
+
}
|
|
4824
|
+
|
|
4825
|
+
/**
|
|
4826
|
+
* @public
|
|
4827
|
+
*/
|
|
4828
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4829
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4830
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4831
|
+
}
|
|
4832
|
+
|
|
4688
4833
|
/**
|
|
4689
4834
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4690
4835
|
* avatar behavior changes.
|
|
@@ -6744,6 +6889,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6744
6889
|
* an 'instant' transition (like using speed/time = 0)
|
|
6745
6890
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6746
6891
|
* the holding entity transform).
|
|
6892
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6747
6893
|
*/
|
|
6748
6894
|
/**
|
|
6749
6895
|
* @public
|
|
@@ -6751,6 +6897,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6751
6897
|
export declare interface PBVirtualCamera {
|
|
6752
6898
|
defaultTransition?: CameraTransition | undefined;
|
|
6753
6899
|
lookAtEntity?: number | undefined;
|
|
6900
|
+
/** default: 60 */
|
|
6901
|
+
fov?: number | undefined;
|
|
6754
6902
|
}
|
|
6755
6903
|
|
|
6756
6904
|
/**
|