@dcl/playground-assets 7.20.5-22673942652.commit-fcc5752 → 7.20.5-22674879735.commit-6a30e67
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 +220 -2
- package/dist/beta.d.ts +220 -2
- package/dist/index.bundled.d.ts +220 -2
- 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/snippets/pointer-events.ts +14 -7
- package/dist/playground-assets.d.ts +220 -2
- package/etc/playground-assets.api.json +2277 -62
- package/etc/playground-assets.api.md +129 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
+
|
|
120
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
+
/**
|
|
122
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
+
*
|
|
124
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
+
*/
|
|
128
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
+
/**
|
|
130
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
+
*
|
|
132
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
+
*/
|
|
137
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
+
*
|
|
141
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
+
*
|
|
143
|
+
* @param entity - The entity to attach the component to.
|
|
144
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
+
*/
|
|
148
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
+
/**
|
|
151
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
+
*
|
|
153
|
+
* @param entity - The target entity.
|
|
154
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
+
*/
|
|
158
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
+
*
|
|
165
|
+
* `amplitude` represents the aggregated signal strength.
|
|
166
|
+
* `bands` represents the processed frequency bands.
|
|
167
|
+
*/
|
|
168
|
+
export declare type AudioAnalysisView = {
|
|
169
|
+
amplitude: number;
|
|
170
|
+
bands: number[];
|
|
171
|
+
};
|
|
172
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2034,6 +2094,7 @@ export declare type EventSystemOptions = {
|
|
|
2034
2094
|
showFeedback?: boolean;
|
|
2035
2095
|
showHighlight?: boolean;
|
|
2036
2096
|
maxPlayerDistance?: number;
|
|
2097
|
+
priority?: number;
|
|
2037
2098
|
};
|
|
2038
2099
|
|
|
2039
2100
|
/**
|
|
@@ -2687,7 +2748,8 @@ export declare const enum InputAction {
|
|
|
2687
2748
|
IA_ACTION_3 = 10,
|
|
2688
2749
|
IA_ACTION_4 = 11,
|
|
2689
2750
|
IA_ACTION_5 = 12,
|
|
2690
|
-
IA_ACTION_6 = 13
|
|
2751
|
+
IA_ACTION_6 = 13,
|
|
2752
|
+
IA_MODIFIER = 14
|
|
2691
2753
|
}
|
|
2692
2754
|
|
|
2693
2755
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2735,6 +2797,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2735
2797
|
alreadyRequestedSrc?: Set<string>;
|
|
2736
2798
|
};
|
|
2737
2799
|
|
|
2800
|
+
/**
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
export declare const enum InteractionType {
|
|
2804
|
+
CURSOR = 0,
|
|
2805
|
+
PROXIMITY = 1
|
|
2806
|
+
}
|
|
2807
|
+
|
|
2738
2808
|
/**
|
|
2739
2809
|
* @public
|
|
2740
2810
|
*/
|
|
@@ -4434,6 +4504,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4434
4504
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4435
4505
|
}
|
|
4436
4506
|
|
|
4507
|
+
/**
|
|
4508
|
+
* @public
|
|
4509
|
+
*/
|
|
4510
|
+
export declare interface PBAudioAnalysis {
|
|
4511
|
+
/** Parameters section */
|
|
4512
|
+
mode: PBAudioAnalysisMode;
|
|
4513
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4514
|
+
amplitudeGain?: number | undefined;
|
|
4515
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4516
|
+
bandsGain?: number | undefined;
|
|
4517
|
+
/** Result section */
|
|
4518
|
+
amplitude: number;
|
|
4519
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4520
|
+
band0: number;
|
|
4521
|
+
band1: number;
|
|
4522
|
+
band2: number;
|
|
4523
|
+
band3: number;
|
|
4524
|
+
band4: number;
|
|
4525
|
+
band5: number;
|
|
4526
|
+
band6: number;
|
|
4527
|
+
band7: number;
|
|
4528
|
+
}
|
|
4529
|
+
|
|
4530
|
+
/**
|
|
4531
|
+
* @public
|
|
4532
|
+
*/
|
|
4533
|
+
export declare namespace PBAudioAnalysis {
|
|
4534
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4535
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4536
|
+
}
|
|
4537
|
+
|
|
4538
|
+
/**
|
|
4539
|
+
* @public
|
|
4540
|
+
*/
|
|
4541
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4542
|
+
MODE_RAW = 0,
|
|
4543
|
+
MODE_LOGARITHMIC = 1
|
|
4544
|
+
}
|
|
4545
|
+
|
|
4437
4546
|
/**
|
|
4438
4547
|
* @public
|
|
4439
4548
|
*/
|
|
@@ -4623,6 +4732,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4623
4732
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4624
4733
|
}
|
|
4625
4734
|
|
|
4735
|
+
/**
|
|
4736
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4737
|
+
* as the avatar movement speed, jump height etc.
|
|
4738
|
+
*/
|
|
4739
|
+
/**
|
|
4740
|
+
* @public
|
|
4741
|
+
*/
|
|
4742
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4743
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4744
|
+
walkSpeed?: number | undefined;
|
|
4745
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4746
|
+
jogSpeed?: number | undefined;
|
|
4747
|
+
/** Maximum speed when running (in meters per second) */
|
|
4748
|
+
runSpeed?: number | undefined;
|
|
4749
|
+
/** Height of a regular jump (in meters) */
|
|
4750
|
+
jumpHeight?: number | undefined;
|
|
4751
|
+
/** Height of a jump while running (in meters) */
|
|
4752
|
+
runJumpHeight?: number | undefined;
|
|
4753
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4754
|
+
hardLandingCooldown?: number | undefined;
|
|
4755
|
+
/** Height of the double jump (in meters) */
|
|
4756
|
+
doubleJumpHeight?: number | undefined;
|
|
4757
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4758
|
+
glidingSpeed?: number | undefined;
|
|
4759
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4760
|
+
glidingFallingSpeed?: number | undefined;
|
|
4761
|
+
}
|
|
4762
|
+
|
|
4763
|
+
/**
|
|
4764
|
+
* @public
|
|
4765
|
+
*/
|
|
4766
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4767
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4768
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4769
|
+
}
|
|
4770
|
+
|
|
4626
4771
|
/**
|
|
4627
4772
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4628
4773
|
* avatar behavior changes.
|
|
@@ -5530,6 +5675,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5530
5675
|
eventType: PointerEventType;
|
|
5531
5676
|
/** additional configuration for this detection */
|
|
5532
5677
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5678
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5679
|
+
interactionType?: InteractionType | undefined;
|
|
5533
5680
|
}
|
|
5534
5681
|
|
|
5535
5682
|
/**
|
|
@@ -5556,6 +5703,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5556
5703
|
showHighlight?: boolean | undefined;
|
|
5557
5704
|
/** range of interaction from the avatar's position (default 0) */
|
|
5558
5705
|
maxPlayerDistance?: number | undefined;
|
|
5706
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5707
|
+
priority?: number | undefined;
|
|
5559
5708
|
}
|
|
5560
5709
|
|
|
5561
5710
|
/**
|
|
@@ -6432,6 +6581,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6432
6581
|
* an 'instant' transition (like using speed/time = 0)
|
|
6433
6582
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6434
6583
|
* the holding entity transform).
|
|
6584
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6435
6585
|
*/
|
|
6436
6586
|
/**
|
|
6437
6587
|
* @public
|
|
@@ -6439,6 +6589,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6439
6589
|
export declare interface PBVirtualCamera {
|
|
6440
6590
|
defaultTransition?: CameraTransition | undefined;
|
|
6441
6591
|
lookAtEntity?: number | undefined;
|
|
6592
|
+
/** default: 60 */
|
|
6593
|
+
fov?: number | undefined;
|
|
6442
6594
|
}
|
|
6443
6595
|
|
|
6444
6596
|
/**
|
|
@@ -6634,6 +6786,30 @@ export declare interface PointerEventsSystem {
|
|
|
6634
6786
|
* @param entity - Entity where the callback was attached
|
|
6635
6787
|
*/
|
|
6636
6788
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6789
|
+
/**
|
|
6790
|
+
* @public
|
|
6791
|
+
* Remove the callback for onProximityDown event
|
|
6792
|
+
* @param entity - Entity where the callback was attached
|
|
6793
|
+
*/
|
|
6794
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6795
|
+
/**
|
|
6796
|
+
* @public
|
|
6797
|
+
* Remove the callback for onProximityUp event
|
|
6798
|
+
* @param entity - Entity where the callback was attached
|
|
6799
|
+
*/
|
|
6800
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6801
|
+
/**
|
|
6802
|
+
* @public
|
|
6803
|
+
* Remove the callback for onProximityEnter event
|
|
6804
|
+
* @param entity - Entity where the callback was attached
|
|
6805
|
+
*/
|
|
6806
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6807
|
+
/**
|
|
6808
|
+
* @public
|
|
6809
|
+
* Remove the callback for onProximityLeave event
|
|
6810
|
+
* @param entity - Entity where the callback was attached
|
|
6811
|
+
*/
|
|
6812
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6637
6813
|
/**
|
|
6638
6814
|
* @public
|
|
6639
6815
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6688,6 +6864,46 @@ export declare interface PointerEventsSystem {
|
|
|
6688
6864
|
entity: Entity;
|
|
6689
6865
|
opts?: Partial<EventSystemOptions>;
|
|
6690
6866
|
}, cb: EventSystemCallback): void;
|
|
6867
|
+
/**
|
|
6868
|
+
* @public
|
|
6869
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6870
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6871
|
+
* @param cb - Function to execute when click fires
|
|
6872
|
+
*/
|
|
6873
|
+
onProximityDown(pointerData: {
|
|
6874
|
+
entity: Entity;
|
|
6875
|
+
opts?: Partial<EventSystemOptions>;
|
|
6876
|
+
}, cb: EventSystemCallback): void;
|
|
6877
|
+
/**
|
|
6878
|
+
* @public
|
|
6879
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6880
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6881
|
+
* @param cb - Function to execute when event fires
|
|
6882
|
+
*/
|
|
6883
|
+
onProximityUp(pointerData: {
|
|
6884
|
+
entity: Entity;
|
|
6885
|
+
opts?: Partial<EventSystemOptions>;
|
|
6886
|
+
}, cb: EventSystemCallback): void;
|
|
6887
|
+
/**
|
|
6888
|
+
* @public
|
|
6889
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6890
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6891
|
+
* @param cb - Function to execute when event fires
|
|
6892
|
+
*/
|
|
6893
|
+
onProximityEnter(pointerData: {
|
|
6894
|
+
entity: Entity;
|
|
6895
|
+
opts?: Partial<EventSystemOptions>;
|
|
6896
|
+
}, cb: EventSystemCallback): void;
|
|
6897
|
+
/**
|
|
6898
|
+
* @public
|
|
6899
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6900
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6901
|
+
* @param cb - Function to execute when event fires
|
|
6902
|
+
*/
|
|
6903
|
+
onProximityLeave(pointerData: {
|
|
6904
|
+
entity: Entity;
|
|
6905
|
+
opts?: Partial<EventSystemOptions>;
|
|
6906
|
+
}, cb: EventSystemCallback): void;
|
|
6691
6907
|
}
|
|
6692
6908
|
|
|
6693
6909
|
/**
|
|
@@ -6704,7 +6920,9 @@ export declare const enum PointerEventType {
|
|
|
6704
6920
|
PET_UP = 0,
|
|
6705
6921
|
PET_DOWN = 1,
|
|
6706
6922
|
PET_HOVER_ENTER = 2,
|
|
6707
|
-
PET_HOVER_LEAVE = 3
|
|
6923
|
+
PET_HOVER_LEAVE = 3,
|
|
6924
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6925
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6708
6926
|
}
|
|
6709
6927
|
|
|
6710
6928
|
/**
|
package/dist/beta.d.ts
CHANGED
|
@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
+
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
+
|
|
120
|
+
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
+
/**
|
|
122
|
+
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
+
*
|
|
124
|
+
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
+
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
+
*/
|
|
128
|
+
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
+
/**
|
|
130
|
+
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
+
*
|
|
132
|
+
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
+
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
+
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
+
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
+
*/
|
|
137
|
+
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
+
*
|
|
141
|
+
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
+
*
|
|
143
|
+
* @param entity - The entity to attach the component to.
|
|
144
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
+
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
+
*/
|
|
148
|
+
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
+
/**
|
|
151
|
+
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
+
*
|
|
153
|
+
* @param entity - The target entity.
|
|
154
|
+
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
+
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
+
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
+
*/
|
|
158
|
+
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
+
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
+
*
|
|
165
|
+
* `amplitude` represents the aggregated signal strength.
|
|
166
|
+
* `bands` represents the processed frequency bands.
|
|
167
|
+
*/
|
|
168
|
+
export declare type AudioAnalysisView = {
|
|
169
|
+
amplitude: number;
|
|
170
|
+
bands: number[];
|
|
171
|
+
};
|
|
172
|
+
|
|
118
173
|
/** @public */
|
|
119
174
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
120
175
|
|
|
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
|
|
|
209
264
|
/** @public */
|
|
210
265
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
266
|
|
|
267
|
+
/** @public */
|
|
268
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
269
|
+
|
|
212
270
|
/** @public */
|
|
213
271
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
272
|
|
|
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
|
|
|
1321
1379
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1322
1380
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1323
1381
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1382
|
+
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1324
1383
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1325
1384
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1326
1385
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1387
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1388
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1389
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1390
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1391
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1392
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1393
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -2034,6 +2094,7 @@ export declare type EventSystemOptions = {
|
|
|
2034
2094
|
showFeedback?: boolean;
|
|
2035
2095
|
showHighlight?: boolean;
|
|
2036
2096
|
maxPlayerDistance?: number;
|
|
2097
|
+
priority?: number;
|
|
2037
2098
|
};
|
|
2038
2099
|
|
|
2039
2100
|
/**
|
|
@@ -2678,7 +2739,8 @@ export declare const enum InputAction {
|
|
|
2678
2739
|
IA_ACTION_3 = 10,
|
|
2679
2740
|
IA_ACTION_4 = 11,
|
|
2680
2741
|
IA_ACTION_5 = 12,
|
|
2681
|
-
IA_ACTION_6 = 13
|
|
2742
|
+
IA_ACTION_6 = 13,
|
|
2743
|
+
IA_MODIFIER = 14
|
|
2682
2744
|
}
|
|
2683
2745
|
|
|
2684
2746
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2726,6 +2788,14 @@ export declare type InstanceCompositeOptions = {
|
|
|
2726
2788
|
alreadyRequestedSrc?: Set<string>;
|
|
2727
2789
|
};
|
|
2728
2790
|
|
|
2791
|
+
/**
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
export declare const enum InteractionType {
|
|
2795
|
+
CURSOR = 0,
|
|
2796
|
+
PROXIMITY = 1
|
|
2797
|
+
}
|
|
2798
|
+
|
|
2729
2799
|
/**
|
|
2730
2800
|
* @public
|
|
2731
2801
|
*/
|
|
@@ -4406,6 +4476,45 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4406
4476
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4407
4477
|
}
|
|
4408
4478
|
|
|
4479
|
+
/**
|
|
4480
|
+
* @public
|
|
4481
|
+
*/
|
|
4482
|
+
export declare interface PBAudioAnalysis {
|
|
4483
|
+
/** Parameters section */
|
|
4484
|
+
mode: PBAudioAnalysisMode;
|
|
4485
|
+
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4486
|
+
amplitudeGain?: number | undefined;
|
|
4487
|
+
/** End when mode == MODE_LOGARITHMIC */
|
|
4488
|
+
bandsGain?: number | undefined;
|
|
4489
|
+
/** Result section */
|
|
4490
|
+
amplitude: number;
|
|
4491
|
+
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4492
|
+
band0: number;
|
|
4493
|
+
band1: number;
|
|
4494
|
+
band2: number;
|
|
4495
|
+
band3: number;
|
|
4496
|
+
band4: number;
|
|
4497
|
+
band5: number;
|
|
4498
|
+
band6: number;
|
|
4499
|
+
band7: number;
|
|
4500
|
+
}
|
|
4501
|
+
|
|
4502
|
+
/**
|
|
4503
|
+
* @public
|
|
4504
|
+
*/
|
|
4505
|
+
export declare namespace PBAudioAnalysis {
|
|
4506
|
+
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4507
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4508
|
+
}
|
|
4509
|
+
|
|
4510
|
+
/**
|
|
4511
|
+
* @public
|
|
4512
|
+
*/
|
|
4513
|
+
export declare const enum PBAudioAnalysisMode {
|
|
4514
|
+
MODE_RAW = 0,
|
|
4515
|
+
MODE_LOGARITHMIC = 1
|
|
4516
|
+
}
|
|
4517
|
+
|
|
4409
4518
|
/**
|
|
4410
4519
|
* @public
|
|
4411
4520
|
*/
|
|
@@ -4595,6 +4704,42 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4595
4704
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4596
4705
|
}
|
|
4597
4706
|
|
|
4707
|
+
/**
|
|
4708
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4709
|
+
* as the avatar movement speed, jump height etc.
|
|
4710
|
+
*/
|
|
4711
|
+
/**
|
|
4712
|
+
* @public
|
|
4713
|
+
*/
|
|
4714
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4715
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4716
|
+
walkSpeed?: number | undefined;
|
|
4717
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4718
|
+
jogSpeed?: number | undefined;
|
|
4719
|
+
/** Maximum speed when running (in meters per second) */
|
|
4720
|
+
runSpeed?: number | undefined;
|
|
4721
|
+
/** Height of a regular jump (in meters) */
|
|
4722
|
+
jumpHeight?: number | undefined;
|
|
4723
|
+
/** Height of a jump while running (in meters) */
|
|
4724
|
+
runJumpHeight?: number | undefined;
|
|
4725
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4726
|
+
hardLandingCooldown?: number | undefined;
|
|
4727
|
+
/** Height of the double jump (in meters) */
|
|
4728
|
+
doubleJumpHeight?: number | undefined;
|
|
4729
|
+
/** Maximum speed when gliding (in meters per second) */
|
|
4730
|
+
glidingSpeed?: number | undefined;
|
|
4731
|
+
/** Maximum falling speed when gliding (in meters per second) */
|
|
4732
|
+
glidingFallingSpeed?: number | undefined;
|
|
4733
|
+
}
|
|
4734
|
+
|
|
4735
|
+
/**
|
|
4736
|
+
* @public
|
|
4737
|
+
*/
|
|
4738
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4739
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4740
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4741
|
+
}
|
|
4742
|
+
|
|
4598
4743
|
/**
|
|
4599
4744
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4600
4745
|
* avatar behavior changes.
|
|
@@ -5502,6 +5647,8 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5502
5647
|
eventType: PointerEventType;
|
|
5503
5648
|
/** additional configuration for this detection */
|
|
5504
5649
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
5650
|
+
/** the type of interaction source (default 0 == CURSOR) */
|
|
5651
|
+
interactionType?: InteractionType | undefined;
|
|
5505
5652
|
}
|
|
5506
5653
|
|
|
5507
5654
|
/**
|
|
@@ -5528,6 +5675,8 @@ export declare interface PBPointerEvents_Info {
|
|
|
5528
5675
|
showHighlight?: boolean | undefined;
|
|
5529
5676
|
/** range of interaction from the avatar's position (default 0) */
|
|
5530
5677
|
maxPlayerDistance?: number | undefined;
|
|
5678
|
+
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
5679
|
+
priority?: number | undefined;
|
|
5531
5680
|
}
|
|
5532
5681
|
|
|
5533
5682
|
/**
|
|
@@ -6404,6 +6553,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6404
6553
|
* an 'instant' transition (like using speed/time = 0)
|
|
6405
6554
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6406
6555
|
* the holding entity transform).
|
|
6556
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6407
6557
|
*/
|
|
6408
6558
|
/**
|
|
6409
6559
|
* @public
|
|
@@ -6411,6 +6561,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6411
6561
|
export declare interface PBVirtualCamera {
|
|
6412
6562
|
defaultTransition?: CameraTransition | undefined;
|
|
6413
6563
|
lookAtEntity?: number | undefined;
|
|
6564
|
+
/** default: 60 */
|
|
6565
|
+
fov?: number | undefined;
|
|
6414
6566
|
}
|
|
6415
6567
|
|
|
6416
6568
|
/**
|
|
@@ -6606,6 +6758,30 @@ export declare interface PointerEventsSystem {
|
|
|
6606
6758
|
* @param entity - Entity where the callback was attached
|
|
6607
6759
|
*/
|
|
6608
6760
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6761
|
+
/**
|
|
6762
|
+
* @public
|
|
6763
|
+
* Remove the callback for onProximityDown event
|
|
6764
|
+
* @param entity - Entity where the callback was attached
|
|
6765
|
+
*/
|
|
6766
|
+
removeOnProximityDown(entity: Entity): void;
|
|
6767
|
+
/**
|
|
6768
|
+
* @public
|
|
6769
|
+
* Remove the callback for onProximityUp event
|
|
6770
|
+
* @param entity - Entity where the callback was attached
|
|
6771
|
+
*/
|
|
6772
|
+
removeOnProximityUp(entity: Entity): void;
|
|
6773
|
+
/**
|
|
6774
|
+
* @public
|
|
6775
|
+
* Remove the callback for onProximityEnter event
|
|
6776
|
+
* @param entity - Entity where the callback was attached
|
|
6777
|
+
*/
|
|
6778
|
+
removeOnProximityEnter(entity: Entity): void;
|
|
6779
|
+
/**
|
|
6780
|
+
* @public
|
|
6781
|
+
* Remove the callback for onProximityLeave event
|
|
6782
|
+
* @param entity - Entity where the callback was attached
|
|
6783
|
+
*/
|
|
6784
|
+
removeOnProximityLeave(entity: Entity): void;
|
|
6609
6785
|
/**
|
|
6610
6786
|
* @public
|
|
6611
6787
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -6660,6 +6836,46 @@ export declare interface PointerEventsSystem {
|
|
|
6660
6836
|
entity: Entity;
|
|
6661
6837
|
opts?: Partial<EventSystemOptions>;
|
|
6662
6838
|
}, cb: EventSystemCallback): void;
|
|
6839
|
+
/**
|
|
6840
|
+
* @public
|
|
6841
|
+
* Execute callback when the user presses the proximity button on the entity
|
|
6842
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6843
|
+
* @param cb - Function to execute when click fires
|
|
6844
|
+
*/
|
|
6845
|
+
onProximityDown(pointerData: {
|
|
6846
|
+
entity: Entity;
|
|
6847
|
+
opts?: Partial<EventSystemOptions>;
|
|
6848
|
+
}, cb: EventSystemCallback): void;
|
|
6849
|
+
/**
|
|
6850
|
+
* @public
|
|
6851
|
+
* Execute callback when the user releases the proximity button on the entity
|
|
6852
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6853
|
+
* @param cb - Function to execute when event fires
|
|
6854
|
+
*/
|
|
6855
|
+
onProximityUp(pointerData: {
|
|
6856
|
+
entity: Entity;
|
|
6857
|
+
opts?: Partial<EventSystemOptions>;
|
|
6858
|
+
}, cb: EventSystemCallback): void;
|
|
6859
|
+
/**
|
|
6860
|
+
* @public
|
|
6861
|
+
* Execute callback when the entity enters the proximity zone of the user
|
|
6862
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6863
|
+
* @param cb - Function to execute when event fires
|
|
6864
|
+
*/
|
|
6865
|
+
onProximityEnter(pointerData: {
|
|
6866
|
+
entity: Entity;
|
|
6867
|
+
opts?: Partial<EventSystemOptions>;
|
|
6868
|
+
}, cb: EventSystemCallback): void;
|
|
6869
|
+
/**
|
|
6870
|
+
* @public
|
|
6871
|
+
* Execute callback when the entity leaves the proximity zone of the user
|
|
6872
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6873
|
+
* @param cb - Function to execute when event fires
|
|
6874
|
+
*/
|
|
6875
|
+
onProximityLeave(pointerData: {
|
|
6876
|
+
entity: Entity;
|
|
6877
|
+
opts?: Partial<EventSystemOptions>;
|
|
6878
|
+
}, cb: EventSystemCallback): void;
|
|
6663
6879
|
}
|
|
6664
6880
|
|
|
6665
6881
|
/**
|
|
@@ -6676,7 +6892,9 @@ export declare const enum PointerEventType {
|
|
|
6676
6892
|
PET_UP = 0,
|
|
6677
6893
|
PET_DOWN = 1,
|
|
6678
6894
|
PET_HOVER_ENTER = 2,
|
|
6679
|
-
PET_HOVER_LEAVE = 3
|
|
6895
|
+
PET_HOVER_LEAVE = 3,
|
|
6896
|
+
PET_PROXIMITY_ENTER = 4,
|
|
6897
|
+
PET_PROXIMITY_LEAVE = 5
|
|
6680
6898
|
}
|
|
6681
6899
|
|
|
6682
6900
|
/**
|