@dcl/playground-assets 7.15.2-20078495746.commit-68db59f → 7.15.3-20090667358.commit-8e697e3
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 +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 +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>>;
|
|
@@ -2492,7 +2552,8 @@ export declare const enum InputAction {
|
|
|
2492
2552
|
IA_ACTION_3 = 10,
|
|
2493
2553
|
IA_ACTION_4 = 11,
|
|
2494
2554
|
IA_ACTION_5 = 12,
|
|
2495
|
-
IA_ACTION_6 = 13
|
|
2555
|
+
IA_ACTION_6 = 13,
|
|
2556
|
+
IA_MODIFIER = 14
|
|
2496
2557
|
}
|
|
2497
2558
|
|
|
2498
2559
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4119,6 +4180,45 @@ export declare namespace PBAnimator {
|
|
|
4119
4180
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4120
4181
|
}
|
|
4121
4182
|
|
|
4183
|
+
/**
|
|
4184
|
+
* @public
|
|
4185
|
+
*/
|
|
4186
|
+
export declare interface PBAudioAnalysis {
|
|
4187
|
+
/** Parameters section */
|
|
4188
|
+
mode: PBAudioAnalysisMode;
|
|
4189
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4190
|
+
amplitudeGain?: number | undefined;
|
|
4191
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4192
|
+
bandsGain?: number | undefined;
|
|
4193
|
+
/** Result section */
|
|
4194
|
+
amplitude: number;
|
|
4195
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4196
|
+
band0: number;
|
|
4197
|
+
band1: number;
|
|
4198
|
+
band2: number;
|
|
4199
|
+
band3: number;
|
|
4200
|
+
band4: number;
|
|
4201
|
+
band5: number;
|
|
4202
|
+
band6: number;
|
|
4203
|
+
band7: number;
|
|
4204
|
+
}
|
|
4205
|
+
|
|
4206
|
+
/**
|
|
4207
|
+
* @public
|
|
4208
|
+
*/
|
|
4209
|
+
export declare namespace PBAudioAnalysis {
|
|
4210
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4211
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4212
|
+
}
|
|
4213
|
+
|
|
4214
|
+
/**
|
|
4215
|
+
* @public
|
|
4216
|
+
*/
|
|
4217
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4218
|
+
MODE_RAW = 0,
|
|
4219
|
+
MODE_LOGARITHMIC = 1
|
|
4220
|
+
}
|
|
4221
|
+
|
|
4122
4222
|
/**
|
|
4123
4223
|
* @public
|
|
4124
4224
|
*/
|
|
@@ -4308,6 +4408,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4308
4408
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4309
4409
|
}
|
|
4310
4410
|
|
|
4411
|
+
/**
|
|
4412
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4413
|
+
* as the avatar movement speed, jump height etc.
|
|
4414
|
+
*/
|
|
4415
|
+
/**
|
|
4416
|
+
* @public
|
|
4417
|
+
*/
|
|
4418
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4419
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4420
|
+
walkSpeed?: number | undefined;
|
|
4421
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4422
|
+
jogSpeed?: number | undefined;
|
|
4423
|
+
/** Maximum speed when running (in meters per second) */
|
|
4424
|
+
runSpeed?: number | undefined;
|
|
4425
|
+
/** Height of a regular jump (in meters) */
|
|
4426
|
+
jumpHeight?: number | undefined;
|
|
4427
|
+
/** Height of a jump while running (in meters) */
|
|
4428
|
+
runJumpHeight?: number | undefined;
|
|
4429
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4430
|
+
hardLandingCooldown?: number | undefined;
|
|
4431
|
+
}
|
|
4432
|
+
|
|
4433
|
+
/**
|
|
4434
|
+
* @public
|
|
4435
|
+
*/
|
|
4436
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4437
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4438
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4439
|
+
}
|
|
4440
|
+
|
|
4311
4441
|
/**
|
|
4312
4442
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4313
4443
|
* avatar behavior changes.
|
|
@@ -6034,6 +6164,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6034
6164
|
* an 'instant' transition (like using speed/time = 0)
|
|
6035
6165
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6036
6166
|
* the holding entity transform).
|
|
6167
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6037
6168
|
*/
|
|
6038
6169
|
/**
|
|
6039
6170
|
* @public
|
|
@@ -6041,6 +6172,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6041
6172
|
export declare interface PBVirtualCamera {
|
|
6042
6173
|
defaultTransition?: CameraTransition | undefined;
|
|
6043
6174
|
lookAtEntity?: number | undefined;
|
|
6175
|
+
/** default: 60 */
|
|
6176
|
+
fov?: number | undefined;
|
|
6044
6177
|
}
|
|
6045
6178
|
|
|
6046
6179
|
/**
|
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>>;
|
|
@@ -2483,7 +2543,8 @@ export declare const enum InputAction {
|
|
|
2483
2543
|
IA_ACTION_3 = 10,
|
|
2484
2544
|
IA_ACTION_4 = 11,
|
|
2485
2545
|
IA_ACTION_5 = 12,
|
|
2486
|
-
IA_ACTION_6 = 13
|
|
2546
|
+
IA_ACTION_6 = 13,
|
|
2547
|
+
IA_MODIFIER = 14
|
|
2487
2548
|
}
|
|
2488
2549
|
|
|
2489
2550
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4091,6 +4152,45 @@ export declare namespace PBAnimator {
|
|
|
4091
4152
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4092
4153
|
}
|
|
4093
4154
|
|
|
4155
|
+
/**
|
|
4156
|
+
* @public
|
|
4157
|
+
*/
|
|
4158
|
+
export declare interface PBAudioAnalysis {
|
|
4159
|
+
/** Parameters section */
|
|
4160
|
+
mode: PBAudioAnalysisMode;
|
|
4161
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4162
|
+
amplitudeGain?: number | undefined;
|
|
4163
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4164
|
+
bandsGain?: number | undefined;
|
|
4165
|
+
/** Result section */
|
|
4166
|
+
amplitude: number;
|
|
4167
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4168
|
+
band0: number;
|
|
4169
|
+
band1: number;
|
|
4170
|
+
band2: number;
|
|
4171
|
+
band3: number;
|
|
4172
|
+
band4: number;
|
|
4173
|
+
band5: number;
|
|
4174
|
+
band6: number;
|
|
4175
|
+
band7: number;
|
|
4176
|
+
}
|
|
4177
|
+
|
|
4178
|
+
/**
|
|
4179
|
+
* @public
|
|
4180
|
+
*/
|
|
4181
|
+
export declare namespace PBAudioAnalysis {
|
|
4182
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4183
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4184
|
+
}
|
|
4185
|
+
|
|
4186
|
+
/**
|
|
4187
|
+
* @public
|
|
4188
|
+
*/
|
|
4189
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4190
|
+
MODE_RAW = 0,
|
|
4191
|
+
MODE_LOGARITHMIC = 1
|
|
4192
|
+
}
|
|
4193
|
+
|
|
4094
4194
|
/**
|
|
4095
4195
|
* @public
|
|
4096
4196
|
*/
|
|
@@ -4280,6 +4380,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4280
4380
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4281
4381
|
}
|
|
4282
4382
|
|
|
4383
|
+
/**
|
|
4384
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4385
|
+
* as the avatar movement speed, jump height etc.
|
|
4386
|
+
*/
|
|
4387
|
+
/**
|
|
4388
|
+
* @public
|
|
4389
|
+
*/
|
|
4390
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4391
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4392
|
+
walkSpeed?: number | undefined;
|
|
4393
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4394
|
+
jogSpeed?: number | undefined;
|
|
4395
|
+
/** Maximum speed when running (in meters per second) */
|
|
4396
|
+
runSpeed?: number | undefined;
|
|
4397
|
+
/** Height of a regular jump (in meters) */
|
|
4398
|
+
jumpHeight?: number | undefined;
|
|
4399
|
+
/** Height of a jump while running (in meters) */
|
|
4400
|
+
runJumpHeight?: number | undefined;
|
|
4401
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4402
|
+
hardLandingCooldown?: number | undefined;
|
|
4403
|
+
}
|
|
4404
|
+
|
|
4405
|
+
/**
|
|
4406
|
+
* @public
|
|
4407
|
+
*/
|
|
4408
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4409
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4410
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4411
|
+
}
|
|
4412
|
+
|
|
4283
4413
|
/**
|
|
4284
4414
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4285
4415
|
* avatar behavior changes.
|
|
@@ -6006,6 +6136,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6006
6136
|
* an 'instant' transition (like using speed/time = 0)
|
|
6007
6137
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6008
6138
|
* the holding entity transform).
|
|
6139
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6009
6140
|
*/
|
|
6010
6141
|
/**
|
|
6011
6142
|
* @public
|
|
@@ -6013,6 +6144,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6013
6144
|
export declare interface PBVirtualCamera {
|
|
6014
6145
|
defaultTransition?: CameraTransition | undefined;
|
|
6015
6146
|
lookAtEntity?: number | undefined;
|
|
6147
|
+
/** default: 60 */
|
|
6148
|
+
fov?: number | undefined;
|
|
6016
6149
|
}
|
|
6017
6150
|
|
|
6018
6151
|
/**
|
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>>;
|
|
@@ -2483,7 +2543,8 @@ export declare const enum InputAction {
|
|
|
2483
2543
|
IA_ACTION_3 = 10,
|
|
2484
2544
|
IA_ACTION_4 = 11,
|
|
2485
2545
|
IA_ACTION_5 = 12,
|
|
2486
|
-
IA_ACTION_6 = 13
|
|
2546
|
+
IA_ACTION_6 = 13,
|
|
2547
|
+
IA_MODIFIER = 14
|
|
2487
2548
|
}
|
|
2488
2549
|
|
|
2489
2550
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -4091,6 +4152,45 @@ export declare namespace PBAnimator {
|
|
|
4091
4152
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
|
|
4092
4153
|
}
|
|
4093
4154
|
|
|
4155
|
+
/**
|
|
4156
|
+
* @public
|
|
4157
|
+
*/
|
|
4158
|
+
export declare interface PBAudioAnalysis {
|
|
4159
|
+
/** Parameters section */
|
|
4160
|
+
mode: PBAudioAnalysisMode;
|
|
4161
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4162
|
+
amplitudeGain?: number | undefined;
|
|
4163
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4164
|
+
bandsGain?: number | undefined;
|
|
4165
|
+
/** Result section */
|
|
4166
|
+
amplitude: number;
|
|
4167
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4168
|
+
band0: number;
|
|
4169
|
+
band1: number;
|
|
4170
|
+
band2: number;
|
|
4171
|
+
band3: number;
|
|
4172
|
+
band4: number;
|
|
4173
|
+
band5: number;
|
|
4174
|
+
band6: number;
|
|
4175
|
+
band7: number;
|
|
4176
|
+
}
|
|
4177
|
+
|
|
4178
|
+
/**
|
|
4179
|
+
* @public
|
|
4180
|
+
*/
|
|
4181
|
+
export declare namespace PBAudioAnalysis {
|
|
4182
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4183
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4184
|
+
}
|
|
4185
|
+
|
|
4186
|
+
/**
|
|
4187
|
+
* @public
|
|
4188
|
+
*/
|
|
4189
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4190
|
+
MODE_RAW = 0,
|
|
4191
|
+
MODE_LOGARITHMIC = 1
|
|
4192
|
+
}
|
|
4193
|
+
|
|
4094
4194
|
/**
|
|
4095
4195
|
* @public
|
|
4096
4196
|
*/
|
|
@@ -4280,6 +4380,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4280
4380
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4281
4381
|
}
|
|
4282
4382
|
|
|
4383
|
+
/**
|
|
4384
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4385
|
+
* as the avatar movement speed, jump height etc.
|
|
4386
|
+
*/
|
|
4387
|
+
/**
|
|
4388
|
+
* @public
|
|
4389
|
+
*/
|
|
4390
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4391
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4392
|
+
walkSpeed?: number | undefined;
|
|
4393
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4394
|
+
jogSpeed?: number | undefined;
|
|
4395
|
+
/** Maximum speed when running (in meters per second) */
|
|
4396
|
+
runSpeed?: number | undefined;
|
|
4397
|
+
/** Height of a regular jump (in meters) */
|
|
4398
|
+
jumpHeight?: number | undefined;
|
|
4399
|
+
/** Height of a jump while running (in meters) */
|
|
4400
|
+
runJumpHeight?: number | undefined;
|
|
4401
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4402
|
+
hardLandingCooldown?: number | undefined;
|
|
4403
|
+
}
|
|
4404
|
+
|
|
4405
|
+
/**
|
|
4406
|
+
* @public
|
|
4407
|
+
*/
|
|
4408
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4409
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4410
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4411
|
+
}
|
|
4412
|
+
|
|
4283
4413
|
/**
|
|
4284
4414
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4285
4415
|
* avatar behavior changes.
|
|
@@ -6006,6 +6136,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6006
6136
|
* an 'instant' transition (like using speed/time = 0)
|
|
6007
6137
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6008
6138
|
* the holding entity transform).
|
|
6139
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6009
6140
|
*/
|
|
6010
6141
|
/**
|
|
6011
6142
|
* @public
|
|
@@ -6013,6 +6144,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6013
6144
|
export declare interface PBVirtualCamera {
|
|
6014
6145
|
defaultTransition?: CameraTransition | undefined;
|
|
6015
6146
|
lookAtEntity?: number | undefined;
|
|
6147
|
+
/** default: 60 */
|
|
6148
|
+
fov?: number | undefined;
|
|
6016
6149
|
}
|
|
6017
6150
|
|
|
6018
6151
|
/**
|