@dcl/playground-assets 7.18.2-21457748765.commit-7ae2e38 → 7.18.2-21458377493.commit-ea4f3b6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alpha.d.ts +134 -1
- package/dist/beta.d.ts +134 -1
- package/dist/index.bundled.d.ts +134 -1
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +134 -1
- package/etc/playground-assets.api.json +1435 -1
- package/etc/playground-assets.api.md +91 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -90,6 +90,61 @@ export declare namespace AppendValueOperation {
|
|
|
90
90
|
*/
|
|
91
91
|
export declare function areConnected(parcels: Coords[]): boolean;
|
|
92
92
|
|
|
93
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
94
|
+
|
|
95
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
96
|
+
/**
|
|
97
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
98
|
+
*
|
|
99
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
100
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
101
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
102
|
+
*/
|
|
103
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
104
|
+
/**
|
|
105
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
106
|
+
*
|
|
107
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
108
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
109
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
110
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
111
|
+
*/
|
|
112
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
115
|
+
*
|
|
116
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
117
|
+
*
|
|
118
|
+
* @param entity - The entity to attach the component to.
|
|
119
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
120
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
121
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
122
|
+
*/
|
|
123
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
124
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
125
|
+
/**
|
|
126
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
127
|
+
*
|
|
128
|
+
* @param entity - The target entity.
|
|
129
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
130
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
131
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
132
|
+
*/
|
|
133
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
134
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
139
|
+
*
|
|
140
|
+
* `amplitude` represents the aggregated signal strength.
|
|
141
|
+
* `bands` represents the processed frequency bands.
|
|
142
|
+
*/
|
|
143
|
+
export declare type AudioAnalysisView = {
|
|
144
|
+
amplitude: number;
|
|
145
|
+
bands: number[];
|
|
146
|
+
};
|
|
147
|
+
|
|
93
148
|
/** @public */
|
|
94
149
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
95
150
|
|
|
@@ -184,6 +239,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
184
239
|
/** @public */
|
|
185
240
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
186
241
|
|
|
242
|
+
/** @public */
|
|
243
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
244
|
+
|
|
187
245
|
/** @public */
|
|
188
246
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
189
247
|
|
|
@@ -1294,6 +1352,7 @@ export declare type ComponentDefinition<T> = LastWriteWinElementSetComponentDefi
|
|
|
1294
1352
|
/** public */
|
|
1295
1353
|
export declare const componentDefinitionByName: {
|
|
1296
1354
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1355
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1297
1356
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1298
1357
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1299
1358
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1301,6 +1360,7 @@ export declare const componentDefinitionByName: {
|
|
|
1301
1360
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1302
1361
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1303
1362
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1363
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1304
1364
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1305
1365
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1306
1366
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2658,7 +2718,8 @@ export declare const enum InputAction {
|
|
|
2658
2718
|
IA_ACTION_3 = 10,
|
|
2659
2719
|
IA_ACTION_4 = 11,
|
|
2660
2720
|
IA_ACTION_5 = 12,
|
|
2661
|
-
IA_ACTION_6 = 13
|
|
2721
|
+
IA_ACTION_6 = 13,
|
|
2722
|
+
IA_MODIFIER = 14
|
|
2662
2723
|
}
|
|
2663
2724
|
|
|
2664
2725
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4321,6 +4382,45 @@ export declare namespace PBAnimator {
|
|
|
4321
4382
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4322
4383
|
}
|
|
4323
4384
|
|
|
4385
|
+
/**
|
|
4386
|
+
* @public
|
|
4387
|
+
*/
|
|
4388
|
+
export declare interface PBAudioAnalysis {
|
|
4389
|
+
/** Parameters section */
|
|
4390
|
+
mode: PBAudioAnalysisMode;
|
|
4391
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4392
|
+
amplitudeGain?: number | undefined;
|
|
4393
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4394
|
+
bandsGain?: number | undefined;
|
|
4395
|
+
/** Result section */
|
|
4396
|
+
amplitude: number;
|
|
4397
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4398
|
+
band0: number;
|
|
4399
|
+
band1: number;
|
|
4400
|
+
band2: number;
|
|
4401
|
+
band3: number;
|
|
4402
|
+
band4: number;
|
|
4403
|
+
band5: number;
|
|
4404
|
+
band6: number;
|
|
4405
|
+
band7: number;
|
|
4406
|
+
}
|
|
4407
|
+
|
|
4408
|
+
/**
|
|
4409
|
+
* @public
|
|
4410
|
+
*/
|
|
4411
|
+
export declare namespace PBAudioAnalysis {
|
|
4412
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4413
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4414
|
+
}
|
|
4415
|
+
|
|
4416
|
+
/**
|
|
4417
|
+
* @public
|
|
4418
|
+
*/
|
|
4419
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4420
|
+
MODE_RAW = 0,
|
|
4421
|
+
MODE_LOGARITHMIC = 1
|
|
4422
|
+
}
|
|
4423
|
+
|
|
4324
4424
|
/**
|
|
4325
4425
|
* @public
|
|
4326
4426
|
*/
|
|
@@ -4510,6 +4610,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4510
4610
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4511
4611
|
}
|
|
4512
4612
|
|
|
4613
|
+
/**
|
|
4614
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4615
|
+
* as the avatar movement speed, jump height etc.
|
|
4616
|
+
*/
|
|
4617
|
+
/**
|
|
4618
|
+
* @public
|
|
4619
|
+
*/
|
|
4620
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4621
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4622
|
+
walkSpeed?: number | undefined;
|
|
4623
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4624
|
+
jogSpeed?: number | undefined;
|
|
4625
|
+
/** Maximum speed when running (in meters per second) */
|
|
4626
|
+
runSpeed?: number | undefined;
|
|
4627
|
+
/** Height of a regular jump (in meters) */
|
|
4628
|
+
jumpHeight?: number | undefined;
|
|
4629
|
+
/** Height of a jump while running (in meters) */
|
|
4630
|
+
runJumpHeight?: number | undefined;
|
|
4631
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4632
|
+
hardLandingCooldown?: number | undefined;
|
|
4633
|
+
}
|
|
4634
|
+
|
|
4635
|
+
/**
|
|
4636
|
+
* @public
|
|
4637
|
+
*/
|
|
4638
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4639
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4640
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4641
|
+
}
|
|
4642
|
+
|
|
4513
4643
|
/**
|
|
4514
4644
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4515
4645
|
* avatar behavior changes.
|
|
@@ -6261,6 +6391,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6261
6391
|
* an 'instant' transition (like using speed/time = 0)
|
|
6262
6392
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6263
6393
|
* the holding entity transform).
|
|
6394
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6264
6395
|
*/
|
|
6265
6396
|
/**
|
|
6266
6397
|
* @public
|
|
@@ -6268,6 +6399,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6268
6399
|
export declare interface PBVirtualCamera {
|
|
6269
6400
|
defaultTransition?: CameraTransition | undefined;
|
|
6270
6401
|
lookAtEntity?: number | undefined;
|
|
6402
|
+
/** default: 60 */
|
|
6403
|
+
fov?: number | undefined;
|
|
6271
6404
|
}
|
|
6272
6405
|
|
|
6273
6406
|
/**
|
package/dist/beta.d.ts
CHANGED
|
@@ -90,6 +90,61 @@ export declare namespace AppendValueOperation {
|
|
|
90
90
|
*/
|
|
91
91
|
export declare function areConnected(parcels: Coords[]): boolean;
|
|
92
92
|
|
|
93
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
94
|
+
|
|
95
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
96
|
+
/**
|
|
97
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
98
|
+
*
|
|
99
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
100
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
101
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
102
|
+
*/
|
|
103
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
104
|
+
/**
|
|
105
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
106
|
+
*
|
|
107
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
108
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
109
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
110
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
111
|
+
*/
|
|
112
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
115
|
+
*
|
|
116
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
117
|
+
*
|
|
118
|
+
* @param entity - The entity to attach the component to.
|
|
119
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
120
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
121
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
122
|
+
*/
|
|
123
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
124
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
125
|
+
/**
|
|
126
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
127
|
+
*
|
|
128
|
+
* @param entity - The target entity.
|
|
129
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
130
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
131
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
132
|
+
*/
|
|
133
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
134
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
139
|
+
*
|
|
140
|
+
* `amplitude` represents the aggregated signal strength.
|
|
141
|
+
* `bands` represents the processed frequency bands.
|
|
142
|
+
*/
|
|
143
|
+
export declare type AudioAnalysisView = {
|
|
144
|
+
amplitude: number;
|
|
145
|
+
bands: number[];
|
|
146
|
+
};
|
|
147
|
+
|
|
93
148
|
/** @public */
|
|
94
149
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
95
150
|
|
|
@@ -184,6 +239,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
184
239
|
/** @public */
|
|
185
240
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
186
241
|
|
|
242
|
+
/** @public */
|
|
243
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
244
|
+
|
|
187
245
|
/** @public */
|
|
188
246
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
189
247
|
|
|
@@ -1294,6 +1352,7 @@ export declare type ComponentDefinition<T> = LastWriteWinElementSetComponentDefi
|
|
|
1294
1352
|
/** public */
|
|
1295
1353
|
export declare const componentDefinitionByName: {
|
|
1296
1354
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1355
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1297
1356
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1298
1357
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1299
1358
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1301,6 +1360,7 @@ export declare const componentDefinitionByName: {
|
|
|
1301
1360
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1302
1361
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1303
1362
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1363
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1304
1364
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1305
1365
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1306
1366
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2649,7 +2709,8 @@ export declare const enum InputAction {
|
|
|
2649
2709
|
IA_ACTION_3 = 10,
|
|
2650
2710
|
IA_ACTION_4 = 11,
|
|
2651
2711
|
IA_ACTION_5 = 12,
|
|
2652
|
-
IA_ACTION_6 = 13
|
|
2712
|
+
IA_ACTION_6 = 13,
|
|
2713
|
+
IA_MODIFIER = 14
|
|
2653
2714
|
}
|
|
2654
2715
|
|
|
2655
2716
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4293,6 +4354,45 @@ export declare namespace PBAnimator {
|
|
|
4293
4354
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4294
4355
|
}
|
|
4295
4356
|
|
|
4357
|
+
/**
|
|
4358
|
+
* @public
|
|
4359
|
+
*/
|
|
4360
|
+
export declare interface PBAudioAnalysis {
|
|
4361
|
+
/** Parameters section */
|
|
4362
|
+
mode: PBAudioAnalysisMode;
|
|
4363
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4364
|
+
amplitudeGain?: number | undefined;
|
|
4365
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4366
|
+
bandsGain?: number | undefined;
|
|
4367
|
+
/** Result section */
|
|
4368
|
+
amplitude: number;
|
|
4369
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4370
|
+
band0: number;
|
|
4371
|
+
band1: number;
|
|
4372
|
+
band2: number;
|
|
4373
|
+
band3: number;
|
|
4374
|
+
band4: number;
|
|
4375
|
+
band5: number;
|
|
4376
|
+
band6: number;
|
|
4377
|
+
band7: number;
|
|
4378
|
+
}
|
|
4379
|
+
|
|
4380
|
+
/**
|
|
4381
|
+
* @public
|
|
4382
|
+
*/
|
|
4383
|
+
export declare namespace PBAudioAnalysis {
|
|
4384
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4385
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4386
|
+
}
|
|
4387
|
+
|
|
4388
|
+
/**
|
|
4389
|
+
* @public
|
|
4390
|
+
*/
|
|
4391
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4392
|
+
MODE_RAW = 0,
|
|
4393
|
+
MODE_LOGARITHMIC = 1
|
|
4394
|
+
}
|
|
4395
|
+
|
|
4296
4396
|
/**
|
|
4297
4397
|
* @public
|
|
4298
4398
|
*/
|
|
@@ -4482,6 +4582,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4482
4582
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4483
4583
|
}
|
|
4484
4584
|
|
|
4585
|
+
/**
|
|
4586
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4587
|
+
* as the avatar movement speed, jump height etc.
|
|
4588
|
+
*/
|
|
4589
|
+
/**
|
|
4590
|
+
* @public
|
|
4591
|
+
*/
|
|
4592
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4593
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4594
|
+
walkSpeed?: number | undefined;
|
|
4595
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4596
|
+
jogSpeed?: number | undefined;
|
|
4597
|
+
/** Maximum speed when running (in meters per second) */
|
|
4598
|
+
runSpeed?: number | undefined;
|
|
4599
|
+
/** Height of a regular jump (in meters) */
|
|
4600
|
+
jumpHeight?: number | undefined;
|
|
4601
|
+
/** Height of a jump while running (in meters) */
|
|
4602
|
+
runJumpHeight?: number | undefined;
|
|
4603
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4604
|
+
hardLandingCooldown?: number | undefined;
|
|
4605
|
+
}
|
|
4606
|
+
|
|
4607
|
+
/**
|
|
4608
|
+
* @public
|
|
4609
|
+
*/
|
|
4610
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4611
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4612
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4613
|
+
}
|
|
4614
|
+
|
|
4485
4615
|
/**
|
|
4486
4616
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4487
4617
|
* avatar behavior changes.
|
|
@@ -6233,6 +6363,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6233
6363
|
* an 'instant' transition (like using speed/time = 0)
|
|
6234
6364
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6235
6365
|
* the holding entity transform).
|
|
6366
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6236
6367
|
*/
|
|
6237
6368
|
/**
|
|
6238
6369
|
* @public
|
|
@@ -6240,6 +6371,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6240
6371
|
export declare interface PBVirtualCamera {
|
|
6241
6372
|
defaultTransition?: CameraTransition | undefined;
|
|
6242
6373
|
lookAtEntity?: number | undefined;
|
|
6374
|
+
/** default: 60 */
|
|
6375
|
+
fov?: number | undefined;
|
|
6243
6376
|
}
|
|
6244
6377
|
|
|
6245
6378
|
/**
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -90,6 +90,61 @@ export declare namespace AppendValueOperation {
|
|
|
90
90
|
*/
|
|
91
91
|
export declare function areConnected(parcels: Coords[]): boolean;
|
|
92
92
|
|
|
93
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
94
|
+
|
|
95
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
96
|
+
/**
|
|
97
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
98
|
+
*
|
|
99
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
100
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
101
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
102
|
+
*/
|
|
103
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
104
|
+
/**
|
|
105
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
106
|
+
*
|
|
107
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
108
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
109
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
110
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
111
|
+
*/
|
|
112
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
115
|
+
*
|
|
116
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
117
|
+
*
|
|
118
|
+
* @param entity - The entity to attach the component to.
|
|
119
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
120
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
121
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
122
|
+
*/
|
|
123
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
124
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
125
|
+
/**
|
|
126
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
127
|
+
*
|
|
128
|
+
* @param entity - The target entity.
|
|
129
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
130
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
131
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
132
|
+
*/
|
|
133
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
134
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
139
|
+
*
|
|
140
|
+
* `amplitude` represents the aggregated signal strength.
|
|
141
|
+
* `bands` represents the processed frequency bands.
|
|
142
|
+
*/
|
|
143
|
+
export declare type AudioAnalysisView = {
|
|
144
|
+
amplitude: number;
|
|
145
|
+
bands: number[];
|
|
146
|
+
};
|
|
147
|
+
|
|
93
148
|
/** @public */
|
|
94
149
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
95
150
|
|
|
@@ -184,6 +239,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
184
239
|
/** @public */
|
|
185
240
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
186
241
|
|
|
242
|
+
/** @public */
|
|
243
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
244
|
+
|
|
187
245
|
/** @public */
|
|
188
246
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
189
247
|
|
|
@@ -1294,6 +1352,7 @@ export declare type ComponentDefinition<T> = LastWriteWinElementSetComponentDefi
|
|
|
1294
1352
|
/** public */
|
|
1295
1353
|
export declare const componentDefinitionByName: {
|
|
1296
1354
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1355
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1297
1356
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1298
1357
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1299
1358
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1301,6 +1360,7 @@ export declare const componentDefinitionByName: {
|
|
|
1301
1360
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1302
1361
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1303
1362
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1363
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1304
1364
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1305
1365
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1306
1366
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2649,7 +2709,8 @@ export declare const enum InputAction {
|
|
|
2649
2709
|
IA_ACTION_3 = 10,
|
|
2650
2710
|
IA_ACTION_4 = 11,
|
|
2651
2711
|
IA_ACTION_5 = 12,
|
|
2652
|
-
IA_ACTION_6 = 13
|
|
2712
|
+
IA_ACTION_6 = 13,
|
|
2713
|
+
IA_MODIFIER = 14
|
|
2653
2714
|
}
|
|
2654
2715
|
|
|
2655
2716
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4293,6 +4354,45 @@ export declare namespace PBAnimator {
|
|
|
4293
4354
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4294
4355
|
}
|
|
4295
4356
|
|
|
4357
|
+
/**
|
|
4358
|
+
* @public
|
|
4359
|
+
*/
|
|
4360
|
+
export declare interface PBAudioAnalysis {
|
|
4361
|
+
/** Parameters section */
|
|
4362
|
+
mode: PBAudioAnalysisMode;
|
|
4363
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4364
|
+
amplitudeGain?: number | undefined;
|
|
4365
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4366
|
+
bandsGain?: number | undefined;
|
|
4367
|
+
/** Result section */
|
|
4368
|
+
amplitude: number;
|
|
4369
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4370
|
+
band0: number;
|
|
4371
|
+
band1: number;
|
|
4372
|
+
band2: number;
|
|
4373
|
+
band3: number;
|
|
4374
|
+
band4: number;
|
|
4375
|
+
band5: number;
|
|
4376
|
+
band6: number;
|
|
4377
|
+
band7: number;
|
|
4378
|
+
}
|
|
4379
|
+
|
|
4380
|
+
/**
|
|
4381
|
+
* @public
|
|
4382
|
+
*/
|
|
4383
|
+
export declare namespace PBAudioAnalysis {
|
|
4384
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4385
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4386
|
+
}
|
|
4387
|
+
|
|
4388
|
+
/**
|
|
4389
|
+
* @public
|
|
4390
|
+
*/
|
|
4391
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4392
|
+
MODE_RAW = 0,
|
|
4393
|
+
MODE_LOGARITHMIC = 1
|
|
4394
|
+
}
|
|
4395
|
+
|
|
4296
4396
|
/**
|
|
4297
4397
|
* @public
|
|
4298
4398
|
*/
|
|
@@ -4482,6 +4582,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4482
4582
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4483
4583
|
}
|
|
4484
4584
|
|
|
4585
|
+
/**
|
|
4586
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4587
|
+
* as the avatar movement speed, jump height etc.
|
|
4588
|
+
*/
|
|
4589
|
+
/**
|
|
4590
|
+
* @public
|
|
4591
|
+
*/
|
|
4592
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4593
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4594
|
+
walkSpeed?: number | undefined;
|
|
4595
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4596
|
+
jogSpeed?: number | undefined;
|
|
4597
|
+
/** Maximum speed when running (in meters per second) */
|
|
4598
|
+
runSpeed?: number | undefined;
|
|
4599
|
+
/** Height of a regular jump (in meters) */
|
|
4600
|
+
jumpHeight?: number | undefined;
|
|
4601
|
+
/** Height of a jump while running (in meters) */
|
|
4602
|
+
runJumpHeight?: number | undefined;
|
|
4603
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4604
|
+
hardLandingCooldown?: number | undefined;
|
|
4605
|
+
}
|
|
4606
|
+
|
|
4607
|
+
/**
|
|
4608
|
+
* @public
|
|
4609
|
+
*/
|
|
4610
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4611
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4612
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4613
|
+
}
|
|
4614
|
+
|
|
4485
4615
|
/**
|
|
4486
4616
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4487
4617
|
* avatar behavior changes.
|
|
@@ -6233,6 +6363,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6233
6363
|
* an 'instant' transition (like using speed/time = 0)
|
|
6234
6364
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6235
6365
|
* the holding entity transform).
|
|
6366
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6236
6367
|
*/
|
|
6237
6368
|
/**
|
|
6238
6369
|
* @public
|
|
@@ -6240,6 +6371,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6240
6371
|
export declare interface PBVirtualCamera {
|
|
6241
6372
|
defaultTransition?: CameraTransition | undefined;
|
|
6242
6373
|
lookAtEntity?: number | undefined;
|
|
6374
|
+
/** default: 60 */
|
|
6375
|
+
fov?: number | undefined;
|
|
6243
6376
|
}
|
|
6244
6377
|
|
|
6245
6378
|
/**
|